PHPPRO - Outillage

Fonctionnalité PM du jour : commencer à utiliser PM sur un projet existant

Olivier Hoareau — Tue, 19 Apr 2011 18:42:00 +0100

Vous travaillez déjà sur un projet de développement. Vous avez entendu parler (ou pas) d'un outil en ligne de commande qui s'appellerai PM et qui aurait certaines fonctionnalités obscures... Vous avez envie de le tester mais vous ne savez pas comment vous y prendre, ce billet est fait pour vous...

Pour rappel, PM est mon outil en ligne de commande pour "augmenter la productivité d'équipe", vous trouverez des informations, le code source et la dernière version (0.1.3.4 à l'heure ou j'écris ces lignes) sur le site officiel : http://github.com/phppro/pm.

Première étape : disposez d'un projet existant

Commencez par choisir un projet (code source) sur lequel vous travaillez déjà (ou avez déjà travaillé). Mettez le dans un répertoire sur votre disque local, disons $HOME/dev/ze-project (ou $HOME est /home/<login> sous linux, et C:\Users\<login> ou C:\Documents and Settings\<login> sous windows XP et supérieure).

Vous êtes prêt ?

Deuxième étape : télécharger pm.phar

L'outil PM est empaqueté sous la forme d'un fichier unique pm.phar qu'il faut télécharger à l'adresse : http://github.com/downloads/phppro/pm/pm.phar (attention, votre navigateur pourrais modifier le contenu du .phar en le téléchargeant, pour ne pas avoir de problème accédez via votre navigateur à http://github.com/phppro/pm, cliquez sur le bouton Download/Télécharger à droite de l'écran et cliquez-droit sur pm.phar, et enregistrer la cible sur le disque dur.

Une fois téléchargé, copiez/déplacer pm.phar dans le répertoire $HOME/dev/ze-project/pm.phar

Troisième étape : installer PHP 5.3 (si il n'est pas encore installé sur votre système)

Bien qu'il puisse "gérer" des projets utilisants n'importe laquelle des versions de PHP (même PHP 4 !), PM nécessite lui-même PHP 5.3 ou supérieure (version CLI / Ligne de Commande) pour fonctionner. Pour vérifier que vous avez une version suffisante de PHP installée :

ouvrez une console / shell et exécutez :

$ php -v

PHP 5.3.5 (cli) (built: Jan  5 2011 20:29:28)
Copyright (c) 1997-2010 The PHP Group
Zend Engine v2.3.0, Copyright (c) 1998-2010 Zend Technologies
    with Xdebug v2.1.0, Copyright (c) 2002-2010, by Derick Rethans

Si vous avez une version inférieure à 5.3.0, alors vous ne pourrez pas utiliser PM avec cette version de PHP. Si c'est le cas, pas de panique, il vous suffit juste d'installer une version complémentaire de PHP sur votre système. Bien sûr, vous pouvez décider de mettre à jour votre version actuelle de PHP pour utiliser une version >= 5.3.0, cependant vérifier bien avant que toutes vos applications locales et tous les développements sur lesquelles vous travaillez sont compatibles avec cette nouvelle version majeure.

Installer une version supplémentaire de PHP 5.3 sur votre poste

Suivant que vous soyez sur Windows ou Linux, la méthode pour installer une version complémentaire de PHP sera différente.

Vous êtes sous Windows

Téléchargez la dernière version de PHP 5.3.x sur le site officiel, en choisissant le paquet binaire windows en version zippée (quelque chose php-5.3.6-nts-Win32-VC9-x86.zip)
Dézippez le paquet téléchargé n'importe où sur votre disque dur, par exemple dans C:\Program Files\PHP-5.3, de sorte que vous ayez C:\Program Files\PHP-5.3\php.exe
Créez le fichier C:\Windows\php-5.3.bat avec le contenu suivant :

@echo off
"C:\Program Files\PHP-5.3\php.exe" -c "C:\Program Files\PHP-5.3\php.ini-development" %*

ouvrez une ligne de commande windows, exécutez :

$ php-5.3 -v

PHP 5.3.6 (cli) (built: Mar 17 2011 10:48:37)
Copyright (c) 1997-2011 The PHP Group
Zend Engine v2.3.0, Copyright (c) 1998-2011 Zend Technologies

Vous êtes sous Linux

Avec la grande majorité des distributions, il est recommandé d'installer vos logiciels avec un système d'installation de paquets, tel que aptitude / apt / yum / rpm / ... Un des problèmes récurrents avec l'utilisations de ces outils est qu'il est difficile (certains pourront peut être nous conseiller la dessus ;)) d'installer plusieurs versions d'un logiciel en même temps sur le même système. A moins que vous ayez trouvé une solution spécifique à votre distribution, je vous propose donc de passer par la case compilation (désolé ;)) :

Je propose une méthode de compilation de PHP en ligne de commande basique pour Ubuntu 10.04 LTS 64 bits

L'important est d'arriver à avoir un exécutable php (quelque soit sont chemin et son nom) qui peut utiliser son propre php.ini et ses propres extensions .so (si besoin) sans "toucher" à votre installer actuelle de PHP.

Quatrième étape: exécuter PM pour la première fois

Ca y est, vous avez PHP 5.3+ installé/disponible sur votre machine et accessible par la commande php-5.3 (ou bien php !)

reouvrez une console / shell
rendez-vous depuis la console dans le répertoire $HOME/dev/ze-project, puis exécutez la ligne suivante et répondez aux questions posées :

$ php-5.3 pm.phar

PM v0.1.3.4 par PHPPRO http://github.com/phppro/pm

Voulez-vous activer le support de PM pour votre projet (Y,n) [Y] : Y

Vous n'avez pas encore defini vos parametres projet, voulez-vous les definir maintenant (Y,n) [Y] : Y
Quelle est la langue d'affichage par defaut pour tous les membres de l'equipe (<auto>,en-us,fr-fr) [<auto>] : fr-fr
Quel est le nom de code (minuscules, sans accent, sans espace) du projet [ze-project] : ze-project
Quelle est le nom de l'entreprise / l'organisation proprietaire de ce projet : PHPPRO
Quelle est l'adresse du site internet de 'PHPPRO' [http://www.phppro.com] : http://www.phppro.fr

Merci ! le projet s'appelle maintenant "ze-project".
Vous pourrez mettre a jour a tout moment les preferences du projet dans le fichier _pm/project.ini ou project.php (les deux sont fusionnes)

Vous n'avez pas encore defini vos parametres utilisateur, voulez-vous les definir maintenant (Y,n) [Y] : Y
Quelle est votre langue d'affichage preferee (<auto>,en-us,fr-fr) [<auto>] : fr-fr
Quel est votre nom [ohoareau] : Olivier Hoareau
Quelle est votre adresse email : me@email.com

Merci ! vous serez maintenant identifie "ohoareau" sur ce projet.
Vous pourrez mettre a jour a tout moment vos preferences dans le fichier _pm/users/ohoareau.ini

Pour afficher l'aide : "pm -h [<action|prefixe>]"
Un bug ? une fonctionnalite ? http://github.com/phppro/pm, merci !

Ca y est ! le support de PM est activé pour votre projet !

Il vous faudra ensuite éventuellement modifier le contenu des fichiers pm (linux) ou pm.bat (windows) pour remplacer "php" par le nom de l'exécutable (chemin complet ou nom spécifique) PHP à utiliser pour exécuter la version PHP 5.3+.

Vous devriez maintenant pouvoir exécuter PM directement avec la commande pm.

Enfin presque, si vous êtes sous linux, il vous faudra utiliser ./pm après avoir fait :

$ chmod u+x ./pm

$ pm

PM v0.1.3.4 par PHPPRO http://github.com/phppro/pm

Pour afficher l'aide : "pm -h [<action|prefixe>]"
Un bug ? une fonctionnalite ? http://github.com/phppro/pm, merci !

Cinquième étape: afficher la liste des commandes

Pour afficher la liste des commandes PM disponibles (certaines sont activées en fonction des fichiers contenus dans votre projet et des outils que vous utilisez, comme svn et phpunit par exemple), exécutez depuis la racine de votre projet :

$ pm -h

PM v0.1.3.4 par PHPPRO http://github.com/phppro/pm

Syntaxe : pm [<options-communes>] <action> [arg1] [arg2] [...] [options]

Listes des options communes disponibles :

 -d <cle>=<valeur>        modifie une directive INI de PHP
 -h [<action>|<prefixe>]  affiche cette aide ou l'aide de l'action specifiee
 -l=<langue>              modifie la langue d'affichage (en-us*, fr-fr, ...)
 -o                       active le mode debug
 -s                       liste tous les pre-reglages charges
 -v                       affiche la version de PM
 -i                       active le mode interactif
 -u                       mets a jour a la derniere version de PM

Liste des actions disponibles :

 new      cree une nouvelle action/commande personnalisee

 pkg      cree un paquet contenant le code source du projet (format par defaut: phar)
 publish  publie le code source du projet ou le paquet specifie sur la cible distante specifiee

 tpl      utilise un modele pour generer une arborescence de fichiers
 tpl:new  cree un nouveau modele d'arborescence vide


Pour afficher l'aide : "pm -h [<action|prefixe>]"

Un bug ? une fonctionnalite ? http://github.com/phppro/pm, merci !

