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, capable d'aider les développeurs à déboguer le code, analyser les performances et vérifier la couverture du code. C'est un atout précieux pour le développement et la maintenance des applications PHP.

Introduction au module Xdebug

Xdebug est une extension PHP puissante utilisée pour déboguer et analyser le code PHP. Il offre de nombreuses fonctionnalités de débogage, y compris le débogage avec des points d'arrêt, le suivi de la pile, la surveillance des variables, etc. De plus, Xdebug prend en charge l'analyse des performances et la vérification de la couverture du code, aidant les développeurs à optimiser les performances et à assurer la qualité du code.

Principales caractéristiques

1. Débogage avec points d'arrêt : Xdebug permet de définir des points d'arrêt dans le code et de déboguer ligne par ligne, facilitant la recherche et la correction des erreurs.
2. Suivi de la pile : En cas d'erreur, Xdebug peut générer des informations détaillées sur la pile, aidant les développeurs à localiser rapidement les problèmes.
3. Analyse des performances : Xdebug propose une fonction d'analyse des performances qui peut générer des rapports détaillés, aidant les développeurs à optimiser les performances du code.
4. Couverture du code : Xdebug prend en charge la vérification de la couverture du code, aidant les développeurs à s'assurer que tous les chemins de code sont testés.
5. Support des environnements de développement intégré (IDE) : Xdebug peut être intégré à divers environnements de développement intégré (IDE), comme PHPStorm, Visual Studio Code, etc., offrant ainsi une expérience de débogage pratique.

Versions du module Xdebug intégré de ServBay

ServBay prend en charge plusieurs versions de PHP, chacune étant dotée du module Xdebug correspondant. Voici les versions spécifiques :

• 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

Remarque

Chaque version de PHP a son propre port Xdebug indépendant, lié au numéro de version. Par exemple, le port Xdebug pour PHP 7.2 est 39072, et celui pour PHP 8.3 est 39083.

Comment activer le module Xdebug

Par défaut, le module Xdebug est désactivé. Les étapes d'activation du module Xdebug sont très simples et consistent simplement à modifier le fichier de configuration correspondant à la version de PHP. Voici les étapes détaillées :

Étape 1 : Trouver le fichier de configuration

Tout d'abord, localisez le répertoire conf.d correspondant à la version de PHP appropriée. 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]
; Uncomment the following line to enable XDebug
zend_extension = xdebug.so

Étape 3 : Configurer les paramètres de Xdebug

Pour tirer pleinement parti des fonctionnalités de Xdebug, vous pouvez configurer certains paramètres 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 correspondant. Par exemple, redémarrez le service PHP 8.3. Une fois le redémarrage terminé, le module Xdebug sera chargé avec succès.

Vérifier que le module Xdebug est bien chargé

Vous pouvez créer un fichier PHP simple pour vérifier que le module Xdebug est bien chargé. Dans le répertoire racine du serveur web, créez un fichier phpinfo.php avec le contenu suivant :

<?php
phpinfo();
?>

Accédez à https://servbay.host/phpinfo.php et recherchez les informations relatives au module Xdebug sur la page d'informations PHP. Si vous voyez les informations relatives à Xdebug, cela signifie que le module est chargé avec succès.

Configurer Xdebug dans PHPStorm

Pour utiliser Xdebug pour déboguer dans PHPStorm, suivez les étapes de configuration suivantes :

Étape 1 : Ouvrir PHPStorm et accéder aux paramètres

1. Ouvrez PHPStorm.
2. Cliquez sur le menu File, puis sélectionnez Settings (Windows/Linux) ou Preferences (macOS).

Étape 2 : Configurer l'interpréteur PHP

1. Dans la fenêtre des paramètres, allez à Languages & Frameworks -> PHP.
2. Dans la section CLI Interpreter, cliquez sur le bouton ... à droite.
3. Dans la fenêtre qui s'ouvre, cliquez sur le + pour ajouter un nouvel interprète PHP, puis sélectionnez Local.
4. Définissez le chemin de l'interprète PHP sur le chemin correspondant à la version de PHP de ServBay, par exemple, /Applications/ServBay/package/php/8.3/8.3.7/bin/php.
5. Cliquez sur OK pour enregistrer les paramètres.

Étape 3 : Configurer le débogage Xdebug

Remarque

Chaque version de PHP a son propre port Xdebug indépendant, lié au numéro de version. Par exemple, le port Xdebug pour PHP 7.2 est 39072, et celui pour PHP 8.3 est 39083.

1. Dans la fenêtre des paramètres, allez à Languages & Frameworks -> PHP -> Debug.
2. Dans la section Xdebug, définissez Debug Port sur 39083, en accord avec la configuration de xdebug.client_port.
3. Assurez-vous que l'option Can accept external connections est cochée.
4. Cliquez sur Apply, puis sur OK pour enregistrer les paramètres.

Étape 4 : Configurer le serveur d'application web PHP

1. Dans la fenêtre des paramètres, allez à Languages & Frameworks -> PHP -> Servers.
2. Cliquez sur le + à droite pour ajouter une nouvelle configuration de serveur.
3. Définissez le nom du serveur, par exemple ServBay Localhost.
4. Définissez Host avec le host correspondant dans votre configuration ServBay, par exemple servbay.new, port 443 (HTTPS).
5. Définissez Debugger sur Xdebug.
6. Cliquez sur OK pour enregistrer les paramètres.

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

1. Dans PHPStorm, ouvrez le projet PHP que vous souhaitez déboguer.
2. Placez un point d'arrêt dans le code (cliquez sur la colonne vide à gauche des numéros de ligne).
3. Cliquez sur le bouton Start Listening for PHP Debug Connections (icône en forme de bug) dans la barre d'outils en haut de PHPStorm.
4. Dans votre navigateur, accédez à votre application PHP et Xdebug se connectera automatiquement à PHPStorm, mettant en pause l'exécution du code au niveau du point d'arrêt.

Conclusion

ServBay offre un moyen pratique de gérer et d'activer le module Xdebug. En suivant des étapes simples de configuration et de redémarrage, les développeurs peuvent rapidement activer le module Xdebug sur différentes versions de PHP, profitant ainsi de ses puissantes fonctionnalités de débogage et d'analyse, augmentant ainsi l'efficacité du développement et de la maintenance des applications PHP. Les fonctionnalités de Xdebug, comme le débogage avec points d'arrêt, l'analyse des performances et la vérification de la couverture du code, en font un outil indispensable pour les développeurs PHP.