Intégration Eclipse

Eclipse est un EDI puissant, qui permet entre autres de rajouter par différents mécanismes, la prise en charge de Yii. Par "prise en charge", il faut comprendre que certaines fonctionnalités standard d'Eclipse peuvent être mises à contribution, pour faciliter (et surtout accélérer) le développement d'une application basée sur Yii.


Installation

Pour mettre en place un tel environnement, il faut commencer par télécharger la version PDT d'Eclipse (PDT = PHP Developer Tools .. juste ce qu'il nous faut !). Une fois l'installation terminée nous allons déclarer le framework Yii comme librairie utilisateur.

• menu Window > Preferences ... + PHP Librairies
• cliquez sur le bouton New et nommez la librairie (par exemple Yii-1.1.7 si c'est de cette version dont vous disposez). Cliquez ensuite sur OK
• sélectionnez ensuite la librairie que vous venez de déclarer et cliquez sur 'Add External Folder'
• sélectionnez le répertoire framework de distribution Yii, puis cliquez sur OK

Désormais, lors de la création de votre prochain projet, vous serez en mesure de l'associer à votre librairie Yii, et donc d'accéder en lecture seule aux fichiers du framework Yii directement depuis le projet.

Outils personnaliés

Une autre fonction bien pratique offerte par Eclipse, est la possibilité de définir des outils personnalisés, que nous allons mettre à profit pour éxécuter des commandes Yii. La plus intéressante (à mon sens) permet de créer un squelette d'application Yii, en un click, directement depuis Eclipse. Pour cela, nous allons commencer par définir une structure type pour notre projet. La seule règle sera que l'application web à proprement parlé devra systématiquement se trouver dans le répertoire 'www', lui même placé à la racine du projet Eclipse. A partir de là c'est tout simple, mais quelques conditions doivent être satisfaites :

1. rajoutez une variable d'environnement YII_HOME et initialisez avec le nom du répertoire d'installation du framework Yii (par exemple YII_HOME=G:\home\project\lib\php\yii\yii-1.1.7.r3135\framework)
2. assurez-vous que PHP.exe est bien accessible depuis la variable PATH
3. on suppose que PHPUnit est installé dans le répertoire PEAR, lui même placé dans le répertoire qui contient PHP.exe
4. redémarrez Eclipse
5. Menu Run > External Tools > External Tools Configuration ... 

On peut ensuite rajouter les commandes suivantes, avec les ajustements qui s'imposent en fonction des répertoires d'installations de php.exe et de phpunit :

// création d'une webapp Yii dans le répertoire sélectionné
// dans Eclipse
name              : webapp
location          : ${env_var:YII_HOME}\yiic.bat
working directory : ${workspace_loc}
argument          : webapp ${resource_loc}

// Exécution du test PHPUnit pour la classe sélectionnée
name              : PHPUnit  Unit (single)
location          : ${system_path:php.exe}
working directory : ${project_loc}/www/protected/tests
argument          : ${system_path:PEAR\phpunit} --verbose "${selected_resource_loc}"

// Exécution du test PHPUnit pour la classe sélectionnée
// Création du rapport correspondant
name              : PHPUnit  Unit (single) + rapport
location          : ${system_path:php.exe}
working directory : ${project_loc}/www/protected/tests
argument          : ${system_path:PEAR\phpunit} --coverage-html  "${project_loc}/www/protected/tests/report"  --verbose "${selected_resource_loc}"

// Exécution de tous les tests unitaire définis pour le projet sélectionné
// Création du rapport correspondant
name              : PHPUnit - Unit (all tests) + report
location          : ${system_path:php.exe}
working directory : ${project_loc}/www/protected/tests
argument          : ${system_path:PEAR\phpunit} --coverage-html  "${project_loc}/www/protected/tests/report" --verbose "${project_loc}/www/protected/tests/unit"

La création d'un nouveau projet Yii sous Eclipse est alors (presque) instantanée :

• Menu File > New ... > PHP Project
• Entrez le nom de projet puis Next 
• cliquez sur l'onglet 'Librairies' puis sur 'Add Librairy ...'
• sélectionnez la librairie Yii préalablement déclarée, puis terminez la création du projet

Pour se conformer à notre modèle de projet, créez le répertoire 'www' à la racine, et tout en le gardant sélectionnez lancez la commande que nous venons de rajouter (webapp) : le répertoire www est maintenant prêt pour votre nouvelle application Yii !!

Quelques liens :

• Rapid Environment Editor (windows) : pratique pour éditer les variables d'environnement Windows
• Eclipse + Yii : mise en place d'un environnement de développement