La liste des commandes qui s'affichent pour vous peut être légèrement différente car PM tente de détecter la présence de certains fichiers dans votre projet (.project par exemple ou .svn) ou bien la présence de certains exécutables dans le PATH système (comme phpunit) pour vous ajouter éventuellement des commandes supplémentaires.

Vous pouvez maintenant commencer à utiliser pleinement PM !

Je vous invite à parcourir le document de présentation de PM accessible sur SlideShare, vous pourrez notamment y découvrir les principales commandes, que je décrirais prochainement sur le blog.

Alors, tout s'est bien passé ? ;)

Vos idées / remarques / critiques sont bien entendus les bienvenus directement sur http://github.com/phppro/pm/issues

Compiler PHP 5.3.x sous linux

Olivier Hoareau — Tue, 19 Apr 2011 18:10:00 +0100

Pour les besoins d'un futur billet sur ce blog, je décris ici un exemple de méthode de compilation de PHP sous Linux Ubuntu 10.04 LTS (64 Bits). La méthode reste la même dans les grandes lignes sur l'ensemble des distributions modernes, vous aurez peut être à personnaliser quelques dépendances de paquets par ci par là.

(Attention: l'opération "make" peut prendre plusieurs minutes à plusieurs dizaines de minutes en fonction de la capacité de votre machine)

$ cd ~
$ mkdir test-compilation
$ cd test-compilation
$ wget 'http://fr.php.net/distributions/php-5.3.6.tar.bz2'
$ tar xjvf php-5.3.6.tar.bz2 > /dev/null
$ cd php-5.3.6/
$ sudo apt-get install libc-dev libxml2-dev libmcrypt-dev gcc
$ ./configure --disable-cgi --enable-mbstring --with-mcrypt
$ make clean
$ make

Si aucune erreur de compilation n'est survenue, vous devriez avoir votre exécutable dans :

sapi/cli/php

Pour tester votre nouvel exécutable :

$ ./sapi/cli/php -c ./php.ini-development -v

PHP 5.3.6 (cli) (built: Apr 19 2011 18:53:16)
Copyright (c) 1997-2011 The PHP Group
Zend Engine v2.3.0, Copyright (c) 1998-2011 Zend Technologies

Vous pouvez maintenant créer un script shell pour accéder rapidement a votre exécutable :

$ mkdir -p ~/bin
$ vi ~/bin/php-5.3

#!/bin/sh

~/test-compilation/php-5.3.6/sapi/cli/php -c ~/test-compilation/php-5.3.6/php.ini-development $*

$ chmod u+x ~/bin/php-5.3
$ source ~/.profile

Testez maintenant votre script :

$ php-5.3 -v


PHP 5.3.6 (cli) (built: Apr 19 2011 18:53:16)
Copyright (c) 1997-2011 The PHP Group
Zend Engine v2.3.0, Copyright (c) 1998-2011 Zend Technologies

Vous pouvez maintenant utiliser votre exécutable *php-5.3* en ligne de commande

Bien sûr il s'agit d'une procédure minimaliste de compilation de PHP, l'objectif étant d'avoir le strict nécessaire pour avoir PHP exécutable en ligne de commande en version 5.3, sans désinstaller la version actuelle de PHP

PM : Développeurs, augmentez votre productivité !

Olivier Hoareau — Wed, 13 Apr 2011 22:39:00 +0100

Ce soir, lors de la première séance du PHP User Group Bordeaux, j'ai présenté mon nouvel outil en ligne de commande pour augmenter la productivité au quotidien : PM. Voici la slides de ma présentation, vos commentaires sont les bienvenus !

PM : code faster

View more presentations from PHPPRO

Complémentarité PHPUnderControl / Phing

Olivier Hoareau — Sun, 28 Feb 2010 22:56:00 +0000

Suite à une demande d'un internaute, j'explique la complémentarité entre PHPUnderControl et Phing

PHPUnderControl

PHPUnderControl est un version adaptée pour PHP de l'outil open source CruiseControl qui est un logiciel serveur d'intégration continue développé en Java et initiallement pour la technologie Java (i.e. pour gérer des projets écrit en Java).
L'adaptation de PHPUnderControl consiste en la mise à disposition d'une IHM un peu plus contextualisée pour PHP avec des graphiques de métriques qualité récupérés depuis les outils disponibles avec PHP (phpunit notamment).

Le principe de ce type de logiciel est de détecter des modifications dans un dépôt de code distant (par exemple un serveur Subversion - SVN) et de déclencher une commande suite à cette détection de modification. Il s'agit donc d'un espèce de méga-ordonnanceur qui est bête et méchant et ne sait finalement que "déclencher" des commandes sur des "stimuli" prédéfinis (i.e. la détection d'un commit sur SVN).

Phing

Phing est un port du logiciel Ant qui provient du monde Java. Ant est un outil pour écrire des scripts batchs en XML, les rendant ainsi multi-plateformes. Il n'est plus nécessaire de se soucier du format .bat de windows ou .sh des linux-like, les commandes sont écrites en XML : on dispose par exemple de balises mkdir, copy, tar... et il est possible de créer ses propres balises de commande (task) voir ses propres séquences de commandes (target).
Phing est l'implémentation full-PHP de Ant, c'est à dire qu'il suit le même principe, met à disposition globalement les mêmes commandes selon la même syntaxe, mais l'implémentation est réalisée en PHP et est extensible en PHP. Il se base sur l'écriture d'un fichier de commandes nommés build.xml qu'il est coutume de mettre à la racine de votre projet (à subversionner) et qui doit contenir l'ensemble des commandes dont vous avez besoin pour gérer le code de votre projet (lancer les tests, packager le code, déployer le code, qualifier le code...)

PHPUnderControl + Phing et non PHPUnderControl = Phing

Phing est donc un moyen de décrire la ou les commandes à exécuter suite à un stimuli détecter par PHPUnderControl. PHPUnderControl est "compatible" phing en standard ce qui permet de décrire/configurer facilement l'exécution de commande phing dans le fichier de configuration de PHPUnderControl (config.xml). Cependant, même si cette intégration n'existait pas, l'exécution d'une commande phing consiste en faite en l'exécution de la commande shell phing suivi des quelques paramètres, ce qui permet d'intégrer cet outils avec n'importe quel logiciel ordonnanceur, même les tâches planifiées windows.

PHPUnderControl et Phing sont donc complémentaires mais indépendant et autonomes.

Bien sûr il est possible de remplacer PHPUnderControl par un autre logiciel du même type (Hudson, Xinc, Continuum, ...), ainsi que Phing (makefile, shell script, script bat, ...)

Pour obtenir plus de documentation, voici quelques liens :

PHPUnderControl : http://phpundercontrol.sourceforge.net
Phing : http://phing.info
CruiseControl : http://www.cruisecontrol.net
PHPUnit : http://www.phpunit.de

Avez-vous des questions complémentaires ou des remarques ?
Et vous, comment utilisez vous PHPUnderControl et Phing ? Avez-vous des exemples de build.xml que vous utilisez régulièrement ?

SimpleTest, installation via mon PEAR

Olivier Hoareau — Thu, 25 Feb 2010 17:18:00 +0000

Pour les besoins de l'AFUP, je dois me mettre un peu à SimpleTest (j'ai plus l'habitude sur PHPUnit). Je n'ai pas trouvé de channel PEAR (a priori) fournissant un package installable via PEAR de SimpleTest et fournissant l'outil en ligne de commande (comme peux le proposer PHPUnit ou d'autres outils). Je vous propose donc celui de mon cru...

Grâce à un de mes outils de packaging compatible PEAR, j'ai packagé la version 1.0.1 de SimpleTest pour un faire un package PEAR valide et installable via mon channel :

$ pear channel-discover pear.phppro.fr
$ pear upgrade phppro/simpletest

ou un téléchargement puis une installation locale :

$ wget http://pear.phppro.fr/get/simpletest-1.0.1.tgz
$ pear upgrade simpletest-1.0.1.tgz

Puis pour l'utilisation :

$ cd myproject
$ simpletest my_simpletest_test.php

Pour l'implémentation de tests SimpleTest, je vous laisse bien entendu faire un tour sur le site officiel : http://www.simpletest.org

Dès qu'un channel / package officiel apparaît (ou que quelqu'un m'indique l'adresse) je supprimerai le mien ;)

Et vous comment faisiez vous pour installer SimpleTest ?

Capitaliser, Améliorer et Rationnaliser les développements PHP en interne

Olivier Hoareau — Sun, 21 Feb 2010 17:36:00 +0000

Je vous livre ici un document de travail anonymisé sur la présentation d'un outil que je développe pour un client pour cadrer les pratiques de développements, ainsi que les enjeux et la démarche à adopter en interne.

20100221 my phingtool - blog

View more presentations from PHPPRO.

Analyse de dépendances classes/fichiers

Olivier Hoareau — Sun, 25 Oct 2009 11:48:00 +0000

Dans mon précédent post sur "Zend Framework 1.8.3 demystified, Act I", je vous avais livré un schéma de dépendances entre packages générés grâce à un de mes outils... Je vous livre maintenant l'outils.

WDependency est un outil réalisé en PHP et utilisant le programme GraphViz/Dot pour générer des graphes de dépendances entre classes , fichiers, projets, packages...

