Shells, Tasks & Outils de Console¶

La console de CakePHP¶

Cette section fournit une introduction sur la ligne de commande dans CakePHP. Si vous avez besoin d’accéder à vos classes MVC de CakePHP dans une tâche cron ou tout autre script de ligne de commande, cette section est pour vous.

PHP fournit un puissant client CLI qui rend l’interfaçage avec votre système de fichier et vos applications plus facile. La console CakePHP fournit un framework de création de scripts shell. La console utilise un ensemble de répartiteur de types pour charger un shell ou une tâche, et lui passer des paramètres.

Avant d’entrer dans les spécificités, assurons-nous que vous pouvez exécuter la console CakePHP. Tout d’abord, vous devrez ouvrir un shell système. Les exemples présentés dans cette section sont issus du bash, mais la console CakePHP est également compatible Windows. Exécutons le programme Console depuis le bash. Cet exemple suppose que l’utilisateur est actuellement connecté dans l’invite bash et qu’il en est root sur une installation CakePHP.

Les applications CakePHP contiennent un répertoire Console qui contient tous les shells et les tâches pour une application. Il est aussi livré avec un exécutable:

$ cd /path/to/cakephp/app
$ Console/cake

Mais il est préférable d’ajouter l’exécutable du coeur de cake dans votre système de path afin que vous puissiez utiliser la commande cake de partout. C’est plus pratique quand vous créez de nouveaux projets. Regardez Ajouter cake à votre système path pour voir la façon de rendre cake disponible dans tout le système.

Lancez la Console avec aucun argument entraîne ce message d’aide:

Welcome to CakePHP v2.0.0 Console
---------------------------------------------------------------
App : app
Path: /path/to/cakephp/app/
---------------------------------------------------------------
Current Paths:

 -app: app
 -working: /path/to/cakephp/app
 -root: /path/to/cakephp/
 -core: /path/to/cakephp/core

Changing Paths:

your working path should be the same as your application path
to change your path use the '-app' param.
Example: -app relative/path/to/cakephp/app or -app /absolute/path/to/cakephp/app

Available Shells:

 acl [CORE]                              i18n [CORE]
 api [CORE]                              import [app]
 bake [CORE]                             schema [CORE]
 command_list [CORE]                     testsuite [CORE]
 console [CORE]                          upgrade [CORE]

To run a command, type 'cake shell_name [args]'
To get help on a specific command, type 'cake shell_name help'

La première information affichée est en rapport avec les chemins. Ceci est particulièrement pratique si vous exécutez la Console depuis différents endroits de votre système de fichier.

Beaucoup d’utilisateurs ajoutent la console CakePHP à leur path système afin qu’elle puisse être facilement accessible. L’affichage des chemins de workdir, root, app et core vous permet de voir où la Console fera des changements. Pour changer le dossier app par celui dans lequel vous souhaitez travailler, vous pouvez fournir son chemin comme premier argument de la ligne de commande cake. L’exemple suivant montre comment spécifier un dossier app, en supposant que vous avez déjà ajouté le dossier de la console à votre PATH:

$ cake -app /path/to/cakephp/app

Le chemin fourni peut être relatif au répertoire courant ou fourni sous forme de chemin absolu.

Créer un Shell¶

Créons un shell pour l’utilisation dans la Console. Pour cet exemple, nous créerons un simple shell Hello world. Dans le répertoire Console/Command de votre application, créez HelloShell.php. Mettez le code suivant dedans:

class HelloShell extends AppShell {
    public function main() {
        $this->out('Hello world.');
    }
}

Les conventions pour les classes de shell sont que les noms de classe doivent correspondre au nom du fichier, avec Shell en suffixe. Dans notre shell, nous avons crée une méthode main(). Cette méthode est appelée quand un shell est appelé avec aucune commande supplémentaire. Nous allons ajouter quelques commandes en plus dans un moment, mais pour l’instant lançons juste notre shell. Depuis le répertoire de votre application, lancez:

Console/cake hello

Vous devriez voir la sortie suivante:

Welcome to CakePHP v2.0.0 Console
---------------------------------------------------------------
App : app
Path: /Users/markstory/Sites/cake_dev/app/
---------------------------------------------------------------
Hello world.

