tuto-netbeans_v3.1

TUTO NetBeans

Environnement de dveloppement et de test Configuration de NetBeans pour PHP

Nicolas Defa

N.D fev.-14 /TUTO NetBeans v3.1.docx/ Page 1 sur 8

Ce tutoriel vous indique comment configurer NetBeans pour PHP sous Windows avec :

- Lextension Xdebug

- Le framework PEAR

- L'outil de gnration de documentation ApiGen

- Les frameworks danalyse de code source Code Sniffer et PMD

- Le framework de tests unitaires PHPUnit

NetBeans est un EDI (Environnement de Dveloppement Intgr ou IDE en anglais pour Integrated

Development Environment) open source dvelopp l'origine par Sun Microsystems mais repris depuis 2010 par Oracle Corporation.

Ce type d'environnement regroupe un ensemble d'outils ddis au dveloppement de logiciels.

NetBeans supporte les langages Java, PHP, C/C++, Fortran, JavaScript, Python et Ruby.

Site officiel : https://netbeans.org/

1. Lextension Xdebug

1.1 Prsentation

Xdebug est une extension pour PHP qui permet le dbogage et le profilage de code par une

excution pas pas des instructions.

Exemple d'excution d'un script sans et avec Xdebug activ :

Script excut

TUTO NetBeans


Nicolas Defa


1.2 Configuration

Xdebug est dj prconfigur avec cette version de WampServer. Il suffit donc de lactiver en modifiant son paramtrage.

Site officiel : http://xdebug.org/

1.2.1 Activation

Vrifier que vous ayez bien le fichier php_xdebug-2.2.3-5.4-vc9-x86_64.dll dans le dossier C:\wamp\bin\php\php5.4.12\zend_ext

Ouvrir le fichier php.ini depuis l'application WampServer et ajouter la ligne qui apparait en vert la fin du fichier :

; XDEBUG Extension

zend_extension = "c:/wamp/bin/php/php5.4.12/zend_ext/php_xdebug-2.2.3-5.4-vc9-

x86_64.dll"

[xdebug]

xdebug.remote_enable = off

xdebug.profiler_enable = off

xdebug.profiler_enable_trigger = off

xdebug.profiler_output_name = cachegrind.out.%t.%p

xdebug.profiler_output_dir = "c:/wamp/tmp"

xdebug.show_local_vars = on

Redmarrer le service Apache pour une prise en compte des nouveaux paramtres.

Vrifier que vous obtenez bien le rsultat attendu dans le paragraphe 1.1.

1.2.2 Intgration NetBeans

Modifier et ajouter les lignes qui apparaissent en vert dans la section Xdebug du fichier php.ini :

; XDEBUG Extension

zend_extension = "c:/wamp/bin/php/php5.4.12/zend_ext/php_xdebug-2.2.3-5.4-vc9-

x86_64.dll"

[xdebug]

xdebug.remote_enable = on

xdebug.remote_handler = dbgp

xdebug.remote_host = localhost

xdebug.remote_port = 9000

xdebug.profiler_enable = off

xdebug.profiler_enable_trigger = off

xdebug.profiler_output_name = cachegrind.out.%t.%p

xdebug.profiler_output_dir = "c:/wamp/tmp"

xdebug.show_local_vars = on

Redmarrer le service Apache pour une prise en compte des nouveaux paramtres.

TUTO NetBeans


Nicolas Defa


1.3 Mise en uvre

Ouvrir NetBeans et lancer l'excution du script (cf. 1.1) en mode dbogage : (ou +

F5)

La barre des outils ddie au dbogage est active :

Aprs deux clics sur l'icne on obtient la trace suivante :

2. Le "framework" PEAR

2.1 Prsentation

PEAR (PHP Extension and Application Repository) est une collection de bibliothques d'outils

dvelopps en PHP. Elle peut tre assimile un framework. Ce type de bibliothque propose un

ensemble de composants logiciels pouvant tre exploits librement et personnaliss.

Site officiel : http://pear.php.net/

2.2 Installation

Tlcharger le fichier go-pear.phar sur http://pear.php.net/go-pear.phar et lenregistrer dans le dossier C:\wamp\bin\php\php5.4.12.

Veiller bien tlcharger ce fichier mme sil est prsent dans larborescence. Lancez une console (avec les droits dun administrateur) puis placez-vous dans le rpertoire C:\wamp\bin\php\php5.4.12

Lancer linstallation de PEAR :

> php go-pear.phar

Pour toutes les questions qui suivront, taper la touche entre pour rpondre avec les valeurs proposes par dfaut.

Suite cette installation, un fichier Pear_ENV.reg est cr dans le rpertoire C:\wamp\bin\php\php5.4.12

Double-cliquer sur ce fichier depuis lexplorateur afin de finaliser l'installation PEAR.

Les outils abords par la suite dans ce tutoriel (ApiGen, Code Sniffer, PMD et PHPUnit) sappuient sur cette bibliothque quil faut donc installer.

TUTO NetBeans


Nicolas Defa


3. Gnrateur ApiGen

3.1 Prsentation

ApiGen est un outil de gnration automatique de documentation de code PHP qui s'appuie sur des

