Ubiquity commandes

Note

Cette partie est accessible à partir des webtools, donc si vous avez créé votre projet avec l’option -a ou avec la commande create-project.

Commandes

A partir des webtools, aller dans la partie commands,

ou directement à l’adresse http://127.0.0.1:8090/Admin/commands.

Liste des commandes

Activer l’onglet Commands pour obtenir la liste des commandes devtools.

Informations sur une commande

Il est possible d’obtenir de l’aide sur une commande (ce qui produit un résultat équivalent à Ubiquity help cmdName).

Exécution de commandes

Un clic sur le bouton run d’une commande affiche un formulaire pour saisir ses paramètres (ou l’exécute directement si elle n’en prend aucun).

Après avoir saisi les paramètres, l’exécution produit un résultat.

Suite de commandes

Retourner à l’onglet My commands : Il est possible de sauvegarder une séquence de commandes (avec des paramètres enregistrés), puis d’exécuter cette même séquence :

Création de suite

Cliquer sur add command suite

Ajouter les commandes souhaitées et modifier les paramètres :

La validation génère la suite :

Exécution d’une suite de commandes

En cliquant sur le bouton « run » de la suite, on exécute la liste des commandes qu’elle contient :

Création d’une commande personnalisée

Cliquer sur le bouton Create devtools command.

Saisir les caractéristiques de la nouvelle commande :

• Le nom de la commande

• Sa valeur : nom de l’argument principal

• Les paramètres de la commande : avec plusieurs paramètres, les séparer avec une virgule

• La description de la commande

• Les alias de la commande : En cas d’alias multiples, utilisez la virgule comme séparateur.

Note

Les commandes personnalisées sont créées dans le dossier app/commands du projet.

La classe générée :

app/commands/CreateArray.php

namespace commands;

use Ubiquity\devtools\cmd\commands\AbstractCustomCommand;
use Ubiquity\devtools\cmd\ConsoleFormatter;
use Ubiquity\devtools\cmd\Parameter;

class CreateArray extends AbstractCustomCommand {

     protected function getValue(): string {
             return 'jsonValue';
     }

     protected function getAliases(): array {
             return array("createarray","arrayFromJson");
     }

     protected function getName(): string {
             return 'createArray';
     }

     protected function getParameters(): array {
             return ['f' => Parameter::create('fLongName', 'The f description.', [])];
     }

     protected function getExamples(): array {
             return ['Sample use of createArray'=>'Ubiquity createArray jsonValue'];
     }

     protected function getDescription(): string {
             return 'Creates an array from JSON and save to file';
     }

     public function run($config, $options, $what, ...$otherArgs) {
             //TODO implement command behavior
             echo ConsoleFormatter::showInfo('Run createArray command');
     }
}

La commande CreateArray implémentée :

app/commands/CreateArray.php

namespace commands;

use Ubiquity\devtools\cmd\commands\AbstractCustomCommand;
use Ubiquity\devtools\cmd\ConsoleFormatter;
use Ubiquity\devtools\cmd\Parameter;
use Ubiquity\utils\base\UFileSystem;

class CreateArray extends AbstractCustomCommand {

     protected function getValue(): string {
             return 'jsonValue';
     }

     protected function getAliases(): array {
             return array(
                     "createarray",
                     "arrayFromJson"
             );
     }

     protected function getName(): string {
             return 'createArray';
     }

     protected function getParameters(): array {
             return [
                     'f' => Parameter::create('filename', 'The filename to create.', [])
             ];
     }

     protected function getExamples(): array {
             return [
                     'Save an array in test.php' => "Ubiquity createArray \"{\\\"created\\\":true}\" -f=test.php"
             ];
     }

     protected function getDescription(): string {
             return 'Creates an array from JSON and save to file';
     }

     public function run($config, $options, $what, ...$otherArgs) {
             echo ConsoleFormatter::showInfo('Run createArray command');
             $array = \json_decode($what, true);
             $error = \json_last_error();
             if ($error != 0) {
                     echo ConsoleFormatter::showMessage(\json_last_error_msg(), 'error');
             } else {
                     $filename = self::getOption($options, 'f', 'filename');
                     if ($filename != null) {
                             UFileSystem::save($filename, "<?php\nreturn " . var_export($array, true) . ";\n");
                             echo ConsoleFormatter::showMessage("$filename succefully created!", 'success', 'CreateArray');
                     } else {
                             echo ConsoleFormatter::showMessage("Filename must have a value!", 'error');
                     }
             }
     }
}

Exécution d’une commande personnalisée

La nouvelle commande est accessible depuis les devtools, à condition qu’elle soit bien présente dans le projet :

Ubiquity help createArray

Ubiquity createArray "{\"b\":true,\"i\":5,\"s\":\"string\"}" -f=test.php