Comme mentionné avant, la méthode main() dans les shells est une méthode spéciale appelée tant qu’il n’y a pas d’autres commandes ou arguments donnés au shell. Vous pouvez aussi remarquer que HelloShell étend AppShell. Un peu comme Le Controller App, AppShell vous donne une classe de base pour contenir toutes les fonctions ordinaires ou logiques. Vous pouvez définir un AppShell en créant app/Console/Command/AppShell.php. Si vous n’en avez pas un, CakePHP en utilisera une integrée. Comme notre méthode principale n’était pas très intéressante, ajoutons une autre commande qui fait quelque chose:

class HelloShell extends AppShell {
    public function main() {
        $this->out('Hello world.');
    }

    public function hey_there() {
        $this->out('Hey there ' . $this->args[0]);
    }
}

Après avois sauvegardé ce fichier, vous devriez être capable de lancer Console/cake hello hey_there your-name et de voir vos noms affichés. Toute méthode publique non préfixée par un _ peut être appelée à partir de ligne de commande. Dans notre méthode hey_there, nous utilisons aussi $this->args, cette propriété contient un tableau de tous les arguments de position fournis à une commande. Vous pouvez aussi utiliser des switches ou des options sur les shells des applications, ils sont disponibles dans la variable $this->params et avec la méthode param(), mais nous verrons ça bientôt.

Lorsque vous utilisez la méthode main(), vous n’êtes pas capable d’utiliser les arguments de position ou les paramètres. Cela parce que le premier argument de position ou l’option est interprété en tant que nom de commande. Si vous voulez utiliser des arguments et des options, vous devriez utiliser un autre nom de méthode que main.

class UserShell extends AppShell {
    public $uses = array('User');

    public function show() {
        $user = $this->User->findByUsername($this->args[0]);
        $this->out(print_r($user, true));
    }
}

Les tâches Shell¶

Il y aura des fois où quand vous construirez des applications plus poussées via la console, vous voudrez composer des fonctionnalités dans des classes réutilisables qui peuvent être partagées à travers plusieurs shells. Les tâches vous permettent d’extraire des commandes dans des classes. Par exemple, bake est fait entièrement de tâches. Vous définissez les tâches d’un shell en utilisant la propriété $tasks:

class UserShell extends AppShell {
    public $tasks = array('Template');
}

Vous pouvez utiliser les tâches à partir de plugins en utilisant la syntaxe de plugin standard. Les tâches sont stockées dans Console/Command/Task/ dans les fichiers nommées d’après leur classe. Ainsi si vous étiez sur le point de créer une nouvelle tâche “FileGenerator”, vous pourriez créer Console/Command/Task/FileGeneratorTask.php.

Chaque tâche doit au moins intégrer une méthode execute(). Le ShellDispatcher appelera cette méthode quand la tâche est invoquée. une classe de tâche ressemble à cela:

class FileGeneratorTask extends Shell {
    public $uses = array('User');
    public function execute() {

    }
}

Un shell peut aussi accéder à ses tâches en tant que propriétés, ce qui rend les tâches meilleures pour la réutilisation de fonctions identiques à Components (Composants):

// trouvé dans Console/Command/SeaShell.php
class SeaShell extends AppShell {
    public $tasks = array('Sound'); // trouvé dans Console/Command/Task/SoundTask.php
    public function main() {
        $this->Sound->execute();
    }
}

Vous pouvez aussi accéder aux tâches directement à partir de la ligne de commande:

$ cake sea sound

$Project = $this->Tasks->load('Project');

$ProgressBar = $this->Tasks->load('ProgressBar.ProgressBar');

Invoquer d’autres shells à partir de votre shell¶

Les Shells n’ont plus directement accès à ShellDispatcher, à travers $this->Dispatch. Il y a cependant beaucoup de cas où vous voulez invoquer un shell à partir d’un autre. Shell::dispatchShell() vous donne la possibilité d’appeler d’autres shells en fournissant le argv pour le shell sub. Vous pouvez fournir des arguments et des options soit en variables args ou en chaînes de caractères:

// En chaînes de caractère
$this->dispatchShell('schema create Blog --plugin Blog');

// En tableau
$this->dispatchShell('schema', 'create',  'Blog', '--plugin',  'Blog');

