La joie de FirePHP un cours accéléré

FirePHP est une combinaison de plug-in Firefox et de bibliothèque côté serveur qui vous permet d'envoyer toutes sortes d'informations utiles de votre application Web à votre navigateur, un peu comme la fonctionnalité console.log () avec JavaScript. Dans ce tutoriel PLUS et cette vidéo, nous allons vous apprendre à démarrer dès le début.!

Ce tutoriel comprend un screencast disponible pour les membres Tuts + Premium.

Vous pensez donc que vous êtes un excellent développeur Web, hein? Ne poursuivez pas la lecture du premier défi: répondez (honnêtement) "vrai" ou "faux" à votre propos aux affirmations suivantes:

  1. Vous utilisez Firefox pour le développement Web
  2. Vous avez installé la célèbre extension Firebug
  3. Vous développez en PHP

Si vous avez répondu aux trois avec un «vrai» retentissant, donnez-vous une tape dans le dos. Je vous pardonnerai de ne pas avoir obtenu le numéro trois, mais si vous n'utilisez pas Firefox avec Firebug… où avez-vous été!?

Vous aurez besoin de cette combinaison gagnante pour compléter ce didacticiel. La dernière chose dont vous aurez besoin - pour devenir le grand maître, le grand développeur, le destructeur de code de vos rêves - est la partie la plus importante: FirePHP.


Qu'est-ce que FirePHP??

FirePHP est une combinaison de plugins Firefox et de bibliothèques côté serveur qui vous permet d’envoyer toutes sortes d’informations juteuses de votre application Web à votre navigateur, de manière plus agréable que l’habituel:

 echo $ variable;

Ce code est si commun. Parfois, il semble que le moyen le plus rapide de simplement éclabousser la valeur de $ variable de sorte que vous savez ce qu'il en est à un moment donné de l'exécution du code.

Mais si $ variable n'est pas une chaîne ou un entier; Et si c'est un type de données complexe comme un tableau ou un objet? En PHP, le code ci-dessus ne serait pas très utile:


"Utilisez simplement print_r ($ variable);" Je vous entends dire. Bon pantalon smarty, mais ce n'est pas très élégant. Essayer de trouver la valeur d'un élément de tableau dans ce désordre est une douleur. Et ça ne règle toujours pas les objets!

Lorsque vous voyez ce que FirePHP peut faire, vous changez d'avis! Il transforme le débogage en un processus étonnamment agréable et donne un code beaucoup plus portable.

Dans ce didacticiel, je vais vous montrer comment configurer FirePHP dans votre application et comment l'utiliser pour accélérer le développement et le débogage..


Étape 1: Configuration du côté serveur

Si l'extension FirePHP n'est pas installée, installez-la maintenant..

L'extension FirePHP (que je nommerai désormais FirePHP) est entièrement dépendante de Firebug, vous en aurez donc besoin également. Les classes côté serveur (que j'appellerai FirePHPCore) sont disponibles en tant que bibliothèque autonome. Il existe également un certain nombre de plugins pour les frameworks PHP populaires et les CMS..

Simon dit:

Bien que son nom l'indique autrement, FirePHP n'est pas réservé aux développeurs PHP. Il utilise son propre ensemble d'en-têtes HTTP pour envoyer des informations de votre application au navigateur, de sorte qu'il peut facilement être porté dans d'autres langues. Des bibliothèques côté serveur sont disponibles pour ASP, Ruby, Python, etc. S'il n'y en a pas une pour votre langue, vous pouvez toujours vous mettre au défi et écrire la vôtre.

Cela le rend également idéal pour le débogage AJAX, car cela signifie que les réponses asynchrones sont un contenu clair ne contenant que la sortie que vous voulez voir - pas le code de débogage..

Allez-y et téléchargez votre bibliothèque côté serveur préférée. Dans ce tutoriel, je vais me concentrer sur l’utilisation de la bibliothèque principale autonome. Des instructions pour configurer d’autres bibliothèques sont disponibles sur le wiki FirePHP..

Simon dit:

Si vous avez configuré PEAR et préférez l'utiliser, tapez simplement les deux lignes suivantes dans la ligne de commande:

 pear channel-découvrir pear.firephp.org pear installer firephp / FirePHPCore

Une fois que vous avez décompressé le paquet, allez dans le lib dossier et copier le FirePHPCore dossier de votre serveur Web ou dossier d'inclusion d'applications.


Screencast Compagnon


Simon dit:

L'un des avantages du FirePHPCore autonome est son support pour PHP4. Vous pouvez même le connecter à certains de ces sites rétro que vous utilisez encore.!


Étape 2: Bonjour, FirePHP

Comme avec tous les bons tutoriels de codage, nous allons commencer par un exemple basique, "Hello, World" de FirePHP..

Créez un nouveau document PHP vierge. Je vais appeler le mien test.php. Enregistrez-le à la racine de votre application.

Pour que FirePHPCore fonctionne, nous devons activer la mise en mémoire tampon de sortie. Renseignez-vous davantage à ce sujet si vous ne l’avez jamais utilisé auparavant, c’est une bonne habitude à prendre quand même..

 

