Dossier de formation

Formation
PHPCheckstyle
I. Introduction
II. Obtention et ces différentes utilisations de PHPCheckstyle
III. Installation de PHPCheckstyle avec Wamp
IV. Mise en application du logiciel
I. Introduction
Qu’est-ce que PHPCheckStyle ?
PHPCheckstyle est un outil open-source permettant de vérifier que votre code
respecte bien les conventions de codage que vous aurez définies au préalable en
indiquant vos erreurs et leurs solutions dans un fichier HTML. S’adressant à la
communauté des développeurs PHP, il a été basé sur la convention de codage PEAR et
pourra être adapté, dans une certaine mesure, en fonction des besoins. Si vous devez
reprendre le développement d’un projet n’ayant suivi aucune convention de codage,
PHPCheckstyle vous indiquera de nombreuses " erreurs ".
Qu'est-ce que PEAR ?
PEAR est l'abréviation de " PHP Extension and Application Repository " et se prononce
'père' (NDT : PEAR veut dire poire en Anglais). La mission de PEAR est de fournir :
Une librairie structurée de code source libre pour les utilisateurs de PHP
Un système de distribution du code source et de maintenance des paquets.
Un style de codage pour les programmes écrit en PHP
Une bibliothèque d'extensions de PHP (PECL - PHP Extension Code Library)
1
II. Obtention et ces différentes utilisations de PHPCheckstyle
L’archive d’utilisation est mis dans le répertoire commun.
Vous pouvez également retrouver cette archive ou la prochaine
version sur le lient suivant :
http://code.google.com/p/phpcheckstyle/downloads/list
PHPCheckstyle peut être utilise de trois façons :
Utilisation PHPCheckstyle avec Eclipse
Eclipse est déjà en mesure de faire des vérifications et de reformater votre code
(Ctrl + Maj + F) avec la TPD.
Il est également possible d'ajouter des outils comme PHPCodeSniffer ou
PHPCheckstyle pour vérifier le code que vous éditez.
Installez d'abord l'intégration Eclispe outil PHP (voir
http://www.phpsrc.org/wiki/)
Mise à jour Eclipse URL: http://www.phpsrc.org/eclipse/pti/
Obtenir la dernière version de PHPCheckstyle.
Dans Eclipse, configurer un nouveau validateur:
Préférences-> Langues-> Dynamique des validateurs
Cliquez sur "Ajouter ..."
Sélectionnez l'option "Script PHP externe» de type
Définissez le chemin du PHP Checkstyle "run.php" fichier.
Configurer l'exécutable PHP pour correspondre à votre environnement.
Ajouter quelques arguments à l'exécutable
- % F src - config "default.cfg.xml" - console au format
Ajoutez quelques règles pour lire les résultats :
Ligne INFO% f:% n -% m Avertissement
Ligne AVERTISSEMENT% f:% n -% m Avertissement
Ligne ERROR% f:% n -% d'erreur m
Et il devrait être OK, sur votre PHP Editor, faites un clic droit, sélectionnez
«validateurs» DLTK et le script doit s'exécuter.
Utilisation PHPCheckstyle avec Hudson / Jenkins
Le XML générée par PHPCheckstyle est compatible avec le format original
Checkstyle XML.
Le plugin Violation de Hudson est capable de lire le fichier.
2
Utilisation PHPCheckstyle comme une interface web
Si PHPCheckstyle se trouve sur le même serveur Web que votre code vous pouvez
le vérifier grâce à l’interface web, il vous suffit d’appeler directement le fichier
"index.php" et d’utiliser votre navigateur pour lancer l'analyse.
III. Installation de PHPCheckstyle avec Wamp
Pour utiliser PHPCheckstyle il faut tout d’abord copier l’archive dans
C:\wamp\www et la décompresser.
3
Ensuite lancer Wamp et aller dans le locahost.
Ensuite cette fenetre s’ouvre :
4
Dans l’onglet Vos projets sélectionner le dossier PHPCheckstyle-0.10.5 et cette
page doit s’ouvrir.
IV. Mise en application du logiciel
Pour cette mise en application vous pouvez utiliser le site que Madame BARANGER
nous avait demandé de faire en début d’année mais si vous ne l’avez pas sur vous ou
qu’il ne fonction pas vous pouvez récupèrer celui que j’ai mis sur le commun.
Une fois récupéré, n’oubliez pas de créer la base de données dans wamp pour cela
faite la même opération que pour ouvrir le localhost mais choisissez PHPMyAdmin et
importer le script de création de table qui se trouve dans le dossier SQL du Dossier Site.
Une fois cela fini nous reprendrons la page de PHPCheckstyle soit de l’image juste
au-dessus et dans File(s) to analyse vous rentrerez le chemin d’accès, soit pour nous
C:\wamp\www\(le nom de votre site) et cliquer sur le bouton Run et une page listant
tous vos pages s’affichent.
5
Cliquer sur le lien pour afficher le résultat et cette page s’ouvre.
6