Ce qui est au-dessus montre comment vous pouvez appeler le shell schema pour un plugin à partir du shell de votre plugin.

Niveaux de sortie de la Console¶

Les Shells ont souvent besoin de différents niveaux de verbosité. Quand vous lancez une tâche cron, la plupart des sorties ne sont pas nécessaires. Et il y a des fois où vous n’êtes pas interessés dans tout ce qu’un shell a à dire. Vous pouvez utiliser des niveaux de sortie pour signaler la sortie de façon appropriée. L’utilisateur du shell peut ensuite décider pour quel niveau de détail ils sont interessés en configurant le bon flag quand on appelle le shell. Shell::out() supporte 3 types de sortie par défaut.

• QUIET - Seulement des informations importantes doivent être marquées pour une paisible.

• NORMAL - Le niveau par défaut, et un usage normal

• VERBOSE - Les messages marqués qui peuvent être trop ennuyeux pour une utilisation quotidienne, mais aide au debugging en VERBOSE

Vous pouvez marquer la sortie comme suit:

// apparaitra à tous les niveaux.
$this->out('Quiet message', 1, Shell::QUIET);

// n'apparaitra pas quand une sortie quiet est togglé
$this->out('message normal', 1, Shell::NORMAL);
$this->out('message loud', 1, Shell::VERBOSE);

// would only appear when verbose output is enabled.
$this->out('extra message', 1, Shell::VERBOSE);

Vous pouvez contrôler le niveau de sortie des shells, en utilisant les options --quiet et --verbose. Ces options sont ajoutées par défaut, et vous autorise à contrôler la cohérence du niveau de sortie à l’intérieur de vos shells CakePHP.

Style de sortie¶

La Style de sortie est fait en incluant les tags - juste comme le HTML - dans votre sortie.

ConsoleOutput remplacera ces tags avec la bonne séquence de code ansi, ou supprimera les tags si vous êtes sur une console qui ne supporte pas les codes ansi. Il y a plusieurs styles intégrés, et vous pouvez en créer plus. Ceux intégrés sont:

* ``error`` Messages d'Erreur. Texte rouge souligné.
* ``warning`` Messages d'avertissement. Texte jaune.
* ``info`` Messages d'informations. Texte cyan.
* ``comment`` Texte supplémentaire. Texte bleu.
* ``question`` Texte qui est une question, ajouté automatiquement par shell.

Vous pouvez créer des styles supplémentaires en utilisant $this->stdout->styles(). Pour déclarer un nouveau style de sortie, vous pouvez faire:

$this->stdout->styles('flashy', array('text' => 'magenta', 'blink' => true));

Cela vous permettra d’utiliser un tag <flashy> dans la sortie de votre shell, et si les couleurs ansi sont activées, ce qui suit sera rendu en texte magenta clignotant $this->out('<flashy>Whoooa</flashy> Quelque chose a posé problème');. Quand vous définissez les styles, vous pouvez utiliser les couleurs suivantes pour les attributs text et background:

• black

• red

• green

• yellow

• blue

• magenta

• cyan

• white

Vous pouvez aussi utiliser les options suivantes en commutateurs boléens, en les définissant à une valeur true qui les active.

• bold

• underline

• blink

• reverse

Ajouter un style le rend aussi disponible pour toutes les instances de ConsoleOutput, donc vous n’avez pas à re-déclarer les styles pour les deux objets stdout et stderr.

$this->stdout->outputAs(ConsoleOutput::RAW);

Configurer les options et générer de l’aide¶

class ConsoleOptionParser¶

Le parsing d’option de la Console dans CakePHP a toujours été un peu différent par rapport aux autres consoles en ligne de commande. Dans 2.0, ConsoleOptionParser aide à fournir un parser d’option et d’argument plus familier en ligne de commande.

OptionParsers vous permet d’accomplir deux buts en même temps. Premièrement, il vous permet de définir les options et arguments, séparant la validation basique des entrées et votre code. Deuxièmement, il vous permet de fournir de la documentation, qui est utilisée pour bien générer le fichier d’aide formaté.