Bien entendu, nous ne devons pas oublier d’inclure la bibliothèque FirePHPCore. Si vous utilisez PHP5, ajoutez ceci en haut du fichier:

 include_once ('includes / FirePHPCore / fb.php');

Si vous utilisez PHP4, incluez le fb.php4 déposer à la place.

Simon dit:

Nous n'avons pas besoin d'inclure le fichier de classe car il est inclus dans le fichier fb.php.

Nous pouvons maintenant commencer à émettre vers la console Firebug. Tapez ce qui suit après ob_start () et avant ob_end_flush ():

 FB :: info ('Hello, FirePHP');

Simon dit:

FirePHPCore a une API procédurale et orientée objet. Il n'y a vraiment aucune différence entre les deux et vous pouvez utiliser celui que vous préférez.

Il utilise également le modèle singleton pour économiser de la mémoire et est livré avec une classe d’assistance complètement statique, que je préfère utiliser car elle nécessite moins de codage..

Ouvrez Firefox, démarrez Firebug et accédez à cette page. Vous devriez obtenir quelque chose comme ça:


À quel point cela est cool!? Eh bien, ce n'est pas une démo très excitante, alors essayons quelque chose d'un peu plus compliqué.


Étape 3: Envoi de variables complexes

Voyons ce qui se passe lorsque nous passons dans une variable complexe. Nous allons construire un tableau et voir ce que nous obtenons. Ajoutez le code suivant juste après le dernier appel FB :: info ():

 $ array ['key1'] = 'du contenu'; $ array ['anotherKey'] [] = 1234; $ array ['anotherKey'] [] = 5678; $ array ['anotherKey'] [] = 9012; $ array [] = null; FB :: info ($ array, 'My Array Test');

Maintenant, sauvegardez, allez à Firefox et actualisez.


Ok, ça a l'air bien… mais, accrochez-vous, où est la sortie? Passez votre curseur sur cette nouvelle ligne.


Sensationnel. Le cadre Firebug nous montre toutes les données de notre tableau - pas seulement les éléments de tableau de premier niveau, mais également celles de niveau inférieur - et de manière lisible et nette..

Cela devient encore plus intéressant avec des objets! FirePHPCore utilise pleinement la réflexion pour inspecter les propriétés d'un objet, même privées..

Simon dit:

FirePHPCore dispose d’un certain nombre d’options pouvant être définies pour limiter le niveau d’inspection des matrices et des objets. Vous pouvez même créer un filtre pour les propriétés d'objet que vous ne voulez pas qu'il passe à l'agent utilisateur..

Vous pouvez en savoir plus sur l'API FirePHPCore au siège de FirePHP..


Usages Pratiques

Il devrait déjà être évident pour vous que cela peut aider au débogage général, mais je vais maintenant examiner quelques façons inventives d'utiliser FirePHP..

1) Un outil de profilage PHP

Si vous utilisez un seul contrôleur frontal pour acheminer toutes les demandes et amorcer votre application, vous pouvez indiquer le temps nécessaire au traitement de chaque demande pour votre application sur le serveur..

Quelque chose comme ça le ferait:

 

Gardez à l'esprit que ce n'est pas une représentation du temps de réponse, seulement temps d'exécution du code - à quelle vitesse votre serveur exécute le code avant de l'envoyer à l'agent utilisateur. La sortie doit toujours voyager de votre serveur au client via le réseau.

Simon dit:

Vous pouvez utiliser l'extension YSlow pour Firebug pour suivre le temps de chargement global des pages et la réactivité des applications..

2) Un outil d'inspection de requête SQL simple

Si vous utilisez une fonction de requête centrale ou étendez une classe de connecteur de base de données (telle que mysqli), vous pouvez envelopper une minuterie autour de toutes les requêtes synchrones et vérifier le temps qu'elles prennent..

Vous pouvez également noter les requêtes SQL elles-mêmes. En fait, vous pouvez rassembler ces deux bits de données. Et ne serait-il pas agréable d'afficher cela dans un tableau bien structuré?

Well Firebug a une structure de table et FirePHPCore a aussi un wrapper pour cela:

 

Simon dit:

J'ai jeté quelques extras ici. Dans le fichier myDb.class.php, si le $ résultat la variable revient faux, cela signifie que cette requête a échoué. Donc j'utilise FB :: error () signaler cela comme une erreur dans Firebug et me montrer la requête ainsi que FB :: trace () pour me montrer la pile de processus menant à la mauvaise requête.

La chose clé ici est la FB :: table () méthode. Cela rend la création d'informations de débogage structurées trop facile.

Désormais, lorsque vous instanciez votre classe myDb et exécutez une requête, les détails de cette requête apparaissent dans un tableau. Nous accéderons ensuite à ce tableau pour construire notre table FirePHP de toutes les requêtes que vous avez exécutées pour cette requête, de la durée de chacune d'elles et du temps total d'exécution de toutes les requêtes.


