logger
in package
Définition de la classe 'logger'.
Table of Contents
- $display_log : bool
- Marqueur pour indiquer si l'affichage à l'écran est souhaité ou non.
- $storage : array<string|int, mixed>
- Pile des messages de log.
- $types_to_show : array<string|int, mixed>
- Liste des niveaux de log.
- $_instance : resource
- Instance statique de la classe logger.
- __clone() : void
- Interdit de cloner l'objet logger.
- cleanLog() : void
- Vide le contenu de l'attribut storage
- displayLog() : void
- Affichage des logs à l'écran.
- instance() : resource
- Accesseur pour la propriété '_instance'.
- log() : void
- Ajoute un message de log dans la pile.
- log_to_file() : void
- Écrit le message dans le fichier de log passé en paramètre.
- writeErrorLogToFile() : void
- Cette méthode permet d'écrire tous les messages de log de type DEBUG_MODE dans le fichier ../var/log/error.log peu importe le niveau de log configuré dans le fichier ../dyn/debug.inc.php.
- writeLogToFile() : mixed
- Cette méthode est dépréciée et ne doit plus être utilisée.
- __construct() : mixed
- Constructeur.
- create_targetfolder() : void
- Crée le répertoire cible des fichiers de log.
- get_logfile_path() : string
- Retourne le path vers le fichier de log.
- get_targetfolder_path() : string
- Retourne le path vers le répertoire cible des fichiers de log.
- is_logfile_writable() : bool
- Indique si le fichier de log est accessible en écriture.
- is_targetfolder_exists() : bool
- Indique si le répertoire cible des fichiers de log existe.
Properties
$display_log
Marqueur pour indiquer si l'affichage à l'écran est souhaité ou non.
public
bool
$display_log
= \true
$storage
Pile des messages de log.
public
array<string|int, mixed>
$storage
= array()
$types_to_show
Liste des niveaux de log.
public
array<string|int, mixed>
$types_to_show
= array(\DEBUG_MODE => "DEBUG", \VERBOSE_MODE => "VERBOSE", \EXTRA_VERBOSE_MODE => "EXTRA_VERBOSE")
$_instance
Instance statique de la classe logger.
private
static resource
$_instance
Methods
__clone()
Interdit de cloner l'objet logger.
public
__clone() : void
Return values
void —cleanLog()
Vide le contenu de l'attribut storage
public
cleanLog() : void
Return values
void —displayLog()
Affichage des logs à l'écran.
public
displayLog() : void
Return values
void —instance()
Accesseur pour la propriété '_instance'.
public
static instance() : resource
Return values
resource —log()
Ajoute un message de log dans la pile.
public
log([string $message = "" ][, int $type = DEBUG_MODE ]) : void
Parameters
- $message : string = ""
-
Message à logger.
- $type : int = DEBUG_MODE
-
Niveau de log.
Return values
void —log_to_file()
Écrit le message dans le fichier de log passé en paramètre.
public
log_to_file(string $logfile[, string $message = "" ]) : void
Parameters
- $logfile : string
-
Nom du fichier de log dans lequel on veut écrire.
- $message : string = ""
-
Chaine de caractères à logger.
Return values
void —writeErrorLogToFile()
Cette méthode permet d'écrire tous les messages de log de type DEBUG_MODE dans le fichier ../var/log/error.log peu importe le niveau de log configuré dans le fichier ../dyn/debug.inc.php.
public
writeErrorLogToFile() : void
Attention si le fichier ../var/log/error.log ne peut pas être écrit aucune erreur n'est levée.
Return values
void —writeLogToFile()
Cette méthode est dépréciée et ne doit plus être utilisée.
public
writeLogToFile() : mixed
Tags
Return values
mixed —__construct()
Constructeur.
private
__construct() : mixed
Return values
mixed —create_targetfolder()
Crée le répertoire cible des fichiers de log.
private
create_targetfolder() : void
Return values
void —get_logfile_path()
Retourne le path vers le fichier de log.
private
get_logfile_path(string $logfile) : string
Parameters
- $logfile : string
-
Nom du fichier de log dans lequel on veut écrire.
Return values
string —get_targetfolder_path()
Retourne le path vers le répertoire cible des fichiers de log.
private
get_targetfolder_path() : string
Return values
string —is_logfile_writable()
Indique si le fichier de log est accessible en écriture.
private
is_logfile_writable(string $logfile) : bool
On vérifie :
- le répertoire dans lequel le fichier doit être écrit existe
- si le fichier n'existe pas qu'il peut être créé
- si le fichier existe qu'il peut être écrit
Parameters
- $logfile : string
-
Nom du fichier de log dans lequel on veut écrire.
Return values
bool —is_targetfolder_exists()
Indique si le répertoire cible des fichiers de log existe.
private
is_targetfolder_exists() : bool