La console du framework récupère votre parser d’option du shell en appelant $this->getOptionParser(). Surcharger cette méthode vous permet de configurer l’OptionParser pour faire correspondre les entrées attendues de votre shell. Vous pouvez aussi configurer les parsers d’option des sous-commandes, ce qui vous permet d’avoir des parsers d’option différents pour les sous-commandes et les tâches. ConsoleOptionParser implémente une interface courant et inclut les méthodes pour configurer facilement les multiple options/arguments en une fois.

public function getOptionParser() {
    $parser = parent::getOptionParser();
    //configure parser
    return $parser;
}

public function getOptionParser() {
    $parser = parent::getOptionParser();
    $parser->addArgument('type', array(
        'help' => 'Either a full path or type of class.'
    ))->addArgument('className', array(
        'help' => 'A CakePHP core class name (e.g: Component, HtmlHelper).'
    ))->addOption('method', array(
        'short' => 'm',
        'help' => __('The specific method you want help on.')
    ))->description(__('Lookup doc block comments for classes in CakePHP.'));
    return $parser;
}

// Définit plusieurs lignes en une fois
$parser->description(array('line one', 'line two'));

// Lit la valeur actuelle
$parser->description()

// Définit plusieurs lignes en une fois
$parser->epilog(array('line one', 'line two'));

// Lit la valeur actuelle
$parser->epilog()

$parser->addArgument('model', array('help' => 'The model to bake'));

$parser->addArguments(array(
    'node', array('help' => 'The node to create', 'required' => true),
    'parent' => array('help' => 'The parent node', 'required' => true)
));

$parser->addArgument('type', array(
    'help' => 'Le type de noeud avec lequel intéragir.',
    'required' => true,
    'choices' => array('aro', 'aco')
));

$parser->addOption('connection', array(
    'short' => 'c'
    'help' => 'connection',
    'default' => 'default'
));

$parser->addOption('no-commit', array('boolean' => true));

$parser->addOptions(array(
    'node', array('short' => 'n', 'help' => 'The node to create'),
    'parent' => array('short' => 'p', 'help' => 'The parent node')
));

$parser->addOption('accept', array(
    'help' => 'What version to accept.',
    'choices' => array('working', 'theirs', 'mine')
));

$parser->addOption('verbose', array(
    'help' => 'Enable verbose output.',
    'boolean' => true
));

if ($this->params['verbose']) {
    // faire quelque chose
}

// Depuis 2.7
if ($this->param('verbose')) {
    // faire quelque chose
}

$parser->addSubcommand('model', array(
    'help' => 'Bake a model',
    'parser' => $this->Model->getOptionParser()
));

$parser->addSubcommand('check', array(
    'help' => __('Check the permissions between an ACO and ARO.'),
    'parser' => array(
        'description' => array(
            __("Use this command to grant ACL permissions. Once executed, the ARO "),
            __("specified (and its children, if any) will have ALLOW access to the"),
            __("specified ACO action (and the ACO's children, if any).")
        ),
        'arguments' => array(
            'aro' => array('help' => __('ARO to check.'), 'required' => true),
            'aco' => array('help' => __('ACO to check.'), 'required' => true),
            'action' => array('help' => __('Action to check'))
        )
    )
));

public function getOptionParser() {
    return ConsoleOptionParser::buildFromArray(array(
        'description' => array(
            __("Use this command to grant ACL permissions. Once executed, the ARO "),
            __("specified (and its children, if any) will have ALLOW access to the"),
            __("specified ACO action (and the ACO's children, if any).")
        ),
        'arguments' => array(
            'aro' => array('help' => __('ARO to check.'), 'required' => true),
            'aco' => array('help' => __('ACO to check.'), 'required' => true),
            'action' => array('help' => __('Action to check'))
        )
    ));
}

cake bake --help
cake bake -h

cake bake model --help
cake bake model -h

cake bake --help xml
cake bake -h xml

