Le blog de Nukleo

L’éditeur de code Netbeans implémente par défaut le remplissage automatique (autocomplete) pour les frameworks Zend et Symfony depuis peu. Pour les autres, et notamment CodeIgniter, niet. Qu’à cela ne tienne voici comment ajouter l’autocomplete pour CodeIgniter !

J’ai trouvé cette astuce, en cherchant un peu partout une solution à ce problème, sur ce blog. Je me suis simplement permis de traduire en partie sa mise en place.

Autocomplete de base

Pour accéder à l’autocomplete des fonctions de base de CodeIgniter, il suffit simplement de créer un fichier « nom_du_fichier.php » dans le dossier de projet de Netbeans (nbproject) de votre application et d’y coller le contenu ci-dessous. Après cela, relancez Netbeans. Pour ce tutorial nous supposerons que ce fichier sera nommé « ci_autocomplete.php ».

<?php

/**
* @property CI_DB_active_record $db
* @property CI_DB_forge $dbforge
* @property CI_Benchmark $benchmark
* @property CI_Calendar $calendar
* @property CI_Cart $cart
* @property CI_Config $config
* @property CI_Controller $controller
* @property CI_Email $email
* @property CI_Encrypt $encrypt
* @property CI_Exceptions $exceptions
* @property CI_Form_validation $form_validation
* @property CI_Ftp $ftp
* @property CI_Hooks $hooks
* @property CI_Image_lib $image_lib
* @property CI_Input $input
* @property CI_Language $language
* @property CI_Loader $load
* @property CI_Log $log
* @property CI_Model $model
* @property CI_Output $output
* @property CI_Pagination $pagination
* @property CI_Parser $parser
* @property CI_Profiler $profiler
* @property CI_Router $router
* @property CI_Session $session
* @property CI_Sha1 $sha1
* @property CI_Table $table
* @property CI_Trackback $trackback
* @property CI_Typography $typography
* @property CI_Unit_test $unit_test
* @property CI_Upload $upload
* @property CI_URI $uri
* @property CI_User_agent $user_agent
* @property CI_Validation $validation
* @property CI_Xmlrpc $xmlrpc
* @property CI_Xmlrpcs $xmlrpcs
* @property CI_Zip $zip
*/

class Controller {};

/**
* @property CI_DB_active_record $db
* @property CI_DB_forge $dbforge
* @property CI_Config $config
* @property CI_Loader $load
* @property CI_Session $session
*/

class Model {};

?>

Comment ça fonctionne ?

Au lancement de Netbeans, celui-ci lit les fichiers contenus dans le répertoire nbproject (notamment project.xml et project.properties) afin de préparer l’environnement de développement.
En « lisant » le fichier ci_autocomplete.php il repère les propriétés définies dans le DocBlock pour les classes Controller et Model.
C’est cela qui lui permettra de fournir l’autocomplete lors de l’édition d’un controlleur ou d’un modèle. En parcourant le contenu du fichier on remarquera que l’on liste simplement les classes mises à disposition par CodeIgniter.

Ajoutez vos propres classes

Le but de la manoeuvre étant aussi d’accéder à l’autocomplete sur vos modèles et librairies, il suffit d’éditer le fichier ci_autocomplete.php que vous venez de créer pour les y incorporer :

* @property Nom_de_votre_classe $nom_de_votre_objet

Par exemple, en ajoutant

* @property Portfolio_model $portfolio_model

dans le DocBlock Controller, vous aurez accès aux méthodes du modèle Portfolio_model lors de l’édition d’un controlleur :

Note : pour que toutes les fonctions de vos modèles soient également disponibles pendant l’édition d’un modèle, il faudra également ajouter les modèles dans le DocBlock du modèle.

Conclusion

Il est dommage que, par défaut, on ne puisse pas accéder à l’autocomplete des fonctions de CodeIgniter — ceci étant apparemment dû à la manière dont le code est commenté — mais grâce à cette petite astuce tout rentre dans l’ordre.
Dernier petit conseil : utilisez également les commentaires DocBlock avec vos méthodes de modèles pour facilement en afficher l’utilisation lors de l’édition de controlleurs et modèles.

Mots-clés : CodeIgniter, Netbeans