Installation

pear channel-discover pear.phppro.fr
pear install --alldeps phppro/wdependency

(Un package requis nommé 'WFramework' sera aussi installé, il s'agit d'un framework d'abstraction que je développe avec mes conventions pour illustrer des pratiques / conventions chez mes clients)

Vérifiez que l'installation c'est bien passée :

wdependency

(Vous devriez voir l'aide repris ci-dessous)

Il est ensuite nécessaire d'installer GraphViz/Dot (le binaire 'dot' doit être accessible en ligne de commande)
Vous pouvez vérifiez si il est installé sur votre poste :

wdependency :check-dot-support

Si la version de dot ne s'affiche pas, c'est que vous devez l'installer, rendez-vous sur http://www.graphviz.org rubrique downloads, téléchargez et installez l'outil dot.
Une fois installé, re-vérifiez que wdependency est bien cablé avec dot en relançant un :

wdependency :check-dot-support

Ensuite pour utiliser l'outil :

cd my-source-directory
wdependency :help

Vous obtiendrez l'aide de l'outil ci-dessous :


 ***** [Syntax] ***************************************************************

   $ wdependency [commands] [options] [<directory>[,<directory>,...]]

 ***** [Available commands] ***************************************************

   use: :<command> , ':' is required

   :help                  display this help
   :instances             computes the instances (use of new operator) dependencies
   :cache                 parses directory content and caches result in all.php for further use
   :clean-cache           cleans existing cache file
   :often-used            top rank node that heavily depend on others
   :classes               computes the classes dependencies (children => mother)
   :package0-inheritances  computes the classes inheritances reduced to first package level
   :package1              computes the classes dependencies reduced to second package level
   :inheritances          computes the inheritances dependencies
   :includes              computes the includes dependencies
   :packages              computes the packages dependencies
   :dependent-nodes       list all mostly dependent nodes (top ranked)
   :check-dot-support     display the version of dot binary if available (required for dot/picture export)
   :popo                  list Plain Old PHP Objects (no extends / no implements)
   :supers                computes the hierarchy dependency (mother => children)
   :testcases             list all classes that extends PHPUnit_Framework_TestCase
   :untestedpackages      list all packages that does not contain phpunit test cases
   :testedpackages        list all packages that contains phpunit test cases
   :hubs                  list all classes that are very used by others
   :self-dependent        list all classes that are self-dependent (depend on themself)
   :dependent             list all classes that are dependent to others (more than 4 links to the same)
   :very-dependent        list all classes that are very dependent to others (more than 10 links to the same)
   :extra-dependent       list all classes that are extra dependent to others (more than 20 links to the same)
   :describe-X            display content of specific interface, where X is:
         * listener     for displaying W_Dependency_Listener_Interface
         * exporter     for displaying W_Dependency_Exporter_Interface
         * analyzer     for displaying W_Dependency_Analyzer_Interface
         * filter       for displaying W_Dependency_Filter_Interface
         * aggregator   for displaying W_Dependency_Aggregator_Interface
         * source       for displaying W_Dependency_Source_Interface
         * action       for displaying W_Dependency_Action_Interface

 ***** [Available options] ****************************************************

   use: -<option> , no value (no '=...')

   -v      verbose mode, debug information logged in ./wdependency.log
   -h      display this help
   -c      activate/use cache file for parsing optimization (generate/use ./wdependency.cache file)
   -cc     clean existing cache file

   use: --<option>=<value> , no default value, '=<value>' is required

   --action      load custom action(s) (list separator: ,), specified by class name
   --aggregator  load custom aggregator(s) (list separator: ,), specified by class name
   --analyzer    load custom analyzer(s) (list separator: ,), specified by class name
   --bottom      keep only nodes that are in the specified bottom rank (top X) when computing weight from links
   --by          aggregate nodes using the specified algorithm:
         * dir          aggregate by directories (dirname on / of node)
         * package      aggregate by package (dirname on _ of node)
         * package#X    aggregate by package at position X
         * dir#X        aggregate by directory at position X
   --class       keep only nodes that are used by specified class
   --dir         keep only nodes that are used by file in specified directory
   --exporter    load custom exporter(s) (list separator: ,), specified by class name
   --file        keep only nodes that are used by specified file
   --filter      load custom filter(s) (list separator: ,), specified by class name
   --format      list of export format:
         * png          PNG picture file
         * jpg          JPG picture file
         * gif          GIF picture file
         * dot          GraphViz DOT text format
         * graphml      GraphML xml format
         * json         JavaScript Object Notation text format
         * php          PHP file (return array(...);)
         * svg          Scalable Vector Graphics picture format (xml)
   --has         keep only nodes that have links
   --layout      graphviz (dot) layout to use, by default 'dot', type dot -K? to see available list
   --link        keep only nodes that have link to specified node
   --linked-to   keep only links to specified dependency
   --listener    load custom listener(s) (list separator: ,), specified by class name
   --load        loads the specified file as a data source (from previous analyzes, PHP format supported only)
   --max         keep only nodes that have a maximum of links specified
   --max-link-weight  keep only links that have less than specified weight
   --min         keep only nodes that have at least the minimum links specified
   --min-link-weight  keep only links that have more than specified weight
   --n           keep only nodes that have number of nodes specified
   --node        keep only nodes that are used by specified node
   --nolink      keep only nodes that have not link to specified node
   --none        keep only nodes that have no links
   --package     keep only nodes that are used by class in specified package
   --pattern     keep only nodes that have name matching specified pattern
   --prefix      keep only nodes that have name beginning with specified prefix
   --reverse     reverse link order (user become used and used become user)
   --source      load custom source(s) (list separator: ,), specified by class name
   --subdirs-as-projects  use subdirectories as autonomous projects
   --template    php file template to render export (file exporter only), use $options and $data
   --top         keep only nodes that are in the specified top rank (top X) when computing weight from links

 ***** [Additional information] ***********************************************

   * additional options could be available dependending on the renderer
     template (i.e. phtml view file if used)

   * for schema / graph export in dot, png, jpg, ... you must have the
     graphviz binaries installed (dot binary)

 ***** [Software information] *************************************************

   wdependency v0.0.7, built on 2009-10-25
   Under BSD License, Olivier Hoareau <olivier a t phppro.fr> - PHPPRO

   PEAR package

Le principe est simple :

vous vous positionnez dans le répertoire racine à analyser
vous indiquez l'action a effectuer et le format d'export voulu
vous indiquez éventuellement les "filtres / tri" et les "aggrégations" voulues
vous lancez wdependency avec tous ces paramètres
wdependency va analyser chaque fichier PHP de répertoires du répertoire courant (récursif)
il va construire un modèle de donnée en mémoire pour réprésenter les dépendances
il va trier/filtrer les données
il va exporter en jpg/png/... (i.e. le(s) format(s) que vous avez choisis)

Exemples

Vous pourrez ensuite générer le graphiques de dépendances entre vos répertoires de second niveau par exemple grâce à la commande :

wdependency :package1

un fichier png devrait apparaître dans le répertoire courant

Ou bien générer le graphe d'héritage de vos classes :

wdependency :inheritances

Le graphe d'héritage d'une classe en particulier :

wdependency :inheritances --node=MyPackage_MyClass

...

Mise en cache du parsing pour aller plus vite

Il est possible de parser une fois et de mettre en cache le modèle de données résultant pour ensuite faire plusieurs "requêtes" sans devoir tout reparser à chaque fois :

Commencez par vider le cache et regénérer le fichier de cache (./wdependency.cache):

wdependency -cc
wdependency :cache

Puis exécutez n'importe laquelle des commandes comme d'habitude, vous verrez c'est plus rapide ;)

Bien sûr il s'agit d'une version alpha certainement buggée, merci par avance pour vos retours sur le gestionnaire d'issues : http://code.google.com/p/wdependency/issues/list

Bon usage !

Zend Framework demystified, act I...

Olivier Hoareau — Sun, 18 Oct 2009 18:48:00 +0100

Voici une vue des dépendances entre package dans Zend Framework 1.8.3 réalisé avec un de mes outils d'analyse de code.

Je travaille actuellement sur l'analyse des dépendances entre classes, packages, applications / frameworks pour notamment cartographier les zones mortes des applis (i.e. code non utilisé), les zones de complexité ou de dette technique (i.e. point central ayant beaucoup de liaison...).
Après plusieurs heures de recherches d'une librairie de visualisation temps réel sur un graphe, je n'ai toujours pas trouvé mon bonheur pour parcourir en temps réel le graphe, je vous livre donc pour l'instant ma version graphviz (dot)

Avez-vous d'autres techniques pour représenter les dépendances classes/applications/frameworks ?

PS: le noeud ROOT correspond aux classes située à la racine du répertoire library/Zend, les autres noeuds correspondent aux répertoires situés dans library/Zend/

Intégration PHPUnit dans Eclipse

Olivier Hoareau — Wed, 08 Jul 2009 23:18:00 +0100

Une nouvelle intégration de PHPUnit 3.x dans Eclipse à la mode JUnit

J'utilise Zend Studio et Eclipse PDT au quotidien chez mes clients.
Adepte du TDD (Test Driven Development), le support de PHPUnit dans Zend Studio est devenu plus qu'un confort pour moi, une véritable nécessité.
Pour mes clients qui choisissent Eclipse PDT plutôt que Zend Studio, j'étais jusqu'alors résigné à créer des boutons external tools dans Eclipse pour lancer en ligne de commande phpunit (efficace, mais rendu non graphique en mode console qui peut rebuter certains).
Sur ma demande d'aide, un de mes anciens collègues, Java-iste dans l'âme, et PHP-iste à ses heures perdues, a développé une intégration de PHPUnit 3.x dans Eclipse en open source. Il s'agit d'un wrapper au plugin JUnit 4 existant dans Eclipse JDT permettant de lancer les tests unitaires PHPUnit (via la ligne de commande en fait) et d'afficher les résultats tel que JUnit le fait (et tel que le plugin PHPUnit de Zend Studio le fait). Bien sûr il s'agit d'un premier jet, vos idées / remarques / demandes d'amélioration sont les bienvenues !

Sans plus attendre le site du projet open source : http://code.google.com/p/phpunit4eclipse/wiki/j2phpUnitWrapper

Exemple de fichier build.xml pour un projet utilisant l'intégration continue

Olivier Hoareau — Fri, 05 Jun 2009 16:08:00 +0100

Vous utiliser PHP, Phing et vous souhaitez utiliser hudson, Xinc ou PHPUnderControl avec Phing

Voici un fichier build.xml qui me sert souvent de base pour automatiser mes builds php en intégration continue. Il n'est pas parfait, n'hésitez pas à proposer des améliorations ou proposer vos variantes / exemples, ils sont les bienvenus !

<?xml version="1.0" encoding="UTF-8"?>

<!-- vim: set expandtab tabstop=4 shiftwidth=4: -->

<project name="php" default="help">

    <!-- ================================================================== -->
    <!-- Properties                                                         -->
    <!-- ================================================================== -->
    
    <!-- *** Project General Properties *********************************** -->

    <property name="home"         value="${project.basedir}"/>
    <property name="src.dir"      value="library"/>
    <property name="test.dir"     value="tests"/>
    <property name="report.dir"   value="reports"/>
    <property name="doc.dir"      value="docs"/>
    <property name="context.dir"  value="contexts"/>
    <property name="config.dir"   value="config"/>
    <property name="convention"   value="PEAR"/>

    <!-- *** Project Custom Properties ************************************ -->

    <property file="${home}/${config.dir}/build.properties"   override="true"/>
    <property file="${home}/${config.dir}/${conf}.properties" override="true"/>

    <!-- *** Project Common Properties ************************************ -->

    <property name="package.name"   value="${application.name}"/>

    <!-- ================================================================== -->
    <!-- Targets                                                            -->
    <!-- ================================================================== -->

    <!-- *** $ phing help ************************************************* -->

    <target name        = "help"
            depends     = ""
            description = "Information about this build file">

        <echo>${package.name} Phing Build commands</echo>

    </target>

    <!-- *** $ phing inits ************************************************ -->

    <target name        = "inits"
            depends     = ""
            description = "Initializes the application environment">

        <!-- /library -->
        <mkdir dir="${home}/${src.dir}"/>

        <!-- /tests -->
        <mkdir dir="${home}/${test.dir}"/>
        <mkdir dir="${home}/${test.dir}/phpunit"/>
        <mkdir dir="${home}/${test.dir}/fitnesse"/>
        <mkdir dir="${home}/${test.dir}/selenium"/>
        <mkdir dir="${home}/${test.dir}/jsunit"/>

        <!-- /reports -->
        <mkdir dir="${home}/${report.dir}"/>
        <mkdir dir="${home}/${report.dir}/phpunit"/>
        <mkdir dir="${home}/${report.dir}/coverage"/>
        <mkdir dir="${home}/${report.dir}/codesniffer"/>

        <!-- /docs -->
        <mkdir dir="${home}/${doc.dir}"/>
        <mkdir dir="${home}/${doc.dir}/api"/>

        <!-- /contexts -->
        <mkdir dir="${home}/${context.dir}"/>

    </target>

    <!-- *** $ phing tests-unit ******************************************* -->

    <target name        = "tests-unit"
            depends     = "inits"
            description = "Executes unit tests (PHPUnit)">

        <php expression="require_once '${home}/${context.dir}/phpunit.php'"/>

        <phpunit2 haltonfailure="false" printsummary="true">
            <batchtest classpath="${home}/${src.dir}">
                <fileset dir="${home}">
                    <include name="${test.dir}/phpunit/**/*Test.php" />
                </fileset>
            </batchtest>
            <formatter type    = "xml"
                       todir   = "${home}/${report.dir}/phpunit"
                       outfile = "tests-report.xml" />
        </phpunit2>

        <phpunit2report
            infile = "${home}/${report.dir}/phpunit/tests-report.xml"
            format = "frames"
            todir  = "${home}/${report.dir}/phpunit" />

    </target>

    <!-- *** $ phing tests-unit-with-coverage ***************************** -->

    <target name        = "tests-unit-with-coverage"
            depends     = "inits"
            description = "Executes unit tests (PHPUnit), coverage (XDebug)">

        <php expression="require_once '${home}/${context.dir}/phpunit.php'"/>

        <coverage-setup database="${home}/${report.dir}/coverage/coverage.db">
            <fileset dir="${home}">
                <include name="${src.dir}/**/*.php" />
                <exclude name="${src.dir}/**/*Test.php" />
            </fileset>
        </coverage-setup>

        <phpunit2 haltonfailure = "false"
                  printsummary  = "true"
                  codecoverage  = "true">
            <batchtest classpath="${home}/${src.dir}">
                <fileset dir="${home}">
                    <include name="${test.dir}/**/*Test.php" />
                </fileset>
            </batchtest>
            <formatter type    = "xml"
                       todir   = "${home}/${report.dir}/phpunit"
                       outfile = "tests-report.xml" />
        </phpunit2>

        <coverage-report outfile="${home}/${report.dir}/coverage/coverage.db">
            <report todir="${home}/${report.dir}/coverage" />
        </coverage-report>

        <phpunit2report
            infile = "${home}/${report.dir}/phpunit/tests-report.xml"
            format = "frames"
            todir  = "${home}/${report.dir}/phpunit" />

    </target>

    <!-- *** $ phing tests-functional ************************************* -->

    <target name        = "tests-functional"
            depends     = "inits"
            description = "Executes functional tests (Fitnesse)">


    </target>

    <!-- *** $ phing tests-javascript ************************************* -->

    <target name        = "tests-javascript"
            depends     = "inits"
            description = "Executes javascript tests (JSUnit)">


    </target>

    <!-- *** $ phing tests-gui ******************************************** -->

    <target name        = "tests-gui"
            depends     = "inits"
            description = "Executes graphical user interface tests (Selenium)">


    </target>

    <!-- *** $ phing tests ************************************************ -->

    <target name        = "tests"
            depends     = "tests-unit-with-coverage,tests-functional,tests-javascript,tests-gui"
            description = "Generates all tests reports for project">



    </target>

    <!-- *** $ phing checks-convention ************************************ -->

    <target name        = "checks-convention"
            depends     = "inits"
            description = "Checks the quality of the code towards convention">
            
        <php expression="$cwd = getcwd()" returnProperty="cwd"/>

        <phpcs  outputFile   = "${home}/${report.dir}/codesniffer/checks-report.xml"
                standard     = "${convention}"
                showWarnings = "true"
                tabWidth     = "4"
                format       = "checkstyle">
                <fileset dir="${home}/${src.dir}">
                <include name="**/*.php" />
                <include name="**/*.phtml" />
            </fileset>
        </phpcs>

        <php expression="chdir('${cwd}')"/>
        
        <xslt file   = "${home}/${report.dir}/codesniffer/checks-report.xml"
              tofile = "${home}/${report.dir}/codesniffer/index.html"
              style  = "${home}/${config.dir}/codesniffer.xsl" />

    </target>

    <!-- *** $ phing checks-syntax **************************************** -->

    <target name        = "checks-syntax"
            depends     = "inits"
            description = "Checks the syntax of the code (Lint)">

        <phplint haltonfailure="true">
            <fileset dir="${home}">
                <include name="${src.dir}/**/*.php"/>
                <include name="${src.dir}/**/*.phtml"/>
            </fileset>
        </phplint>

    </target>

    <!-- *** $ phing checks *********************************************** -->

    <target name        = "checks"
            depends     = "checks-convention,checks-syntax"
            description = "Executes checking operations (convention,syntax)">



    </target>

    <!-- *** $ phing builds-on-commit ************************************* -->

    <target name        = "builds-on-commit"
            depends     = "tests-unit"
            description = "Continous integration Light-build on svn commit">



    </target>

    <!-- *** $ phing builds-nightly *************************************** -->

    <target name        = "builds-nightly"
            depends     = "tests,checks,docs"
            description = "Continuous integration full nightly-build">



    </target>

    <!-- *** $ phing docs-api ********************************************* -->

    <target name        = "docs-api"
            depends     = "inits"
            description = "Generates the PHPDocumentor API Documentation">

        <phpdoc title               = "${package.name} API Documentation"
                destdir             = "${home}/${doc.dir}/api"
                sourcecode          = "yes"
                output              = "HTML:Smarty:PHP"
                defaultcategoryname = "${package.name}"
                defaultpackagename  = "${package.name}">
            <fileset dir="${home}">
                <include name="${src.dir}/**" />
                <include name="${test.dir}/phpunit/**" />
                <include name="${test.dir}/fitnesse/**" />
            </fileset>
            <projdocfileset dir="${home}/${src.dir}">
            </projdocfileset>
        </phpdoc>

    </target>

    <!-- *** $ phing docs ************************************************* -->

    <target name        = "docs"
            depends     = "docs-api"
            description = "Generates all documentation for project">



    </target>
    
    <!-- *** $ phing deploys-testfunc ************************************* -->

    <target name        = "deploys-testfunc"
            depends     = "tests-unit"
            description = "Executes unit tests and deploys a tag of the application on functional tests platform">

        <echo>Deploying on functional tests platform...</echo>

        <echo>@todo: specific function tests platform pre-deployment tasks...</echo>

        <phingcall target="_template-deploys">
            <property name="${deploy.platform}" value="testfunc"/>
        </phingcall>
        
        <echo>@todo: specific functional tests platform post-deployment tasks...</echo>

        <echo>Application deployed on functional tests platform.</echo>

    </target>

    <!-- *** $ phing deploys-integ **************************************** -->

    <target name        = "deploys-integ"
            depends     = "tests-unit"
            description = "Executes unit tests and deploys a tag of the application on integration">

        <echo>Deploying on integration...</echo>

        <echo>@todo: specific integration pre-deployment tasks...</echo>

        <phingcall target="_template-deploys">
            <property name="${deploy.platform}" value="integ"/>
        </phingcall>
        
        <echo>@todo: specific integration post-deployment tasks...</echo>

        <echo>Application deployed on integration.</echo>

    </target>

    <!-- *** $ phing deploys-preprod ************************************** -->

    <target name        = "deploys-preprod"
            depends     = "tests-unit"
            description = "Executes unit tests and deploys a tag of the application on pre-production">

        <echo>Deploying on preproduction...</echo>

        <echo>@todo: specific preproduction pre-deployment tasks...</echo>

        <phingcall target="_template-deploys">
            <property name="${deploy.platform}" value="preprod"/>
        </phingcall>

        <echo>@todo: specific preproduction post-deployment tasks...</echo>

        <echo>Application deployed on preproduction.</echo>

    </target>

    <!-- *** $ phing deploys-prod ***************************************** -->

    <target name        = "deploys-prod"
            depends     = "tests-unit"
            description = "Executes unit tests and deploys a tag of the application on production">

        <echo>Deploying on production...</echo>

        <echo>@todo: specific production pre-deployment tasks...</echo>

        <phingcall target="_template-deploys">
            <property name="${deploy.platform}" value="prod"/>
        </phingcall>
        
        <echo>@todo: specific production post-deployment tasks...</echo>

        <echo>Application deployed on production.</echo>

    </target>

    <!-- *** internal task ************************************************ -->

    <target name        = "_template-deploys"
            depends     = "tests-unit"
            description = "Template - Executes unit tests and deploys a tag of the application on a platform">

        <if>
            <isnotset property="deploy.platform"/>
            <then>
                <fail>You must set the deploy.platform property with the name of the platform to deploy on</fail>
            </then>
        </if>

        <if>
            <isnotset property="tag"/>
            <then>
                <fail>You must provide a svn tag in order to deploy this tag on ${deploy.platform}</fail>
            </then>
        </if>

        <property file="${home}/${config.dir}/platforms/${deploy.platform}.properties" override="true" />

        <property name="deploy.src.dir" value="${home}/${build.dir}/${deploy.platform}/${tag}" />
        <property name="svn.url"        value="${svn.repo}/tags/${tag}" />

        <svnexport svnpath       = "${svn.bin}"
                   username      = "${svn.username}"
                   password      = "${svn.password}"
                   force         = "true"
                   nocache       = "true"
                   repositoryurl = "${svn.url}"
                   todir         = "${deploy.src.dir}"/>
        
        <echo>@todo : deployment (zip ${deploy.src.dir, then ftp, ...) </echo>

        <fail>@remove: Not yet implemented</fail>

    </target>

</project>

LivePHP.net : tester les différentes versions de PHP !

Olivier Hoareau — Mon, 18 May 2009 08:00:00 +0100

PHP.net est notre référence à tous pour trouver LA documentation sur PHP. Mais si vous êtes comme moi, vous êtes peut être souvent confronté à plusieurs versions de PHP sur vos projets ou chez vos clients. Comment être sûr qu'une fonction PHP se comporte de la même façon dans une version plus ancienne que la doc PHP.net ? suivez le guide ;)

Voici un nouveau service en ligne qui vous permettra de tester une bonne partie (toutes les fonctions ne sont pas couvertes, pour raisons de sécurité ;)) des fonctions PHP sous forme d'une API Web services (format XML, json...).

Le principe est simple vous pouvez récupérer le résultat d'une fonction php en appelant l'url :

http://livephp.net/functions/<nom-de-la-fonction>/<param1>/<param2>/....?format=<format>&version=<liste-des-versions-php>

Voici quelques exemples :

Liste des services disponibles

http://livephp.net

<?xml version="1.0" encoding="UTF-8" ?>

<response>
	<code>200</code>
	<message>success</message>
	<results>
		<service id="http://livephp.net/functions">array (
  0 => 'Call http://livephp.net/functions to get the list of available function for specified PHP version (version= parameter, or default PHP version)',
  1 => 'Call http://livephp.net/functions/[function_name]/[arg1]/[arg2]/... to call function_name(arg1,arg2,...) and get the result back',
  2 => 'You can use parameters : format=[format], version=[version], reference=[version,version,...|all]',
)</service>
		<service id="http://livephp.net/formats">Call http://livephp.net/formats to get the list of available formats to use with the 'format=' parameter</service>

		<service id="http://livephp.net/versions">Call http://livephp.net/versions to get the list of available PHP versions with the 'version=' parameter</service>
	</results>
</response>

Liste des versions disponibles

http://livephp.net/versions

<?xml version="1.0" encoding="UTF-8" ?>

<response>
	<code>200</code>
	<message>success</message>
	<results>
		<version>4.4.9</version>
		<version>5.0.5</version>

		<version>5.1.0</version>
		<version>5.1.6</version>
		<version>5.2.0</version>
		<version>5.2.1</version>
		<version>5.2.2</version>
		<version>5.2.3</version>

		<version>5.2.4</version>
		<version>5.2.5</version>
		<version>5.2.6</version>
		<version>5.2.8</version>
		<version>5.2.9</version>
		<version>5.3-dev</version>

		<version>6.0-dev</version>
	</results>
</response>

Liste des formats disponibles

http://livephp.net/formats

<?xml version="1.0" encoding="UTF-8" ?>

<response>
	<code>200</code>
	<message>success</message>
	<results>
		<format>xml</format>
		<format>json</format>

		<format>php</format>
		<format>js</format>
		<format>raw</format>
		<format>csv</format>
	</results>
</response>

Liste des fonctions disponibles pour la dernière release stable de PHP

http://livephp.net/functions

<?xml version="1.0" encoding="UTF-8" ?>

<response>
	<code>200</code>
	<message>success</message>
	<results>
		<return version="5.2.9" duration="0.00588488578796">array (
  'internal' => 
  array (
    0 => 'zend_version',
    1 => 'func_num_args',
    2 => 'func_get_arg',
    3 => 'func_get_args',
    4 => 'strlen',
    5 => 'strcmp',
    6 => 'strncmp',
    7 => 'strcasecmp',
    ...
  ),
  'user' => 
  array (
  ),
)</return>
	</results>
</response>

Ex: substr('test',0,3) => 'tes'

http://livephp.net/functions/substr/test/0/3?version=all&format=csv

type,value,version,duration
return,tes,4.4.9,0.0035560131073
return,tes,5.0.5,0.00384306907654
return,tes,5.1.0,0.00425505638123
return,tes,5.1.6,0.00440287590027
return,tes,5.2.0,0.00467205047607
return,tes,5.2.1,0.0046968460083
return,tes,5.2.2,0.00472688674927
return,tes,5.2.3,0.00475788116455
return,tes,5.2.4,0.00470304489136
return,tes,5.2.5,0.00474095344543
return,tes,5.2.6,0.00479793548584
return,tes,5.2.8,0.00478100776672
return,tes,5.2.9,0.00476813316345
return,tes,5.3-dev,0.00529599189758
return,tes,6.0-dev,0.00888299942017

Ex: array_merge(array(1,2,3),1) => comportement différent entre PHP 4 et PHP 5

http://livephp.net/functions/array_merge/[1,2,3]/1?version=all

<?xml version="1.0" encoding="UTF-8" ?>

<response>
	<code>200</code>
	<message>success</message>
	<results>
		<return version="4.4.9" duration="0.00359106063843">array (
  0 => 1,
  1 => 2,
  2 => 3,
  3 => '1',
)</return>
		<return version="5.0.5" duration="0.00379920005798">false</return>

		<return version="5.1.0" duration="0.00418400764465">false</return>
		<return version="5.1.6" duration="0.00437688827515">false</return>
		<return version="5.2.0" duration="0.00474405288696">false</return>
		<return version="5.2.1" duration="0.00470590591431">false</return>
		<return version="5.2.2" duration="0.004723072052">false</return>
		<return version="5.2.3" duration="0.00476813316345">false</return>

		<return version="5.2.4" duration="0.00476694107056">false</return>
		<return version="5.2.5" duration="0.00478100776672">false</return>
		<return version="5.2.6" duration="0.00486397743225">false</return>
		<return version="5.2.8" duration="0.00476217269897">false</return>
		<return version="5.2.9" duration="0.0047550201416">false</return>
		<return version="5.3-dev" duration="0.00532984733582">false</return>

		<return version="6.0-dev" duration="0.00882506370544">false</return>
	</results>
</response>

md5() non dispo dans PHP 6 (pour l'instant ?)

http://livephp.net/functions/md5/aaaaaaaaaaaaaga?version=6.0-dev,5.2.9&reference=5.2.9

<?xml version="1.0" encoding="UTF-8" ?>

<response>
	<code>200</code>
	<message>success</message>
	<results>
		<return version="6.0-dev" duration="0.00935697555542" regression="true">false</return>
		<return version="5.2.9" duration="0.00510597229004">a2543fd1f2af3fac6b0e273a18bbe219</return>

	</results>
</response>

Lister les numéros de versions

http://livephp.net/functions/phpversion?version=all

<?xml version="1.0" encoding="UTF-8" ?>

<response>
	<code>200</code>
	<message>success</message>
	<results>
		<return version="4.4.9" duration="0.00354194641113">4.4.9</return>
		<return version="5.0.5" duration="0.00374889373779">5.0.5</return>

		<return version="5.1.0" duration="0.00420808792114">5.1.0</return>
		<return version="5.1.6" duration="0.00435781478882">5.1.6</return>
		<return version="5.2.0" duration="0.00470304489136">5.2.0</return>
		<return version="5.2.1" duration="0.00473499298096">5.2.1</return>
		<return version="5.2.2" duration="0.00475382804871">5.2.2</return>
		<return version="5.2.3" duration="0.00475478172302">5.2.3</return>

		<return version="5.2.4" duration="0.00473499298096">5.2.4</return>
		<return version="5.2.5" duration="0.0047550201416">5.2.5</return>
		<return version="5.2.6" duration="0.004802942276">5.2.6</return>
		<return version="5.2.8" duration="0.00480198860168">5.2.8</return>
		<return version="5.2.9" duration="0.00478005409241">5.2.9</return>
		<return version="5.3-dev" duration="0.00531506538391">5.3.0RC3-dev</return>

		<return version="6.0-dev" duration="0.00883913040161">false</return>
	</results>
</response>

Récupérer la valeur de retour de la fonction au format brut

http://livephp.net/functions/substr/my-test/0/2?format=raw

my

Format CSV !

http://livephp.net/functions/ucfirst/my test?version=all&format=csv&sep=;

type;value;version;duration
return;My test;4.4.9;0.00356388092041
return;My test;5.0.5;0.00379014015198
return;My test;5.1.0;0.0042290687561
return;My test;5.1.6;0.00434899330139
return;My test;5.2.0;0.00467896461487
return;My test;5.2.1;0.00471687316895
return;My test;5.2.2;0.004723072052
return;My test;5.2.3;0.00476217269897
return;My test;5.2.4;0.00476408004761
return;My test;5.2.5;0.00472712516785
return;My test;5.2.6;0.0047709941864
return;My test;5.2.8;0.00476121902466
return;My test;5.2.9;0.00476288795471
return;My test;5.3-dev;0.00525689125061
return;My test;6.0-dev;0.00884604454041

Certaines fonctions sont désactivées

http://livephp.net/functions/exec/ls

<?xml version="1.0" encoding="UTF-8" ?>

<response>
	<code>403</code>
	<message>Function 'exec' has not been enabled</message>
	<results>
	</results>
</response>

Utilisez la notation json pour passer un argument tableau ou objet

http://livephp.net/functions/json_encode/[1,2,3]?version=all

<?xml version="1.0" encoding="UTF-8" ?>

<response>
	<code>200</code>
	<message>success</message>
	<results>
		<return version="4.4.9" duration="0.00357604026794">Error: Function 'json_encode' does not exist in PHP version '4.4.9'</return>
		<return version="5.0.5" duration="0.00391697883606">Error: Function 'json_encode' does not exist in PHP version '5.0.5'</return>

		<return version="5.1.0" duration="0.00429391860962">Error: Function 'json_encode' does not exist in PHP version '5.1.0'</return>
		<return version="5.1.6" duration="0.0044469833374">Error: Function 'json_encode' does not exist in PHP version '5.1.6'</return>
		<return version="5.2.0" duration="0.00477600097656">[1,2,3]</return>
		<return version="5.2.1" duration="0.00473999977112">[1,2,3]</return>
		<return version="5.2.2" duration="0.00473594665527">[1,2,3]</return>
		<return version="5.2.3" duration="0.00478887557983">[1,2,3]</return>

		<return version="5.2.4" duration="0.00479698181152">[1,2,3]</return>
		<return version="5.2.5" duration="0.00476408004761">[1,2,3]</return>
		<return version="5.2.6" duration="0.00474905967712">[1,2,3]</return>
		<return version="5.2.8" duration="0.00475907325745">[1,2,3]</return>
		<return version="5.2.9" duration="0.00477600097656">[1,2,3]</return>
		<return version="5.3-dev" duration="0.00535202026367">[1,2,3]</return>

		<return version="6.0-dev" duration="0.00893187522888">[1,2,3]</return>
	</results>
</response>

http://livephp.net/functions/json_decode/\[1,2,3]?version=all

<?xml version="1.0" encoding="UTF-8" ?>

<response>
	<code>200</code>
	<message>success</message>
	<results>
		<return version="4.4.9" duration="0.00359201431274">Error: Function 'json_decode' does not exist in PHP version '4.4.9'</return>
		<return version="5.0.5" duration="0.00375604629517">Error: Function 'json_decode' does not exist in PHP version '5.0.5'</return>

		<return version="5.1.0" duration="0.00430989265442">Error: Function 'json_decode' does not exist in PHP version '5.1.0'</return>
		<return version="5.1.6" duration="0.00447916984558">Error: Function 'json_decode' does not exist in PHP version '5.1.6'</return>
		<return version="5.2.0" duration="0.00474095344543">array (
  0 => 1,
  1 => 2,
  2 => 3,
)</return>
		<return version="5.2.1" duration="0.00470018386841">array (
  0 => 1,
  1 => 2,
  2 => 3,
)</return>
		<return version="5.2.2" duration="0.00474286079407">array (
  0 => 1,
  1 => 2,
  2 => 3,
)</return>
		<return version="5.2.3" duration="0.00478100776672">array (
  0 => 1,
  1 => 2,
  2 => 3,
)</return>

		<return version="5.2.4" duration="0.00489497184753">array (
  0 => 1,
  1 => 2,
  2 => 3,
)</return>
		<return version="5.2.5" duration="0.00485587120056">array (
  0 => 1,
  1 => 2,
  2 => 3,
)</return>
		<return version="5.2.6" duration="0.00483107566833">array (
  0 => 1,
  1 => 2,
  2 => 3,
)</return>
		<return version="5.2.8" duration="0.0047619342804">array (
  0 => 1,
  1 => 2,
  2 => 3,
)</return>
		<return version="5.2.9" duration="0.00485610961914">array (
  0 => 1,
  1 => 2,
  2 => 3,
)</return>
		<return version="5.3-dev" duration="0.00533699989319">array (
  0 => 1,
  1 => 2,
  2 => 3,
)</return>

		<return version="6.0-dev" duration="0.00902605056763">array (
  0 => 1,
  1 => 2,
  2 => 3,
)</return>
	</results>
</response>

A quand un tel service intégrer à la documentation en ligne de PHP.net ? ;)

Bonne utilisation

PS: vous souhaitez voir d'autres fonctionnalités ? Envoyer un email à features@livephp.net

PHP Tree Match : Vérifiez que vos arborescences projets sont standardisées !

Olivier Hoareau — Mon, 11 May 2009 18:41:00 +0100

"Et alors, mes 18 projets ont tous la même arborescence ? Ils sont tous standard (i.e. respectent "nos" standards) et sont tous "faits" de la même façon ?" Certains d'entre vous se sont déjà vus poser cette question ? Si, c'est la cas, PHP Tree Match pourra probablement vous aider...

PHP Tree Match, ou PHPTM de son petit nom, est un nouvel outil "basique" (dans la série des phpcpd, phpmd...) qui permet de vérifier que l'arborescence de votre/vos projets respectent bien une norme que vous vous donnez. Par exemple, vous avez l'habitude mettre une arborescence du type :

/
    application/
        default/
            controllers/
            models/
            views/
    config/
         application.ini
    html/
        index.php
        .htaccess
    ...

Vous devez gérer 1, 5, 10 ... projets similaires et vous voulez vérifier d'un seul coup que tous vos projets respectent bien vos conventions, que le fichier config/application.ini contient bien la section "production", que le fichier .project n'existe pas en prod...

Installation

à partir du Channel PEAR

$ pear channel-discover pear.phppro.fr
$ pear install phppro/phptm

mise à jour

$ pear upgrade phppro/phptm

à partir du package compatible PEAR en téléchargement sur Google Code

$ wget http://phptreematch.googlecode.com/files/phptm-0.1.0.tgz
$ pear install phptm-0.1.0.tgz

Usage

Avant d'utiliser phptm vous devez "décrire" votre arborescence projet dans un fichier de description au format xml. Voici un exemple :

<?xml version="1.0" encoding="UTF-8"?>
<tree>
    <item name=".project" present="false"/>
    <item name="bin/phptm.bat" hash="8c8d25cde4142e4b945792c2ca9a31cc"/>
    <item name="bin/phptm.php" hash="635f67483f575310a904c02a2068d0dd"/>
    <item name="build/package.xml" hash="ca34d98facbc5ff461976d5f18910cbe"/>
    <item name="build.xml" hash="a25ebe507f99623d266aeee4d1ed4463"/>
    <item name="config/build.properties">
        <contains>version=</contains>
        <contains>name=</contains>
    </item>
    <item name="config/package.xml"/>
    <item name="docs/README.markdown"/>
    <item name="library/PHPTM/Analyzer.php"/>
    <item name="library/PHPTM/Log/XML/XML.php"/>
    <item name="library/PHPTM/Log/XML.php"/>
    <item name="library/PHPTM/TextUI/Command.php"/>
    <item name="library/PHPTM/TextUI/Getopt.php"/>
    <item name="library/PHPTM/TextUI/ResultPrinter.php"/>
    <item name="library/PHPTM/Util/FilterIterator.php"/>
</tree>

Le fichier ci-dessus permet notamment de vérifier que certains fichier sont bien absent(present=false), que certains fichiers existent et ont un contenu précis (calculé à partir de "hash"), que certains fichiers existent et contiennent une chaîne de caractère précise ("contains", mais vous pouvez aussi utiliser "notcontains")...

Inspirez vous de l'exemple ci-dessus pour construire votre fichier de description, ou bien exécutez la commande suivante sur une arborescence type :

$ phptm --build-tree my-typical-directory > typical-tree.xml

Pour "passer" ensuite phptm sur votre application, exécutez :

$ phptm --expected-tree=typical-tree.xml my-directory

ou bien pour exporter aussi le résultat sous forme xml :

$ phptm --log-xml=phptm-report.xml --expected-tree=typical-tree.xml my-directory

Description du rapport calculé

Le rapport en ligne de commande ou bien le rapport xml vous indique alors si des erreurs de cohérences sont détectées et si oui, lesquelles :

missing : absence de fichier listé
present : présence de fichier listé comme devant être absent
hash : contenu de fichier non identique à celui attendu
contains : fichier contenant une chaîne marquée comme devant ne pas être dans le fichier
not-contains : fichier ne contenant pas une chaîne attendue

Limitations

PHPTM est loin d'être un outil parfait et exhaustif, n'hésitez pas à remonter des éventuels bugs et des demandes d'évolutions sur l'espace du projet sur Google Code http://code.google.com/p/phptreematch/issues/list ! ou à partir la documentation sur http://code.google.com/p/phptreematch

Bonne utilisation !

PHP Code Ratio : calculez le ratio de commentaires dans vos fichiers !

Olivier Hoareau — Tue, 05 May 2009 11:23:00 +0100

"Et alors, quel est le pourcentage de commentaires dans mon appli ?" Certains d'entre vous se sont déjà vus poser cette question ? Si, c'est la cas, PHP Code Ratio pourra probablement vous aider...

PHP Code Ratio, ou PHPCR de son petit nom, est un nouvel outil "basique" (dans la série des phpcpd, phpmd...) qui permet de connaître le pourcentage de commentaire dans vos fichiers php.

Installation

à partir du Channel PEAR

$ pear channel-discover pear.phppro.fr
$ pear install phppro/phpcr

mise à jour

$ pear upgrade phppro/phpcr

à partir du package compatible PEAR en téléchargement sur Google Code

$ wget http://phpcoderatio.googlecode.com/files/phpcr-0.1.0.tgz
$ pear install phpcr-0.1.0.tgz

Usage

Pour "passer" phpcr sur votre application, exécutez :

$ phpcr my-directory

ou bien pour exporter aussi le résultat sous forme xml :

$ phpcr --log-xml=phpcr-report.xml my-directory

Description des métriques calculées

Metrique 'code' : pourcentage de code php sans les espaces, sans les commentaires et sans le HTML "inline"
Metrique 'code-with-space' : pourcentage de code php avec les espaces mais sans commentaires et sans HTML "inline"
Metrique 'code-with-space-and-html' : pourcentage de code php avec espaces, HTML "inline" mais sans commentaire
Metrique 'html' : pourcentage de HTML "inline" dans les fichiers PHP
Metrique 'whitespace' : pourcentage d'espace dans les fichiers php

Extensions parsées

php
php3
php4
php5
phtml
inc

mais vous pouvez modifier cette liste en utilisant le paramètre ligne de commande "--suffixes="

Limitations

PHPCR est loin d'être un outil parfait et exhaustif, n'hésitez pas à remonter des éventuels bugs et des demandes d'évolutions sur l'espace du projet sur Google Code http://code.google.com/p/phpcoderatio/issues/list ! ou à partir la documentation sur http://code.google.com/p/phpcoderatio

Bonne utilisation !

Pourquoi Eclipse et les annotations ont révolutionné ma façon de coder

Olivier Hoareau — Tue, 21 Apr 2009 08:55:00 +0100

Comme beaucoup d'entre vous, "vi" (prononcez "vi-aille") a longtemps été mon ami pour développer mon code PHP.
Il me plaisait bien, j'avais l'air d'être un geek et tout allait bien.

Et puis il y a quelques temps (2-3 ans), j'ai du travailler chez un client avec Eclipse + Plugin PHP (que je connaissais en Java mais qui ne m'attirait pas à l'époque pour PHP au vu du peu de fonctionnalités que je pensais disponible pour cette plateforme).
Ce type d'outils généère un bloc de commentaire au dessus d'une fonction ou méthode quand on en créé une (après le passage à la ligne par l'appui sur la touche entrée).
J'ai vu qu'il rajoutait des annotations ou doclet :

/**
 * ...
 * 
 * @return unknown
 */

Je me suis dit que j'allais alors remplacer unknown par le type retourné quand il s'agissait d'un objet, par exemple :

/**
 * ...
 * 
 * @return Sms
 */

(en ce temps là, j'avais encore le temps de perdre mon temps à faire des choses d'apparences inutiles dans le code...).
Jusque là, rien de transcendant. Et puis dans un autre fichier, j'ai utilisé ma méthode nouvellement créé, et là, surprise ! Eclipse me propose une autocomplétion avec la liste de toutes les méthodes de la classe Sms ! Cool !
Je me suis dit alors que j'allais essayer de systématiquement mettre les @return, et que ca m'aiderait à aller plus vite (plutôt que de chercher le nom des méthodes dispos en switchant entre les fichiers).

Puis je remarque aussi qu'il me met des @param au-dessus des méthodes / fonctions, pour décrire les paramètres de mes fonctions.

/**
 * ...
 * 
 * @param unknown $sms
 * @param unknown $xmlelement
 *
 * ...
 */

Je décide alors d'essayer de mettre des types, par exemple :

/**
 * ...
 * 
 * @param Sms $sms le sms à envoyer
 * @param SimpleXMLElement $xmlelement le document xml
 *
 * ...
 */

Et je me rends compte qu'il m'indique ces types dans l'autocompletion, ce qui m'aide dans de nombreux cas pour savoir quoi passer à la fonction / méthode.

Par contre, j'ai souvent plein de méthodes qui ne renvoient rien, donc je ne bénéficie d'aucune complétion automatique dans ces cas là.
Je me dis alors, et si je renvoyait $this ?
Je mets alors des :

...
{
    ...
    return $this;
}

à la fin de chaque méthode qui n'est pas censée renvoyer un résultat (par exemple les setters !) et je rajoute l'annotation @return <la-classe-de-$this>.
Du coup, je peux chainer certains de mes appels :

$sms = new Sms();
$sms->setSender(...)
          ->addRecipient(...)
          ->addRecipient(...)
          ->setMessage(...)
          ->send();

Cool ! Pas mal, mon code devient plus concis et du coup, j'essaye de nommer mes méthodes pour que leur "enchainement" soit compréhensible et lisible. En plus, j'ai l'auto-complétion pour chacune des lignes grâce à mon @return !

La cerise sur le gâteau : j'utilise alors le pattern Factory (avec une méthode statique) :

    /**
      * Returns a new instance of this class
      *
      * @return Sms
      */
    public final static function getInstance()
    {
        return new self;
    }

Ce qui me permet de simplifier encore mon utilisation de mes classes :

Sms::getInstance()
    ->setSender(...)
    ->addRecipient(...)
    ->addRecipient(...)
    ->setMessage(...)
    ->send();

On pourrait même mettre tout sur une ligne ! (attention à la lisibilité).

Si je résume, grâce à Eclipse et aux annotations :

j'ai tendance à utiliser plutôt les structures objet pour avoir l'auto-complétion (plutôt que de multiple paramètre string)
je fais des return $this systématiques pour les méthodes qui ne renvoient rien
j'ai simplifié et rendu plus lisible les noms de mes méthodes pour qu'elles s'inscrivent harmonieusement dans un enchainement
j'ai typé mes paramètres de fonctions / méthodes ce qui me permet d'avoir l'auto-complétion sur les paramètres dans mes fonctions
je crée quasi systématiquement des factories pour éviter de passer par une variable inutile
...

Une vraie révolution, à l'époque, pour moi !

Et vous, quels sont les petits trucs qui ont révolutionné votre manière de coder ?

Points de contrôle automatisés avant un développement ou comment maîtriser un déploiement

Olivier Hoareau — Fri, 23 Jan 2009 08:51:00 +0000

Vous avez une mise en production hyper importante aujourd'hui. Votre client (interne) vous a mis la pression et vous avez dû raccourcir les délais pour être à l'heure. Vous packagez votre release d'application, vous la passez sur l'environnement de tests fonctionnels, tout se passe bien. Vous la passez sur l'environnement d'intégration et tout se passe bien, mais vous noter un ou deux comportement étrange, sans gravité, bizarre. Vous décidez de la passer en pré-production, et là ... Tout plante ! L'application ne se lance même plus et c'est la page blanche...

Pourquoi ?

Vous investiguez et vous découvrez que l'environnement de pré-production n'est absolument pas à jour (choisissez une ou plusieurs lignes dans la liste) :

- mauvaise version de PHP

- mauvaise version de votre framework MVC habituel

- mauvaise version de votre librairie de composants interne partagée

- extension SOAP manquante

- répertoire de log inexistant sur la machine (votre application ne le crée pas si il n'existe pas...)

- connexion à la base de données non fonctionnelle car les identifiants ont changé...

- ...

La catastrophe.

Vous décidez donc de regarder sur la machine de production, et bien sûr vous faites les mêmes découvertes...

Résultat: votre mise en production est décalée de 1/2 journée, vous mettez la pression aux équipes plateformes pour qu'elles mettent tous les environnements à jour, et vous prenez un savon par votre client (interne) qui vous prend pour un amateur.

Comment éviter cela ?

Vous pouvez acheter le dernier outils à la mode qui compte XXXX k€ et qui vérifie tout, mais c'est long à mettre en place et surtout ca coûte très cher dans votre budget (ou celui des équipes plateformes), en plus les tests réalisés seront soit très générique soit il faudra peut être un peu tordre l'outils pour faire certaines vérifications un peu spécifique à votre application (test de la connexion mysql, vérification de la version de votre framework préféré...)

Une autre solution consiste à réaliser un petit script, PHP, qui va faire tous les tests spécifiques qui vous intéresse et vous faire un rapport directe. Appellons le "PHP Sanity Check(er)".

Une contrainte cependant : tout doit tenir dans un script (1 fichier) et aucune installation ou dépendance autre que le dépôt du fichier dans l'arborescence du serveur web ne doit être nécessaire. En effet, il serait dommage que votre script ne fonctionne qu'avec une dépendance à la librairie TUTU et que cette librairie ne soit pas installée sur la plateforme (qui le vérifierait ?)

Le script peut être très simple et faire une série de version_compare(), de stream_socket_client(), de file_exists(), extension_loaded(), de vérification de variable $_SERVER.... c'est du PHP, vous pouvez donc tout faire ;), par contre, avant d'utiliser mysql(i)_connect, vérifiez (via un test dans le script) que l'extension mysql(i) est bien chargée !

Oui mais j'ai plusieurs applications croisées avec plusieurs environnements, ce qui m'oblige à faire des suites de tests différentes, comment faire ? je duplique le script pour chacun des cas et je maintiens les différentes versions ? une usine à gaz !

Non.

Vous êtes malin.

Vous développez donc une seule fois, vous faites des fichiers de configuration spécifiques à chacun des applications/environnements et "vous générez un script spécifique pour chacun des cas".

Comment ?

Grâce, par exemple à Phing et Phar.

Vous créez votre script générique qui prend une liste de tests écrit dans un fichier de configuration (par exemple xml). Voici un exemple de fichier :

<?xml version='1.0' encoding='iso-8859-1' ?>

<psc>
	<test info="PHP Version" type="php:minimum-version" arg1="5.0.0"/>
	<test info="Windows Platform" type="php:os" arg1="winnt"/>
	<test info="Google is Reachable" type="network:tcp-port-reachable" arg1="www.google.com" arg2="80"/>
</psc>

Votre script lit le contenu du fichier xml, en sort une liste de tests correspondant à des appels de méthodes de classes :

- Php::checkMinimumVersion('5.0.0')

- Php::checkOs('winnt')

- Network::checkTcpPortReachable('www.google.com','80')

Vous écrivez ensuite les classes Php (dans Php.php ;)) et Network (dans Network.php) qui contiennent chacunes les méthodes listées, vous pouvez bien sûr en rajouter d'autres, si elles ne sont pas listées dans le fichier de configuration elle ne seront pas utilisées.

Vous faites en sorte que chacune des méthodes lève une exception si le test ne passe pas avec un message d'erreur compréhensible sur le problème.

A l'exécution, vous récupérez le résultat d'exécution de chacune des méthodes (en faisant un try/catch par dessus) et vous affichez cela dans un tableau HTML qui va bien avec des couleurs verte et rouge.

Mais à quoi sert Phar ?

Venons-en à Phar. Phar ou encore "PHP Archive" permet de condenser plusieurs scripts PHP dans un seul fichier (.phar), il peut être compressé ou non. Le moteur PHP saura exécuter le fichier .phar comme si il était un script .php La seule différence est que le .phar contenant plusieurs fichiers php, il faut lui indiquer précisément quel est le premier script a exécuter (celui-ci pourra faire des includes des autres éventuellement).

Vous pouvez donc faire plein de fichiers/scripts/classes dans votre outils et les packager dans un seul et même fichier .phar en y embarquant même le fichier de configuration nécessaire. A l'exécution, vos scripts se comporteront comme si ils étaient dans un répertoire sur le disque et vous pourrez utiliser les includes.

Mais à quoi sert Phing ?

Phing, est un outils de scripting cross-platform (xml) écrit en PHP (port de Ant venant de Java). Il permet de décrir des batchs de commandes (systèmes souvent) à réaliser sous forme xml (ca marche donc sous windows, mac, linux...), voici ce que nous pourrions faire pour packager notre PHP sanity Checker pour générer un .phar à installer sur les plateformes pour notre application TOTO :

    <target name="package" depends="init" description="Packages the phar script to deploy on platform (use -Dsuite=<your-suite>)">
    	<delete dir="tmp/package"/>
    	<mkdir dir="tmp/package"/>
    	<mkdir dir="tmp/package/config/suites"/>
    	<copy file="config/suites/${suite}.xml" tofile="tmp/package/config/suites/default.xml"/>
    	<copy todir="tmp/package">
    		<fileset dir=".">
    			<include name="**/*.php"/>
    		</fileset>
    	</copy>
    	<phar to="tmp/check.phar">
    		<fileset dir="tmp/package">
    			<include name="**/*"/>
    		</fileset>
    	</phar>
    </target>

Pour exécuter cette liste de commandes, vous faites :

$ phing package -Dsuite=mon-application

ce qui aura pour but de packager le fichier mon-application.xml avec vos scripts php (ceux de votre outils de tests) dans un fichier tmp/check.phar.

Dernière étape, vous déployez (vous copiez) le fichier check.phar sur votre plateforme cible dans l'arborescence du serveur web, et vous accédez à ce fichier comme si il s'agissait d'un fichier .php (configurer apache pour qu'il traite les fichiers .phar comme les fichiers .php).

Des commentaires ?

Code HTML/JS simplifié (sans framework) pour faire de l'ajax

Olivier Hoareau — Fri, 10 Oct 2008 15:42:00 +0100

Pour des besoins internes, j'ai spiké un code html/js de quelques lignes pour faire des requêtes Ajax (POST/PUT/DELETE/GET/HEAD) en voyant par exemple du contenu xml (REST ;) )

Je l'ai mis en ligne, vous pouvez récupérer à tout moment le code source (code source html) à l'adresse : ...

Pour des besoins internes, j'ai spiké un code html/js de quelques lignes pour faire des requêtes Ajax (POST/PUT/DELETE/GET/HEAD) en voyant par exemple du contenu xml (REST ;) )

Je l'ai mis en ligne, vous pouvez récupérer à tout moment le code source (code source html) à l'adresse :

http://octo.warkodev.net/ajax/

C'est bâteau, mais ca arrive qu'on ait besoin d'un morceaux de code de ce type rapidement sous la main.

Hope this helps (même si ca remplace pas prototype, extjs et autres jquery ;) )

PS: testé et fonctionnel sur FF3, IE7, GChrome

Scrinch : Outil de gestion de projet agile

Olivier Hoareau — Wed, 08 Oct 2008 15:46:00 +0100

Bonjour à tous amis Agilistes,

Que pensez-vous de cette outils pour gérer les projets Agile : ...

Bonjour à tous amis Agilistes,

Que pensez-vous de cet outil pour gérer les projets Agile :

http://social.hortis.ch/2008/09/25/16-octobre-08-mardi-gras-sur-scrinch-outil-de-gestion-de-projet-agile/

Ca ne remplace pas nos bons vieux post-it sur les murs mais cela peut-il avoir une pertinence à vos yeux pour le Product Owner et pour l'équipe.

A vos plumes