<?xml version="1.0"?>
<shell>
    <command>bake fixture</command>
    <description>Generate fixtures for use with the test suite. You can use
        `bake fixture all` to bake all fixtures.</description>
    <epilog>Omitting all arguments and options will enter into an interactive mode.</epilog>
    <subcommands/>
    <options>
        <option name="--help" short="-h" boolean="1">
            <default/>
            <choices/>
        </option>
        <option name="--verbose" short="-v" boolean="1">
            <default/>
            <choices/>
        </option>
        <option name="--quiet" short="-q" boolean="1">
            <default/>
            <choices/>
        </option>
        <option name="--count" short="-n" boolean="">
            <default>10</default>
            <choices/>
        </option>
        <option name="--connection" short="-c" boolean="">
            <default>default</default>
            <choices/>
        </option>
        <option name="--plugin" short="-p" boolean="">
            <default/>
            <choices/>
        </option>
        <option name="--records" short="-r" boolean="1">
            <default/>
            <choices/>
        </option>
    </options>
    <arguments>
        <argument name="name" help="Name of the fixture to bake.
            Can use Plugin.name to bake plugin fixtures." required="">
            <choices/>
        </argument>
    </arguments>
</shell>

Routing dans shells / CLI¶

Dans l’interface en ligne de commande (CLI), spécialement dans vos shells et tasks, env('HTTP_HOST') et les autres variables d’environnement spécifique à votre navigateur ne sont pas définis.

Si vous générez des rapports ou envoyez des emails qui utilisent Router::url(), ceux-ci vont contenir l’hôte par défaut http://localhost/ et cela va entrainer des URLs invalides. Dans ce cas, vous devrez spécifier le domaine manuellement. Vous pouvez faire cela en utilisant la valeur de Configure App.fullBaseUrl de votre bootstrap ou config, par exemple.

Pour envoyer des emails, vous devrez fournir à la classe CakeEmail l’hôte avec lequel vous souhaitez envoyer l’email en faisant:

$Email = new CakeEmail();
$Email->domain('www.example.org');

Cela suppose que les ID du message généré sont valides et correspondent au domaine duquel les emails sont envoyés.

API de Shell¶

class AppShell¶

AppShell peut être utilisée comme une classe de base pour tous vos shells. Elle devrait étendre Shell, et être localisée dans Console/Command/AppShell.php.

class Shell($stdout = null, $stderr = null, $stdin = null)¶

Shell est une classe de base pour tous les shells, et fournit un certain nombre de fonctions pour l’interaction avec l’entrée de l’utilisateur, sortant un texte d’erreurs générées.

property Shell::$tasks¶

Un tableau de tâches que vous voulez charger pour ce shell/task.

property Shell::$uses¶

Un tableau de models qui devrait être chargé pour ce shell/task.

Shell::clear()¶

Efface la sortie courante étant affichée.

Shell::param($name)¶

Récupère la valeur d’une option/paramètre. Va retourner null si le paramètre n’existe pas.

Nouveau dans la version 2.7.

Shell::createFile($path, $contents)¶

Paramètres:

• $path (string) – Le chemin absolu du fichier que vous voulez créer.

• $contents (string) – Contenus à mettre dans le fichier.

Crée un fichier dans un chemin donné. Si le Shell est interactif, un avertissement sera généré, et il sera demandé à l’utilisateur si ils veulent écraser le fichier si il existe déjà. Si la propriété interactive du shell est à false, aucune question ne sera demandée et le fichier sera simplement écrasé.

Shell::dispatchShell()¶

Dispatche une commande vers un autre Shell. Similaire à Controller::requestAction() mais pour lancer les shells à partir d’autres shells.

Regardez Invoquer d’autres shells à partir de votre shell.

Shell::err($message = null, $newlines = 1)¶

Paramètres:

• $method (string) – Le message à afficher.

• $newlines (integer) – Le nombre de nouvelles lignes qui suivent le message.

Sort une méthode vers stderr, fonctionne de la même manière que Shell::out()

Shell::error($title, $message = null)¶

Paramètres:

• $title (string) – Titre d’une erreur.

• $message (string) – Un message d’erreur en option.

Affiche un message d’erreurs formaté et sort de l’application avec le code de statut à 1.

Shell::getOptionParser()¶

Devrait retourner un objet ConsoleOptionParser, avec tout sous-parsers pour le shell.

Shell::hasMethod($name)¶

Vérifie si ce shell a une méthode appelable par le nom donné.

Shell::hasTask($task)¶

Vérifie si le shell a une tâche avec le nom fourni.

Shell::hr($newlines = 0, $width = 63)¶

Paramètres:

• $newlines (int) – Le nombre de nouvelles lignes à mettre avant et à la suite de la ligne.

• $width (int) – La largeur de la ligne à dessiner.