Ce que vous avez fait ici, avec seulement quelques lignes de code, aurait été impossible avec seulement écho. Vous ne pouviez pas espérer obtenir quelque chose d'aussi utile en si peu de temps. Cela permet un débogage rapide.

3) Un débogueur AJAX

L'utilisation de FirePHPCore pour les requêtes AJAX n'est pas différente de son utilisation pour les requêtes synchrones. Utilisez simplement les fonctions normalement. Lorsque votre application effectue une demande AJAX, les informations supplémentaires de l'en-tête FirePHP sont transmises et l'extension côté client les traite dans la console de Firebug. Essayons.

Créez un nouveau fichier appelé ajax.php à la racine de votre application. Mettez le code suivant ici:

 

Maintenant dans votre test.php fichier, ajoutez ce qui suit après votre dernier appel FB :: info ():

 ?>     

Le rafraîchissement de test.php dans Firefox devrait vous montrer votre "Cliquez-moi!" bouton. Lorsque vous cliquez dessus, le navigateur doit exécuter une requête AJAX et charger la réponse (dans ce cas, du texte brut) dans la liste.

.


Plus important encore, FirePHP ajoute un nouveau noeud à Firebug qui nous montre tous les messages FirePHP que nous avons enregistrés dans le fichier ajax.php..

4) Gestionnaire d'erreur par défaut

Collez ceci au début de votre application et même de vieilles erreurs PHP désagréables sont transférées dans Firebug!

 set_error_handler ('myErrorHandler'); // Vous pouvez ajouter des paramètres facultatifs $ errfile, $ errline et $ errcontext pour plus de détails sur la fonction myErrorHandler ($ errno, $ errstr) FB :: error ($ errstr, 'Numéro d'erreur'. $ Errno);  // Poursuivre l'exécution normale

C'est un moyen beaucoup plus propre et plus sûr de signaler les erreurs. C'est encore mieux si vous montrez vos applications aux clients pendant qu'ils sont en développement (et au risque de produire des erreurs non critiques) - s'ils n'utilisent pas Firefox, avec Firebug et FirePHP, ils ne verront pas ces erreurs abominables. , mais vous allez… dans Firebug. Plus besoin de changer les niveaux de signalement des erreurs pour garder les choses en ordre! Voilà un développement plus rapide.


Sécurité

Bien que FirePHP soit un excellent outil de débogage lors du développement et des tests, il ne doit pas être laissé en mode de production. Cela peut potentiellement révéler trop d'informations sur votre application, ce qui simplifie encore plus la vie des pirates.

Bien sûr, si vous vous connectez à un site via HTTPS, toutes les informations d'en-tête sont cryptées en standard. Sinon, il est envoyé sous forme de texte brut.

Cela ajoute également à votre application une surcharge qui pourrait entraîner une réduction importante des performances et une perte de votre bande passante..

Cela m'amène à un autre point intéressant à propos de FirePHPCore: vous pouvez laisser le code FirePHP en place, mais il n'enverra aucune donnée s'il est désactivé ou si la chaîne de l'agent utilisateur demandeuse ne contient pas la référence FirePHP spécifique..

Si vous devez absolument activer FirePHP sur les sites de production, par exemple pour le débogage à distance, assurez-vous qu'il est sur un commutateur et n'oubliez pas de le désactiver lorsque vous avez terminé. Quelque chose comme:

 define ('DEBUG_MODE', true); FB :: setEnabled (false); if (DEBUG && $ _SESSION ['userIsAdmin']) FB :: setEnabled (true); 

Cela garantit que même si votre DEBUG_MODE est défini sur 'true' (c'est-à-dire 'on'), seule une session d'administrateur authentifiée utilisant un agent utilisateur avec FirePHP installé déclenchera le code de débogage et recevra les informations d'en-tête supplémentaires..


Conclusion

FirePHP est un outil brillant. Cela s'est parfaitement intégré à mon flux de travail. Parce qu’il est toujours là, lié aux outils que j’utilise déjà au quotidien, il est devenu une seconde nature d’utiliser.

Plus important encore, cela m'a sauvé la peau plus de quelques fois. J'ai pu déboguer des sites en production sans avoir à les supprimer. Le débogage AJAX est une possibilité très réelle et, du fait de son ouverture et de son utilisation libre, son coût d’adoption est extrêmement bas..

Ajoutez à cela le fait que mes applications sont désormais plus portables, j'ai une meilleure compréhension de ces applications et j'ai appris quelques nouveaux trucs en cours de route.?

De plus en plus de développeurs Web utilisent le navigateur comme principal outil de développement. Et pourquoi pas? C’est là que nos applications sont censées fonctionner. Il semble donc plus naturel de mettre le profilage et le débogage directement dans le navigateur; où nous passons quand même le plus clair de notre temps à déboguer!

Pense qu'il est temps d'arrêter d'utiliser écho à présent? Félicitations, Super-Dev!


FirePHP a été créé par Christoph Dorn. La version 0.3.1 est la version stable actuelle. La version 1.0 est en cours de développement et promet de nouvelles fonctionnalités intéressantes.