IBDTraceur

Cette classe fournit un ensemble de fonctions permettant de simplifier la mise en place de traces dans votre code.

Chaque trace est associée à un niveau qui définira si la trace sera affichée ou non, en fonction des paramètres du traceur. Elles peuvent être affichées directement dans la page HTML ou sous forme de commentaires.

La traceur permet également de comptabiliser les appels de fonctions, de gérer le découpage de votre application en plusieurs modules et de gérer l’arrêt automatique de l’exécution lorsqu’un certain nombre d’erreurs a été atteint dans un module. Les informations stockées par le traceur sont accessibles partout dans votre application via une variable globale.

Licence : GNU GPL version 2

Documentation

Installation

  • décompressez l’archive,
  • copiez le contenu sur votre serveur web à l’emplacement de votre choix.

Configuration

Rien à configurer 🙂

Mise en place

  • Incluez le fichier traceur.cls.php dans votre code,
  • Crééz une instance de la classe IBDTraceur,
  • Utilisez les méthodes de la classe pour tracer l’exécution de votre application.

Liste des méthodes

      • IBDTraceur (constructeur) : crée une instance du traceur.
        Paramètres :

        • $module : le nom du module
        • $niveauEcho : le niveau minimal d’affichage des messages (0 par défaut)
        • $niveauEchoCommentaire : le niveau minimal d’affichage des messages en commentaires (1 par défaut)
        • $limiteErreurs : le nombre maximal d’erreurs avant arrêt de l’exécution (5 par défaut)
        • $limiteAlertes : le nombre maximal d’alertes avant arrêt de l’exécution (50 par défaut)
      • tracerErreur : affiche un message d’erreur (niveau 0).
        Paramètres :

        • $message : le message à afficher
        • $fonction : nom de la fonction ayant provoqué l’erreur (optionnel)
      • tracerAlerte : affiche un message d’alerte (niveau 1).
        Paramètres :

        • $message : le message à afficher
        • $fonction : nom de la fonction ayant provoqué l’erreur (optionnel)
      • tracer : affiche un message.
        Paramètres :

        • $niveau : le niveau du message
        • $message : le message à afficher
        • $fonction : nom de la fonction ayant provoqué l’erreur (optionnel)
        • $type : type de message, affiché avant le nom de la fonction (optionnel)
      • incrementerAppels : incrémente le compteur d’appels d’une fonction.
        Paramètres :

        • $fonction : le nom de la fonction
      • recupererAppels : récupère la valeur du compteur d’appels d’une fonction.
        Paramètres :

        • $fonction : le nom de la fonction
      • recupererNombreErreurs : récupère la valeur du compteur d’erreurs.
        Paramètres :

        • $global : si à 1, récupère le compteur global, sinon celui du module (0 par défaut)
      • recupererNombreAlertes : récupère la valeur du compteur d’alertes.
        Paramètres :

        • $global : si à 1, récupère le compteur global, sinon celui du module (0 par défaut)
      • recupererInformations : récupère l’ensemble des informations stockées par le traceur sous forme « plate » (mise à plat du contenu de $_IBDTraceur).
        Paramètres :

        • $global : si à 1, récupère les informations globales, sinon celles du module (0 par défaut)
        • $html : si à 1, met en forme les informations en HTML (0 par défaut)

ATTENTION : si vous voulez utiliser la méthode recupererInformations, le fichier ibd.lib.php doit se trouver dans le include_path du script principal.

Historique

      • 11/12/2016 v1.0 : première version publique.

Téléchargement

À faire

  • chemin include relatif pour ibd.lib.php
  • gestion multi-langue
  • traçage dans des fichiers de log

Laisser un commentaire