Présentation
Cette classe permet de stocker un ensemble d'erreurs sous la forme d'un objet simple.
Elle est utilisée en interne par les DAO et plus particulièrement la méthode check.
Vous pouvez, si vous le souhaitez, vous en servir pour vos propres besoins.
Référence
Constructeur
Le constructeur peut prendre en paramètre un objet ou un tableau associatif.
Si tel est le cas, la méthode addErrors sera appelée avec ce paramètre pour pré-initialiser l'objet avec un contenu.
addError
La méthode addError permet de rajouter une erreur à la liste existante. Cette méthode accepte deux paramètres : le code de l'erreur ainsi que son libellé.
Si la méthode est appelée plusieurs fois avec le même code erreur, alors les appels successifs avec le même code erreurs écrasent le libellé précédent.
$errors = new CopixErrorObject ();
$errors->addError ('code vert', 'moins grave que le code rouge, mais quand même');
addErrors
La méthode addErrors permet d'ajouter un ensemble d'erreurs à l'objet courant. Cette méthode accepte en paramètre un tableau associatif ou un objet (pouvant être de type CopixErrorObject).
$errors1 = new CopixErrorObject ();
$errors1->addError ('code vert', 'moins grave que le code rouge, mais quand même');
$errors2 = new CopixErrorObject ();
$errors2->addErrors (array ('code rouge'=>'danger très très grave, attention'));
$errors2->addErrors ($errors1);
getError
La méthode getError permet de récupérer le libellé d'une erreur donnée. Si le code erreur n'existe pas, la méthode retourne null.
$errors = new CopixErrorObject ();
$errors->addError ('code vert', 'moins grave que le code rouge, mais quand même');
echo $errors->getError ('code vert');
errorExists
La méthode errorExists indique s'il existe une erreur de code donné.
$errors = new CopixErrorObject ();
$errors->addError ('code vert', 'moins grave que le code rouge, mais quand même');
$errors->errorExists ('code vert');//true
$errors->errorExists ('code rouge');//false
isError
La méthode isError indique si une erreur est contenue dans l'objet.
$errors = new CopixErrorObject ();
$errors->isError ();//false
$errors->addError ('code vert', 'moins grave que le code rouge, mais quand même');
$errors->isError ();//true
countErrors
Cette méthode indique le nombre d'erreur actuellement contenues dans l'objet.
$errors = new CopixErrorObject ();
$errors->countErrors ();//0
$errors->addError ('code vert', 'moins grave que le code rouge, mais quand même');
$errors->countErrors ();//1
asObject
Cette méthode retourne les erreurs sous la forme d'une représentation objet (StdClass) ou le nom de la propriété est le code erreur et la propriété le libellé.
Note Si les codes erreurs ne sont pas des noms de propriété valide, il n'est pas recommandé d'utiliser cette méthode.
Note Si le code erreur commence par un chiffre, alors la propriété commencera par un underscore. Ainsi, le code "012" sera dans la propriété "_012".
asArray
Cette méthode retourne le tableau d'erreur actuellement représenté par l'objet. Ce tableau est un tableau associatif ou les clefs sont les codes erreurs et les valeurs les libellés d'erreur.
asString
Cette méthode retourne les libellés des erreurs uniquement, séparés par une chaine "colle" (par défaut <br />).