Comment activer le module Xdebug intégré de ServBay

En tant qu'outil de développement Web intégré puissant, ServBay est livré avec le module Xdebug, et son activation est très simple. Xdebug est un outil de débogage et d’analyse pour PHP qui aide les développeurs à déboguer le code, analyser les performances et vérifier la couverture du code, ce qui en fait un atout indispensable pour le développement et la maintenance d’applications PHP.

Introduction au module Xdebug

Xdebug est une extension PHP puissante pour déboguer et analyser le code PHP. Elle offre des fonctionnalités de débogage riches, y compris le débogage pas à pas, le suivi de la pile d’appels, la surveillance des variables, etc. De plus, Xdebug supporte l'analyse des performances et la détection de la couverture du code pour aider les développeurs à optimiser les performances du code et à garantir la qualité du code.

Principales caractéristiques

1. Débogage pas à pas : Xdebug permet de définir des points d’arrêt dans le code, pour déboguer le code pas à pas et trouver facilement et corriger les erreurs.
2. Suivi de la pile d’appels : En cas d’erreur, Xdebug peut générer des informations détaillées sur la pile d’appels pour aider les développeurs à localiser rapidement le problème.
3. Analyse des performances : Xdebug offre une fonction d’analyse des performances qui peut générer des rapports détaillés des performances pour aider les développeurs à optimiser le code.
4. Couverture du code : Xdebug prend en charge la détection de la couverture du code pour s’assurer que tous les chemins de code sont testés.
5. Support pour les environnements de développement intégrés : Xdebug peut être intégré à plusieurs environnements de développement intégrés (IDE) comme PHPStorm et Visual Studio Code pour une expérience de débogage pratique.

Version du module Xdebug intégré de ServBay

ServBay prend en charge plusieurs versions de PHP et fournit pour chacune le module Xdebug correspondant préinstallé. Les versions en détail sont :

• PHP 5.6, 7.0, 7.1 : Xdebug 2.5.5
• PHP 7.2, 7.3, 7.4 : Xdebug 3.1.6
• PHP 8.0, 8.1, 8.2, 8.3 : Xdebug 3.3.1
• PHP 8.4 : Xdebug 3.4.0-dev

Conseil

Les ports de Xdebug pour chaque version de PHP sont indépendants et liés au numéro de version, par exemple, le port Xdebug pour PHP 7.2 est 39072, celui pour PHP 8.3 est 39083.

Comment activer le module Xdebug

Par défaut, le module Xdebug est désactivé. Pour activer le module Xdebug, il suffit de se rendre dans Langue → PHP, de sélectionner la version PHP pour laquelle activer le module, par exemple PHP 8.4, de cliquer sur Extensions à droite, puis d'activer l’interrupteur à gauche du module Xdebug et de sauvegarder.

L'utilisateur peut également ouvrir ou modifier les configurations manuellement, voici les étapes détaillées :

Étape 1 : Trouver le fichier de configuration

Tout d’abord, dirigez-vous vers le répertoire conf.d de la version de PHP correspondante. Par exemple, pour activer le module Xdebug pour PHP 8.3, nous devons éditer le fichier suivant :

/Applications/ServBay/etc/php/8.3/conf.d/xdebug.ini

Étape 2 : Éditer le fichier de configuration

Ouvrez le fichier xdebug.ini et décommentez le contenu suivant :

[Xdebug]
; Décommentez la ligne suivante pour activer XDebug
zend_extension = xdebug.so

Étape 3 : Configurer les paramètres de Xdebug

Pour profiter pleinement des fonctionnalités de Xdebug, vous pouvez configurer quelques paramètres courants dans xdebug.ini. Par exemple :

xdebug.mode=debug,develop
xdebug.start_with_request=yes
xdebug.client_host=localhost
xdebug.client_port=39083
xdebug.log=/Applications/ServBay/logs/xdebug/8.3/xdebug.log

Étape 4 : Redémarrer le service PHP

