Présentation

La classe CopixException est la classe des exceptions générées par Copix, sauf pour certaines fonctionnalités qui disposent de leur propre exception. Les modules (qu'ils soient fournis avec Copix ou non) ne devraient pas utiliser cette classe d'exception, mais devraient avoir une exception propre.

/!\ Toutes les exceptions doivent étendre de CopixException, qui étend elle-même de Exception. /!\

Voir aussi

  • Exception : CopixException étend de la classe Exception de PHP.

Les méthodes

__construct ($pMsg, $pCode = 0, $pExtras = array ())

Paramètres

  • string $pMsg Message de l'erreur
  • int $pCode Code d'erreur. Si précisé, doit être une constante de la classe de l'exception.
  • array $pExtras (Copix >= 3.0.5) Informations supplémentaires sur l'erreur. Clef : nom de l'information, valeur : valeur de l'information. Ces informations seront ajoutés dans le log de type "errors" qui est appelé avant l'affichage de l'exception.

Exemple

<?php
throw new CopixException ('Mon message d\'erreur', CopixException::MA_CONSTANTE_ERREUR, array ('info' => 'valeur'));
?>

getExtras ()

Disponibilité : Copix >= 3.0.5
Retourne toutes les informations supplémentaires que l'on a ajouté via le paramètre $pExtras du constructeur.

Retour

  • array Clef : nom de l'information, valeur = valeur de l'information.

getExtra ($pName)

Disponibilité : Copix >= 3.0.5
Retourne la valeur de l'information supplémentaire $pExtra.

Paramètres

  • string $pName Nom de l'information dont on veut la valeur

Retour

  • null Si l'information demandée n'existe pas
  • mixed Valeur de l'information si elle existe