Programmation PHP/Xdebug

Xdebug est un système qui permet de calculer le taux de couverture de code, de le profiler, ou de l'exécuter pas à pas. Cela montre donc l'exécution plus précisément qu'en relecture seule, et élimine donc le risque de sauvegarder des "echo", des "print" ou des "var_dump" en production.

Programmation PHP

• Introduction
• Installer PHP
• Composer
• IDE
  • PhpStorm
  • NetBeans
  • Eclipse
  • Visual Studio Code
• Bases du langage
  • Commentaires
  • Premier programme
  • Variables
  • Variables superglobales
  • Constantes
  • Opérateurs
  • Fonctions
  • Tableaux
  • Structures de contrôle
  • Boucles
• Programmation avancée
  • Dates
  • Sessions
  • Cookies
  • Cache
    • Memcached
    • Redis
  • Formulaire
  • Fichiers
    • Objets COM
    • Images
  • Mails
  • Sécurité
  • Programmation orientée objet
  • Bases de données
    • Microsoft SQL Server
    • MySQL
    • PDO
    • SQLite
  • Expressions rationnelles
  • Code de haute qualité
    • Analyse statique de programmes
  • Exceptions
  • Xdebug
  • Mots réservés
• Apprendre par l'exemple
  1. Utilisation de variables
  2. Un sommaire simple
  3. Interaction avec un formulaire
  4. Afficher le résultat d'une requête BDD
  5. Modifier une table
  6. Faire un livre d'or
  7. Faire un mini forum de discussion
  8. Parser avec DomXml
  9. Coder en MVC
  10. Faire un webservice
  11. Vérification RIO
  • AJAX
  1. Sommaire en Ajax
  2. Mise à jour périodique d'un cadre
  • Mini CMS
  1. Introduction
  2. Développement
     • Les couches choisies
     • Code de service
     • Modélisation
     • Implémentation
     • La vue
     • Ajaxification
     • Premier noyau
     • Fournir les données
     • IHM
  3. Rétrospective
  4. Conclusion
• Extensions PHP
  • cURL
  • DOMDocument
  • JSON
  • MING
  • SPL
• Bibliothèques externes
  • ADODB
  • DOMPDF
  • FPDF
  • PHPExcel
  • PHPMailer
  • PHPWord
  • RabbitMQ
• Cadriciels
  • CakePHP
  • PEAR
  • Symfony
  • Frameworks de tests
    • PHPUnit
    • SimpleTest
    • Behat
• Logiciels métier
• Problèmes connus

Installation

Linux

Installation sur Linux :

sudo apt-get install php8.2-xdebug

ou

pecl install xdebug

Puis dans php.ini :

xdebug.remote_enable = On

ou sur PHP8.2 via Apache :

sudo vim /etc/php/8.2/apache2/conf.d/20-xdebug.ini

Ajouter :

xdebug.remote_enable=1

Configuration complète

Exemple en V3 :

sudo apt-get install php7.4-xdebug
&& echo "xdebug.remote_handler=dbgp" >> /usr/local/etc/php/php.ini \
&& echo "xdebug.discover_client_host=0" >> /usr/local/etc/php/php.ini \
&& echo "xdebug.client_port=9000" >> /usr/local/etc/php/php.ini \
&& echo "xdebug.mode=debug" >> /usr/local/etc/php/php.ini \
&& echo "xdebug.start_with_request=yes" >> /usr/local/etc/php/php.ini

Exemple en V2

On peut aussi forcer d'autres paramètres :

sudo apt-get install php7.4-xdebug
&& echo "xdebug.remote_handler=dbgp" >> /usr/local/etc/php/php.ini \
&& echo "xdebug.remote_connect_back=0" >> /usr/local/etc/php/php.ini \
&& echo "xdebug.remote_port=9000" >> /usr/local/etc/php/php.ini \
&& echo "xdebug.remote_enable=1" >> /usr/local/etc/php/php.ini \
&& echo "xdebug.remote_autostart=1" >> /usr/local/etc/php/php.ini

 

 Le client_port par défaut est passé de 9000 à 9003 entre Xdebug 2 et 3.

Docker

Avec Docker, il faut aussi spécifier le "remote_host".

Exemple d'installation et activation :

RUN pecl install xdebug-2.9.8 \
  && docker-php-ext-enable xdebug

RUN echo "xdebug.client_host = 172.170.0.1" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
    && echo "xdebug.remote_handler=dbgp" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
    && echo "xdebug.discover_client_host=0" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
    && echo "xdebug.client_port=9000" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
    && echo "xdebug.mode=debug" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
    && echo "xdebug.start_with_request=yes" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini

Windows

Wamp fournit Xdebug en mode "develop". Pour activer le débogage pas à pas, il faut donc éditer le php.ini :

xdebug.mode=debug
xdebug.client_host=127.0.0.1
xdebug.start_with_request=yes

Lancement

Dans un navigateur

Il faut installer un module sur son navigateur (ex : Xdebug-ext sur Firefox) pour pouvoir activer ou désactiver le débogage d'une page. Ce module s'interface avec les principaux IDE, par exemple PhpStorm, pour leur faire lancer le débogage lors du chargement d'une page.

En ligne de commande

On peut ajouter un argument à PHP. Ex :

php -d xdebug.profiler_enable=1 bin/console MaCommande.php

Débogage pas à pas

Lors du débogage, PhpStorm fera apparaitre un menu "Debug" avec trois sous-menus dont :

1. la liste des variables du script et leurs valeurs (modifiables à la volée)
2. les warnings PHP
3. la sortie HTML.

Quand on clique dans la marge, un point d’arrêt est créé et représenté par une ligne rouge.

Raccourcis clavier (voir le menu "Run" en haut) :

• F7 (step into) : mode pas à pas détaillé.
• F8 (step over) : mode pas à pas sans sauter dans les dépendances.
• F9 (resume) : poursuivre l'exécution du programme sans s'arrêter.
• Alt + F9 : poursuivre jusqu'au prochain point d'arrêt.
• Shift + F7 : pas à pas intelligent.

Profilage

Ajouter le mode au précédent :

xdebug.mode=debug,profile

Un ensemble de vidéos explicatives existent en anglais.