Dans le panneau de gestion des services de ServBay, redémarrez le service PHP approprié, par exemple le service PHP 8.3. Une fois le redémarrage terminé, le module Xdebug sera chargé avec succès.

Vérifier si le module Xdebug est chargé avec succès

Vous pouvez vérifier le chargement réussi du module Xdebug en créant un fichier PHP simple. Dans le répertoire racine du serveur Web, créez un fichier phpinfo.php avec le contenu suivant :

<?php
phpinfo();
?>

Visitez https://servbay.host/phpinfo.php, et cherchez les informations relatives au module Xdebug sur la page d’information PHP générée. Si vous voyez les informations de Xdebug, cela signifie que le module est chargé avec succès.

Configurer Xdebug dans PHPStorm

Pour utiliser Xdebug pour le débogage dans PHPStorm, vous devez suivre les étapes de configuration suivantes :

Étape 1 : Ouvrir PHPStorm et entrer dans les paramètres

1. Ouvrez PHPStorm.
2. Cliquez sur File dans la barre de menus, puis sélectionnez Settings (Windows/Linux) ou Preferences (macOS).

Étape 2 : Configurer l'interpréteur PHP

1. Dans la fenêtre des paramètres, naviguez vers Langues & Frameworks → PHP.
2. Dans la section Interpréteur CLI, cliquez sur le bouton ... à droite.
3. Dans la fenêtre pop-up, cliquez sur le + pour ajouter un nouvel interpréteur PHP, sélectionnez Local.
4. Configurez le chemin de l'interpréteur PHP vers le chemin correspondant de PHP dans ServBay, par exemple /Applications/ServBay/package/php/8.3/8.3.7/bin/php.
5. Cliquez sur OK pour sauvegarder les paramètres.

Étape 3 : Configurer le débogage Xdebug

Conseil

Les ports de Xdebug pour chaque version de PHP sont indépendants et liés au numéro de version, par exemple le port Xdebug pour PHP 7.2 est 39072, celui pour PHP 8.3 est 39083.

1. Dans la fenêtre des paramètres, naviguez vers Langues & Frameworks → PHP → Debug.
2. Dans la section Xdebug, définissez Debug Port sur 39083, identique à la configuration xdebug.client_port.
3. Assurez-vous que l’option Peut accepter les connexions externes est cochée.
4. Cliquez sur Apply puis sur OK pour sauver les paramètres.

Étape 4 : Configurer un serveur PHP Web

1. Dans la fenêtre des paramètres, naviguez vers Langues & Frameworks → PHP → Servers.
2. Cliquez sur le + à droite pour ajouter une nouvelle configuration de serveur.
3. Nommez le serveur, par exemple ServBay Localhost.
4. Réglez Host sur l’hôte correspondant dans ServBay, par exemple servbay.new, et le port sur 443 (HTTPS).
5. Configurez Debugger sur Xdebug.
6. Cliquez sur OK pour enregistrer la configuration.

Étape 5 : Démarrer une session de débogage

1. Ouvrez le projet PHP que vous souhaitez déboguer dans PHPStorm.
2. Mettez des points d’arrêt dans le code (cliquez sur la zone vide à gauche du numéro de ligne).
3. Cliquez sur le bouton Commencer à écouter les connexions de débogage PHP (icône de petit insecte) dans la barre d’outils supérieure de PHPStorm.
4. Dans le navigateur, accédez à votre application PHP, Xdebug se connectera automatiquement à PHPStorm et suspendra l'exécution au niveau des points d’arrêt.

Conclusion

ServBay fournit un moyen pratique de gérer et d’activer le module Xdebug. Avec une configuration et un redémarrage simples, les développeurs peuvent rapidement activer le module Xdebug dans différentes versions de PHP pour tirer parti de ses puissantes fonctionnalités de débogage et d’analyse, améliorant l’efficacité du développement et de la maintenance des applications PHP. Les fonctionnalités de débogage pas à pas, d’analyse des performances et de couverture du code de Xdebug en font un outil indispensable pour les développeurs PHP.