composants logiciels de la bibliothque PEAR.

Alternative phpDocumentor, il est recommand sous NetBeans.

Site officiel : http://apigen.org/

La convention dcriture des commentaires est PHPDoc (adaptation de JAVADoc). Cette syntaxe est utilise par PEAR ainsi que par loutil de modlisation DIA.

Site officiel : http://www.phpdoc.org/docs/latest/references/phpdoc/index.html

Exemples de commentaires : http://pear.php.net/manual/fr/standards.sample.php

3.2 Installation

Ouvrir une console (avec les droits dun administrateur) puis placez-vous dans le rpertoire C:\wamp\bin\php\php5.4.12 et lancer les commandes suivantes :

> pear config-set auto_discover 1

> pear install pear.apigen.org/apigen

Configurer lEDI (Menu : Outils/Options/PHP/Onglet ApiGen )

Cette version ncessite une mise jour du chemin vers Texy1 :

Ouvrir le fichier C:\wamp\bin\php\php5.4.12\apigen avec Notepad++ et modifier le chemin vers le script texy.php comme surlign en vert :

3.3 Mise en uvre

Crer un dossier dans lequel la documentation sera gnre. Exemple :

1 Texy est une bibliothque PHP ddie la mise en forme de pages WEB.

Bien vrifier la

prsence du .bat

en fin de fichier !

TUTO NetBeans


Nicolas Defa


Depuis lexplorateur de projet de NetBeans, faire un clic droit sur le projet et choisir la fonctionnalit de gnration de documentation :

Slectionner le dossier prcdemment

cr :

Exemple de rsultat :

Le code dune classe

La documentation gnre (extraits)

TUTO NetBeans


Nicolas Defa


4. Les frameworks Code Sniffer et PMD

4.1 Prsentation

CodeSniffer est un analyseur de code qui intgre les conventions de codage de plusieurs standards

(PEAR, ZEND...). Il analyse galement le code JavaScript et les feuilles de style (CSS). Il est

possible de dfinir ses propres conventions.

Site officiel : http://www.squizlabs.com/php-codesniffer

PMD (PHP Mess Detector) est la base un framework danalyse de code source Java. Il existe galement pour PHP et sintgre facilement sous NetBeans. Cet outil vrifie la qualit du code (respect des conventions dcriture, complexit, code mort...)

Site officiel : http://phpmd.org/

4.2 Installation

Ouvrir une console (avec les droits dun administrateur) puis placez-vous dans le rpertoire

C:\wamp\bin\php\php5.4.12 et lancer les commandes suivantes :

> pear install PHP_CodeSniffer

> pear channel-discover pear.phpmd.org

> pear channel-discover pear.pdepend.org

> pear install --alldeps phpmd/PHP_PMD

Ignorer lavertissement concernant php_bin et lerreur relative au fichier imagick.dsp

Configurer lEDI (Menu : Outils/Options/PHP/Onglet Code Analysis )

4.3 Mise en uvre Depuis NetBeans, ouvrir le fichier tester et lancer l'analyse du code : Menu Source/Inspect...

Bien vrifier la

prsence du .bat

en fin de fichier !

TUTO NetBeans


Nicolas Defa


Exemple de rsultat obtenu en utilisant la classe aborde en 3.3 :

Les erreurs affiches concernent le non respect des conventions dcriture du code. Elles sont gnres par Code Sniffer (configur pour PEAR).

Ajouter une proprit quelconque dans la classe Chaise et relancer lanalyse du code :

Ici, lanalyse ralise par PMD fait ressortir la non-utilisation de la proprit ajoute dans le code. 5. Le framework PHPUnit

5.1 Prsentation

PHPUnit est un framework de tests unitaires dvelopp pour le langage PHP. Il est bas sur JUnit,

une rfrence en termes de tests unitaires pour Java. Il propose galement un gnrateur de

squelettes de classes destines aux tests.

PHPUnit sintgre trs facilement sous NetBeans.

Site officiel : http://phpunit.de/

5.2 Installation

Ouvrir une console (avec les droits dun administrateur) puis placez-vous dans le rpertoire

C:\wamp\bin\php\php5.4.12 et lancer les commandes suivantes : > pear channel-discover pear.phpunit.de

> pear install --alldeps phpunit/PHPUnit

> pear install phpunit/PHPUnit_SkeletonGenerator

TUTO NetBeans


Nicolas Defa


Configurer lEDI (Menu : Outils/Options/PHP/Onglet Unit Testing )

5.3 Mise en uvre

Crer un dossier dans lequel les squelettes de classe seront gnrs. Exemple :

Dans l'explorateur de projet, faire un clic droit sur le script tester et choisir la fonctionnalit de gnration de gabarit de test :

Slectionner le dossier prcdemment cr :

Le cas chant, choisir l'utilitaire PHPUnit dans la fentre qui suit :

Remarque :

Un dossier nomm t rajout au

projet. Cest un alias du dossier prcdemment cr.

Exemple de rsultat obtenu en utilisant la classe aborde en 3.3 :

Bien vrifier la

prsence du .bat en fin de fichier !

tuto-netbeans_v3.1

Documents