L’API de cakePHP en ligne de commande
31/01/2008 | Publié dans cakephp, tips
Ce week-end, ma connexion internet avait quelques difficultés à se maintenir plus de quelques secondes. Du coup, j’étais un peu embêté pour consulter de manière interactive la doc de l’API (celle-ci).Dans Eclipse PDT, un bon vieux F2 vous affichera un tooltip généré à partir du commentaire format PHPdoc à propos de la méthode sur laquelle se trouve votre pointeur… quand Eclipse arrive à s’y retrouver, c’est-à-dire pas si souvent. En fouillant dans le répertoire “console” de cake, je suis tombé sur le fichier “api.php”, présent (d’après SVN) depuis le 23/05/2007 dans Cake et dont j’ignorais jusqu’à présent l’utilité. En fait, il permet d’accéder à la documentation de l’API en ligne de commande. Pour cela :
- se positionner dans le répertoire cake/console
- taper : “./cake api model -m find” (par exemple) et admirer.
Voici le mode d’emploi :
Usage: cake api [type] model [-m method ]
On peut se contenter de préciser le nom de la classe, on obtient alors une liste des méthodes dont on veut accéder à la documentation. On peut mieux cibler soit en précisant directement la méthode soit en restreignant la recherche à un type de classes (behavior, model, view…). Si l’on prend la peine de documenter ses propres classes, ça peut aussi aider.
A l’instar de bake, il peut être commode de définir cette commande en tant qu’external tool (ci-dessous une configuration sommaire).
(désolé pour la présentation foireuse de ce post, il y a des choses qui m’échappent encore dans wordpress…)