Crée une ligne horizontale précédée et suivie par un nombre de nouvelles lignes.

Shell::in($prompt, $options = null, $default = null)¶

Paramètres:

• $prompt (string) – Le prompt à afficher à l’utilisateur.

• $options (array) – Un tableau de choix valides que l’utilisateur peut choisir. Choisir une option non valide va forcer l’utilisateur à re-choisir.

• $default (string) – L’option par défaut si il y en a une.

Cette méthode vous aide à interagir avec l’utilisateur, et crée des shells interactifs. Elle va retourner la réponse des utilisateurs au prompt, et vous permet de fournir une liste d’options valides dans laquelle l’utilisateur peut choisir:

$selection = $this->in('Red or Green?', array('R', 'G'), 'R');

La validation de la sélection est sensible à la casse.

Shell::initialize()¶

Initialize le constructeur du shell pour les sous-classes, permet la configuration de tâches avant l’execution du shell.

Shell::loadTasks()¶

Charge les tâches défines dans public Shell::$tasks.

Shell::nl($multiplier = 1)¶

Paramètres:

• $multiplier (int) – Nombre de fois que la séquence de ligne doit être répétée.

Sort un certain nombre de séquences de nouvelles lignes.

Shell::out($message = null, $newlines = 1, $level = Shell::NORMAL)¶

Paramètres:

• $message (string) – Le message à afficher.

• $newlines (integer) – Le nombre de nouvelles lignes qui suivent le message.

• $level (integer) – Le Niveaux de sortie de la Console le plus haut que ce message doit afficher.

La méthode primaire pour la génération de la sortie de l’utilisateur. En utilisant les niveaux, vous pouvez utiliser la façon dont un shell est verbose. out() vous permet aussi d’utiliser les tags de formatage de couleur, ce qui permettra la sortie colorée sur les systèmes qui le supportent. Il y a plusieurs styles intégrées pour la coloration de texte, et vous pouvez définir les vôtres.

• error Messages d’Erreur.

• warning Messages d’avertissement.

• info Messages d’information.

• comment Texte supplémentaire.

• question Texte Magenta utilisé pour les prompts de l’utilisateur.

En formattant les messages avec des balises de style, vous pouvez afficher une sortie stylisée:

$this->out('<warning>This will remove data from the filesystems.</warning>');

Par défaut sur les systèmes *nix, les objets ConsoleOutput ont par défaut une sortie colorée. Sur les systèmes Windows, la sortie brute est la sortie par défaut sauf si la variable d’environnement ANSICON est présente.

Shell::overwrite($message = null, $newlines = 1, $size = null)¶

Paramètres:

• $message (string) – Le message à afficher.

• $newlines (integer) – Le nombre de nouvelle ligne à la suite du message.

• $size (integer) – Le nombre d’octets à surcharger

C’est une méthode utile pour générer des progess bars ou pour éviter de générer trop de lignes.

Attention: Vous ne pouvez pas surcharger du texte qui contient des retours à la ligne.

Nouveau dans la version 2.6.

Shell::runCommand($command, $argv)¶

Lance le Shell avec argv fourni.

Délègue les appels aux tâches et résoud les méthodes dans la classe. Les commandes sont regardées avec l’ordre suivant:

• Méthode sur le shell.

• Correspondance du nom de la tâche.

• méthode main().

Si un shell intègre une méthode main(), toute appel de méthode perdu sera envoyé à main() avec le nom de la méthode originale dans argv.

Shell::shortPath($file)¶

Rend les chemins de fichier absolus plus faciles à lire.

Shell::startup()¶

Démarre le Shell et affiche le message d’accueil. Permet de vérifier et de configurer avant de faire la commande ou l’exécution principale.

Redéfinit cette méthode si vous voulez retirer l’information de bienvenue, ou sinon modifier le pre-command flow.

Shell::wrapText($text, $options = array())¶

Entoure un block de texte. Vous permet de configurer la largeur, et d’indenter un block de texte.

Paramètres:

• $text (string) – Le text à formatter.

• $options (array) –

• width La largeur à entourer. Par défaut à 72.

• wordWrap Entoure seulement les espaces de mots. Par défaut à true.

• indent Indente le texte avec la chaîne de caractère fournie. Par défaut à null.

Plus de sujets¶