m_err Class Reference

Classe de gestion des erreurs apparaissant lors d'appels API. More...

Public Member Functions
	raise ($clsid, $error, $param="")
	Leve une erreur, signale celle-ci dans les logs et stocke le code erreur. More...
	errstr ()
	Retourne la chaine d'erreur correspondant à la dernière erreur rencontrée. More...
	logerr ()
	Envoi un log d'erreur dans /var/log/alternc/bureau.log. More...
	log ($clsid, $function, $param="")
	Envoi un log d'appel d'API dans /var/log/alternc/bureau.log. More...
	deprecated ()
	This method is present in order to allow slow deprecation. More...

Public Attributes
	$clsid =0
	Numero de classe d'erreur actuelle. More...
	$error =0
	Dernière erreur enregistrée par la classe. More...
	$param =""
	Paramètre chaine eventuellement associé à la dernière erreur. More...
	$logfile ="/var/log/alternc/bureau.log"
	Emplacement du fichier de logs d'AlternC. More...

Detailed Description

Classe de gestion des erreurs apparaissant lors d'appels API.

---

DEPRECATION WARNING: DON'T USE THIS CLASS, USE M_MESSAGES INSTEAD

Cette classe gère les erreurs qui peuvent apparaitre lors d'appels à l'API d'AlternC. Ces erreurs sont stockées sous la forme de 2 nombres (Classe ID et Numéro d'erreur) ainsi qu'un texte facultatif associé. Des textes d'erreurs localisés sont aussi disponibles.

Cette classe se charge aussi d'insérer les appels à l'API d'AlternC dans les logs du système dans /var/log/alternc/bureau.log

Copyleft AlternC Team

Copyright

AlternC-Team 2002-11-01 http://alternc.net/

Definition at line 38 of file m_err.php.

Member Function Documentation

deprecated()

m_err::deprecated

(

)

This method is present in order to allow slow deprecation.

Definition at line 149 of file m_err.php.

                         {
        global $msg;
        $trace = debug_backtrace();
        if (isset($trace[2])) {
            $caller = $trace[2];
        } else {
            $caller = "UNKNOWN CALLER";
        }
        $msg->raise("info", "err", "Deprecation warning: The old messaging class is still used by ".json_encode($caller));
    }

References $msg.

Referenced by log(), and raise().

errstr()

m_err::errstr

(

)

Retourne la chaine d'erreur correspondant à la dernière erreur rencontrée.

Si la dernière erreur rencontrée est connue, retourne l'erreur en toute lettre dans la langue actuellement sélectionnée, ou en anglais par défaut. Si l'erreur n'est pas connue, retourne son numéro de classe et d'ereur.

Returns

string Chaine d'erreur.

Definition at line 97 of file m_err.php.

                      {
        if (is_string($this->error)) {
            // new way of handling errors: message directly in the class
            $str = $this->error."\n";
        } else {
            // old way: message in the locales files (ugly)
            $str = _("err_".$this->clsid."_".$this->error)."\n";
        }
        $args = $this->param;
        if (is_array($args)) {
            array_unshift($args, $str);
            $msg = call_user_func_array("sprintf", $args);
            return $msg;
        } else {
            return $args;
        }
    }

References $msg, and $param.

log()

m_err::log	(		$clsid,
			$function,
			$param = ""
	)

Envoi un log d'appel d'API dans /var/log/alternc/bureau.log.

Cette fonction loggue dans /var/log l'appel à la fonction de l'API d'AlternC.

Parameters

integer	$clsid	Numéro de la classe dont on a appelé une fonction
string	$function	Nom de la fonction appelée
string	$param	Paramètre (facultatif) passés à la fonction de l'API.

Returns

boolean TRUE si le log a été ajouté, FALSE sinon

Definition at line 140 of file m_err.php.

                                             {
        global $mem,$cuid;
        // This is the old method, deprecation warning 
        $this->deprecated();
        return @file_put_contents($this->logfile,date("d/m/Y H:i:s")." - " .get_remote_ip(). " - CALL - ".$mem->user["login"]." - $clsid - $function - $param\n", FILE_APPEND );
    }

References $cuid, $mem, deprecated(), and get_remote_ip().

logerr()

m_err::logerr

(

)

Envoi un log d'erreur dans /var/log/alternc/bureau.log.

Cette fonction Loggue la dernière erreur dans /var/log sur la machine, permettant ainsi aux admins de savoir ce qu'il se passe... Elle est appelée automatiquement par error @access private

Definition at line 123 of file m_err.php.

                      {
        global $mem;
        @file_put_contents($this->logfile, date("d/m/Y H:i:s")." - ERROR - ".$mem->user["login"]." - ".$this->errstr(), FILE_APPEND );
    }

References $mem.

Referenced by raise().

raise()

m_err::raise	(		$clsid,
			$error,
			$param = ""
	)

Leve une erreur, signale celle-ci dans les logs et stocke le code erreur.

Cette fonction lance une erreur, l'ajoute dans les logs d'AlternC, et la met à disposition pour le bureau virtuel pour affichage ultérieur.

Todo:

ne plus utiliser $error de façon numérique, nulle part

Parameters

integer	$clsid	Classe qui lève l'erreur
mixed	$error	Numéro de l'erreur ou chaîne décrivant l'erreur
string	$param	Paramètre chaine associé à l'erreur (facultatif)

Returns

boolean TRUE si l'erreur est connue, FALSE sinon.

Definition at line 66 of file m_err.php.

                                            {
    
        // This is the old method, deprecation warning 
        $this->deprecated();
        /* Leve une exception. Si elle existe, sinon, stocke un message d'erreur sur erreur ...*/
        if (_("err_".$clsid."_".$error)!="err_".$clsid."_".$error || is_string($error)) {
            $this->clsid=$clsid;
            $this->error=$error;
            $args = func_get_args();
            $this->param=array_slice($args, 2);
            $this->logerr();
            return true;
        } else {
            $this->clsid="err";
            $this->error=1;
            $this->param="Error # $error in Class $clsid, Value is $param. (sorry, no text for this error in your language at the moment)";
            $this->logerr();
            return false;
        }
    }

References $clsid, $error, deprecated(), and logerr().

Member Data Documentation

$clsid

m_err::$clsid =0

Numero de classe d'erreur actuelle.

Definition at line 41 of file m_err.php.

Referenced by raise().

$error

m_err::$error =0

Dernière erreur enregistrée par la classe.

Definition at line 44 of file m_err.php.

Referenced by raise().

$logfile

m_err::$logfile ="/var/log/alternc/bureau.log"

Emplacement du fichier de logs d'AlternC.

Definition at line 50 of file m_err.php.

$param

m_err::$param =""

Paramètre chaine eventuellement associé à la dernière erreur.

Definition at line 47 of file m_err.php.

Referenced by errstr().

---

The documentation for this class was generated from the following file:

• bureau/class/m_err.php