Aller au contenu principal

Utiliser une DebugBar au sein d'un projet Easy2Do

Un paquet externe de debugbar peut être installé. Une fois activé, E2D va automatiquement charger le code nécessaire pour afficher sur chaque page la debugbar.

Installer la DebugBar​

Nécessite un environnement avec Composer.

Dépendance externe​

Installer la dépendance DebugBar en exécutant les commandes suivantes :

# Se diriger dans le dossier suivant (le créer si besoin) :
cd lib/externe/PHP/
# Télécharger la dépendance avec Composer
composer require php-debugbar/php-debugbar
# On n'utilise pas les fichiers composer, on peut les supprimer
rm composer.*
# Renommer le dossier vendor !
mv vendor php-debugbar

En tant que dépendance de développement (et sans un usage classique de Composer avec require --dev), il est recommandé d'ignorer le versionning du dossier contenant la dépendance /lib/externe/PHP/php-debugbar (.gitignore avec Git).

Dossier "debugbar"​

Créer un dossier debugbar à la racine (imposer par E2D, pour y faire pointer le cache de DebugBar pour son fonctionnement).

remarque

La Debugbar ne devant pas être activée que les environnements de développement, il n'est généralement pas nécessaire de propager ce dossier dans le code source. Il est donc recommandé de l'ignorer dans le service de versionning.

Alternativement, il est possible de commiter ce dossier, mais dans ce cas il faut ignorer son contenu (ce dossier est voué à contenir des fichiers générés). Cela peut permettre une installation facilitée pour les développeurs (on gagne une étape d'installation).

Configuration et fichier environnement.php​

Il reste une étape de configuration pour activer la Debugbar au sein d'E2D.

remarque

Les infos de configuration de la Debugbar pour E2D se placent dans la variable globale suivante :

$GLOBALS['aEnvironnement']['aDebugBar']

Elle contient un tableau associatif. Sont disponibles les options suivantes :

bDebugBarActivee : true|false Permet d'activer ou non la debugbar

bDebugCoreEtRessource : true|false Permet d'afficher ou non les Notice et Warning du Core et des Ressources

Créer le fichier environnement.php (s'il n'existe pas déjà) à la racine du projet. Le compléter avec le code suivant (à adapter au besoin) :

<?php

// -> Adapter les conditions du if selon l'environnement de développement <-
if (
    str_contains($_SERVER['HTTP_HOST'], ':8080')
    || preg_match('/dev\./', $_SERVER['HTTP_HOST'])
) {
    ini_set('display_errors', 'Off');
    ini_set('log_errors', 'On');
    $GLOBALS['aEnvironnement']['aDebugBar'] = [
        'bDebugBarActivee' => true, // Permet d'activer ou non la debugbar
        'bDebugCoreEtRessource' => true, // Permet d'afficher ou non les Notice et Warning du Core et des Ressources
    ];
}

Le fichier environnement.php sera détecté automatiquement par E2D qui en appliquera les règles.

Utilisation​

Si la Debugbar est activée (bDebugBarActivee à true), un fichier CSS et un fichier JS sont chargés dans chaque page, permettant d'afficher la Debugbar en bas de la vue.

On y retrouve différents onglets qui permettent d'afficher diverses informations (message PHP, etc.).

L'instance PHP de la Debugbar est disponible dans la variable $GLOBALS['oDebugBar'].

On peut faire apparaitre des messages personnalisés :

$GLOBALS['oDebugBar']['messages']->addMessage("Hello DebugBar!");

Documentation complète et ressources​

Une documentation complète de la Debugbar est disponible :

https://php-debugbar.com/docs/

Code source de la dépendance :

https://github.com/php-debugbar/php-debugbar