Formation PUB020 : WordPress, 2023 Le débogueur de PhpStorm

15.4 Configurer le débogueur de PhpStorm sous Devilbox


Pour configurer le débogueur de PhpStorm avec Devilbox :

  • D'abord, votre projet doit avoir été correctement créé et configuré dans PhpStorm.
  • Assurez-vous que l'extension Xdebug soit correctement activée (voir « Activer Xdebug sous Devilbox »).
  • Retrouvez le port de débogage configuré dans le fichier php.ini ou xdebug.ini à la ligne xdebug.client_port (Xdebug 3) ou xdebug.remote_port (Xdebug 2).
    Fichier php.ini

    xdebug.client_port = 9003

    Cette valeur est également affichée à l'aide de la fonction phpinfo().

    xdebug.client_port

    Assurez-vous que ce même numéro de port soit listé dans le menu Files / Settings (Windows) ou PhpStorm / Preferences (Mac) puis PHP / Debug, section Xdebug, configuration Debug port.

    Configurations de débogage

  • Rendez-vous dans le menu PHP / Debug / DBGp Proxy. Entrez les informations suivantes :
    • IDE key : valeur de la configuration xdebug.idekey du fichier php.ini.
    • Host : 0.0.0.0
    • Port : valeur de la configuration xdebug.client_port

      DBPg proxy

  • Dans le haut de l'écran, si l'icône Start Listening for PHP Debug Connections (selon votre version de PhpStorm, c'est un téléphone ou une grosse « bibitte ») est surplombée d'un cercle rouge ou d'un X rouge, cliquez sur cette icône afin que PhpStorm soit à l'écoute des connexions de débogage.  

    Start listening for PHP debug connections Bibitte

    Vous obtiendrez alors une de ces icônes.

    Actif Actif

    Note : Si vous constatez un ralentissement de votre système, vous pouvez cliquer à nouveau sur ce bouton pour arrêter l'écoute des connexions de débogage.

    La désactivation de l'écoute pourrait également être nécessaire pour accéder à phpMyAdmin.

    Vous devrez réactiver l'écoute pour votre prochaine session de débogage.

  • Pour vérifier si les configurations sont correctes, allez dans le menu Run / Web Server Debug Validation.
    • Entrez le chemin physique de votre site (ex : sous Windows : C:\Users\MonNom\Documents\devilbox\data\www\monsite\htdocs, sous Mac : /Users/monnom/Documents/devilbox/data/www/monsite/htdocs).
    • Entrez l'URL de votre site (ex : http://monprojet.loc).
    • Cliquez sur Validate.

      Vous verrez probablement le message « No php.ini file was found », ce qui est normal. Pour le reste, vous ne devriez voir que des crochets verts.

      Validate Debugger Configuration
  • Si ce n'est pas déjà fait, définissez une configuration à l'aide de Run / Edit Configurations

    • Cliquez sur le + puis choisissez PHP Web Page.

      PHP Web Page

    • Donnez un nom à la configuration (ex : index).
    • Dans la liste déroulante des serveurs, sélectionnez votre serveur Devilbox.
    • Dans la zone Start URL, entrez /. Vos devriez obtenir un URL du genre http://monsite.loc/.
    • La section Browser vous permet, si vous le désirez, de choisir le navigateur sera utilisé par défaut.

      Run / Edit Configurations

      Vous êtes maintenant prêts à lancer le débogueur.
  • Ajoutez un point d'arrêt dans votre code (sur une ligne PHP et non sur une ligne qui ne contient que du HTML) en cliquant dans la marge gauche puis lancez le débogage en cliquant sur l'icône Debug (la « bibitte »).

    Icône Debug

  • Le programme s'arrêtera dès qu'il atteindra un point d'arrêt. Vous verrez dans la fenêtre de débogage la valeur des différentes variables. Vous pourrez poursuivre l'exécution du site ligne à ligne (flèches au-dessus de la zone Variables) ou encore poursuivre l'exécution jusqu'à ce qu'un autre point d'arrêt soit rencontré (flèche verte à gauche).

    Fenêtre de débogage

Pour plus d'information

« Configure PHP Xdebug ». Devilbox. https://devilbox.readthedocs.io/en/latest/intermediate/configure-php-xdebug.html

« Docker on Windows: Xdebug for PhpStorm ». Devilbox. https://devilbox.readthedocs.io/en/latest/intermediate/configure-php-xdebug/windows/phpstorm.html

« Docker on MacOS: Xdebug for PhpStorm ». Devilbox. https://devilbox.readthedocs.io/en/latest/intermediate/configure-php-xdebug/macos/phpstorm.html

« php.ini ». Devilbox. https://devilbox.readthedocs.io/en/latest/configuration-files/php-ini.html

▼Publicité

Veuillez noter que le contenu de cette fiche vous est partagé à titre gracieux, au meilleur de mes connaissances et sans aucune garantie.
Merci de partager !
Soumettre