Fix #1242 : Commands description check, move generate:template command to developer console

bin/console

@@ -62,8 +62,8 @@ try {
     $cli->command(new \module_console_aboutAuthors('about:authors'));
     $cli->command(new \module_console_aboutLicense('about:license'));
 
-    $cli->command(new \module_console_checkExtension('check:extension'));
     $cli->command(new CheckConfig('check:config'));
+    $cli->command(new \module_console_checkExtension('check:extension'));
 
     $cli->command(new UpgradeDBDatas('system:upgrade-datas'));
 
@@ -72,7 +72,6 @@ try {
     $cli->command(new \module_console_systemMailCheck('system:mail-check'));
     $cli->command(new \module_console_systemBackupDB('system:backup-db'));
     $cli->command(new \module_console_systemClearCache('system:clear-cache'));
-    $cli->command(new \module_console_systemTemplateGenerator('system:template-generator'));
     $cli->command(new \module_console_systemExport('system:export'));
 
     $cli->command(new \module_console_taskrun('task:run'));
@@ -82,7 +81,7 @@ try {
     $cli->command(new \module_console_schedulerStop('scheduler:stop'));
     $cli->command(new \module_console_schedulerStart('scheduler:start'));
 
-    $cli->command(new Mailtest('mail:test'));
+    $cli->command(new MailTest('mail:test'));
 
     $cli->command(new \module_console_fieldsList('fields:list'));
     $cli->command(new \module_console_fieldsDelete('fields:delete'));

bin/developer

@@ -78,6 +78,7 @@ try {
     $cli->command(new Behat());
     $cli->command(new LessCompiler());
     $cli->command(new JavascriptBuilder());
+    $cli->command(new \module_console_systemTemplateGenerator('system:generate-templates'));
 
     $cli['console']->addCommands(array(
         // DBAL Commands

lib/Alchemy/Phrasea/Command/BuildMissingSubdefs.php

@@ -31,7 +31,7 @@ class BuildMissingSubdefs extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Build missing subviews');
+        $this->setDescription('Builds subviews that previously failed to be generated / did not exist when records were added');
 
         return $this;
     }

lib/Alchemy/Phrasea/Command/CheckConfig.php

@@ -33,7 +33,7 @@ class CheckConfig extends AbstractCheckCommand
     {
         parent::__construct($name);
 
-        $this->setDescription("Checks environment");
+        $this->setDescription("Performs a check against the environment and configuration. Give some advices for production settings.");
 
         return $this;
     }

lib/Alchemy/Phrasea/Command/Compile/Configuration.php

@@ -20,7 +20,7 @@ class Configuration extends Command
     public function __construct()
     {
         parent::__construct('compile:configuration');
-        $this->setDescription('Compile configuration');
+        $this->setDescription('Compiles YAML configuration to plain PHP');
     }
 
     protected function doExecute(InputInterface $input, OutputInterface $output)

lib/Alchemy/Phrasea/Command/CreateCollection.php

@@ -33,7 +33,7 @@ class CreateCollection extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Create a collection in Phraseanet')
+        $this->setDescription('Creates a collection in Phraseanet')
             ->setHelp('')
             ->addArgument('databox_id', InputArgument::REQUIRED, 'The id of the databox where to create the collection', null)
             ->addArgument('collname', InputArgument::REQUIRED, 'The name of the new collection', null)

lib/Alchemy/Phrasea/Command/Developer/APIRoutesDumper.php

@@ -19,6 +19,8 @@ class APIRoutesDumper extends AbstractRoutesDumper
     public function __construct()
     {
         parent::__construct('routes:dump-api');
+
+        $this->setDescription('Dumps Phraseanet API routes');
     }
 
     protected function doExecute(InputInterface $input, OutputInterface $output)

lib/Alchemy/Phrasea/Command/Developer/Behat.php

@@ -21,6 +21,8 @@ class Behat extends Command
     public function __construct()
     {
         parent::__construct('behat:help');
+
+        $this->setDescription('Prints helps about Phraseanet configuration for behat tests');
     }
 
     protected function doExecute(InputInterface $input, OutputInterface $output)

lib/Alchemy/Phrasea/Command/Developer/BowerInstall.php

@@ -26,7 +26,7 @@ class BowerInstall extends Command
         parent::__construct('dependencies:bower');
 
         $this
-            ->setDescription('Install bower dependencies')
+            ->setDescription('Installs bower dependencies')
             ->addOption('no-dev', 'd', InputOption::VALUE_NONE, 'Do not install dev dependencies')
             ->addOption('attempts', 'a', InputOption::VALUE_REQUIRED, 'Number of attempts to install dependencies.', 4);
     }

lib/Alchemy/Phrasea/Command/Developer/ComposerInstall.php

@@ -25,7 +25,7 @@ class ComposerInstall extends Command
         parent::__construct('dependencies:composer');
 
         $this
-            ->setDescription('Install composer dependencies')
+            ->setDescription('Installs composer dependencies')
             ->addOption('no-dev', 'd', InputOption::VALUE_NONE, 'Do not install dev dependencies')
             ->addOption('prefer-source', 'p', InputOption::VALUE_NONE, 'Use the --prefer-source composer option');
     }

lib/Alchemy/Phrasea/Command/Developer/InstallAll.php

@@ -23,7 +23,7 @@ class InstallAll extends Command
         parent::__construct('dependencies:all');
 
         $this
-            ->setDescription('Install all dependencies')
+            ->setDescription('Installs all dependencies')
             ->addOption('no-dev', 'd', InputOption::VALUE_NONE, 'Do not install dev dependencies')
             ->addOption('prefer-source', 'p', InputOption::VALUE_NONE, 'Use the --prefer-source composer option')
             ->addOption('attempts', 'a', InputOption::VALUE_REQUIRED, 'Number of attempts to install bower dependencies.', 4);

lib/Alchemy/Phrasea/Command/Developer/JavascriptBuilder.php

@@ -26,7 +26,7 @@ class JavascriptBuilder extends Command
     {
         parent::__construct('assets:build-javascript');
 
-        $this->setDescription('Compile less files');
+        $this->setDescription('Builds Phraseanet JavaScript files');
     }
 
     /**

lib/Alchemy/Phrasea/Command/Developer/LessCompiler.php

@@ -24,7 +24,7 @@ class LessCompiler extends Command
     {
         parent::__construct('assets:compile-less');
 
-        $this->setDescription('Compile less files');
+        $this->setDescription('Compiles Phraseanet LESS files');
     }
 
     /**

lib/Alchemy/Phrasea/Command/Developer/RegenerateSqliteDb.php

@@ -16,7 +16,7 @@ class RegenerateSqliteDb extends Command
     {
         parent::__construct('phraseanet:regenerate-sqlite');
 
-        $this->setDescription("Update the sqlite 'tests/db-ref.sqlite' database with current database definition.");
+        $this->setDescription("Updates the sqlite 'tests/db-ref.sqlite' database with current database definition.");
     }
 
     public function doExecute(InputInterface $input, OutputInterface $output)

lib/Alchemy/Phrasea/Command/Developer/RoutesDumper.php

@@ -19,6 +19,8 @@ class RoutesDumper extends AbstractRoutesDumper
     public function __construct()
     {
         parent::__construct('routes:dump');
+
+        $this->setDescription('Dumps Phraseanet routes');
     }
 
     protected function doExecute(InputInterface $input, OutputInterface $output)

lib/Alchemy/Phrasea/Command/MailTest.php

@@ -23,7 +23,9 @@ class MailTest extends Command
     {
         parent::__construct($name);
 
-        $this->addArgument('email', InputArgument::REQUIRED, 'An email where to send the test email');
+        $this
+            ->setDescription('Sends an email to a given address to test mail-server configuration')
+            ->addArgument('email', InputArgument::REQUIRED, 'An email where to send the test email');
     }
 
     protected function doExecute(InputInterface $input, OutputInterface $output)

lib/Alchemy/Phrasea/Command/RecordAdd.php

@@ -37,7 +37,7 @@ class RecordAdd extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Add a record to Phraseanet')
+        $this->setDescription('Adds a record to Phraseanet')
             ->setHelp('')
             ->addArgument('base_id', InputArgument::REQUIRED, 'The target collection id', null)
             ->addArgument('file', InputArgument::REQUIRED, 'The file to archive', null)

lib/Alchemy/Phrasea/Command/RescanTechnicalDatas.php

@@ -38,7 +38,7 @@ class RescanTechnicalDatas extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Rescan databases for technical datas');
+        $this->setDescription('Rescans records for technical datas');
         $this->setHelp('Old Phraseanet version did not fully read technical datas. This command rescan all records of these datas.');
 
         return $this;

lib/Alchemy/Phrasea/Command/Setup/CheckEnvironment.php

@@ -31,7 +31,7 @@ class CheckEnvironment extends AbstractCheckCommand
     {
         parent::__construct($name);
 
-        $this->setDescription("Check environment");
+        $this->setDescription("Performs a check against the environment");
 
         return $this;
     }

lib/Alchemy/Phrasea/Command/Setup/Install.php

@@ -30,7 +30,7 @@ class Install extends Command
         $this->executableFinder = new ExecutableFinder();
 
         $this
-            ->setDescription("Install Phraseanet")
+            ->setDescription("Installs Phraseanet")
             ->addOption('email', null, InputOption::VALUE_OPTIONAL, 'Admin e-mail address', null)
             ->addOption('password', null, InputOption::VALUE_OPTIONAL, 'Admin password', null)
             ->addOption('db-host', null, InputOption::VALUE_OPTIONAL, 'MySQL server host', 'localhost')

lib/Alchemy/Phrasea/Command/UpgradeDBDatas.php

@@ -32,7 +32,7 @@ class UpgradeDBDatas extends Command
         parent::__construct($name);
 
         $this
-            ->setDescription("Upgrade Phraseanet datas")
+            ->setDescription("Upgrades Phraseanet datas, useful after migrations")
             ->setHelp(<<<EOF
 Upgrade Phraseanet datas from older version
 

lib/classes/module/console/aboutAuthors.php

@@ -26,7 +26,7 @@ class module_console_aboutAuthors extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('List authors and contributors');
+        $this->setDescription('Lists authors and contributors');
 
         return $this;
     }

lib/classes/module/console/aboutLicense.php

@@ -26,7 +26,7 @@ class module_console_aboutLicense extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('This program license');
+        $this->setDescription('Displays this program license');
 
         return $this;
     }

lib/classes/module/console/checkExtension.php

@@ -29,7 +29,7 @@ class module_console_checkExtension extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Checks if the Phrasea PHP Extension is well installed & working properly.');
+        $this->setDescription('Performs a serie of tests against Phrasea Engine PHP Extension');
 
         $this->addArgument('usr_id', InputOption::VALUE_REQUIRED, 'Usr_id to use.');
 

lib/classes/module/console/fieldsDelete.php

@@ -27,7 +27,7 @@ class module_console_fieldsDelete extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Delete a documentation field from a Databox');
+        $this->setDescription('Deletes a documentation field from a Databox');
 
         $this->addArgument('meta_struct_id', InputArgument::REQUIRED, 'Metadata structure id destination');
         $this->addArgument('sbas_id', InputArgument::REQUIRED, 'Databox sbas_id');

lib/classes/module/console/fieldsList.php

@@ -26,7 +26,7 @@ class module_console_fieldsList extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('List all databoxes fields');
+        $this->setDescription('Lists all databoxes documentation fields');
 
         return $this;
     }

lib/classes/module/console/fieldsMerge.php

@@ -28,7 +28,7 @@ class module_console_fieldsMerge extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Merge databox structure fields');
+        $this->setDescription('Merges databox documentation fields');
 
         $this->addArgument('sbas_id', InputArgument::REQUIRED, 'Databox sbas_id');
         $this->addArgument('destination', InputArgument::REQUIRED, 'Metadata structure id destination');

lib/classes/module/console/fieldsRename.php

@@ -27,7 +27,7 @@ class module_console_fieldsRename extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Rename a documentation field from a Databox');
+        $this->setDescription('Renames a documentation field from a Databox');
 
         $this->addArgument('name', InputArgument::REQUIRED, 'The new name');
         $this->addArgument('meta_struct_id', InputArgument::REQUIRED, 'Metadata structure id destination');

lib/classes/module/console/schedulerStart.php

@@ -29,7 +29,7 @@ class module_console_schedulerStart extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Start the scheduler');
+        $this->setDescription('Starts Phraseanet scheduler');
 
         return $this;
     }

lib/classes/module/console/schedulerState.php

@@ -36,7 +36,7 @@ class module_console_schedulerState extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Get scheduler status');
+        $this->setDescription('Returns Phraseanet scheduler status');
 
         $this->addOption(
             'short'

lib/classes/module/console/schedulerStop.php

@@ -26,7 +26,7 @@ class module_console_schedulerStop extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Stop the scheduler');
+        $this->setDescription('Stops Phraseanet scheduler');
 
         return $this;
     }

lib/classes/module/console/sphinxGenerateSuggestion.php

@@ -28,7 +28,7 @@ class module_console_sphinxGenerateSuggestion extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Generate suggestions for Sphinx Search Engine');
+        $this->setDescription('Generates suggestions for Sphinx Search Engine, useful for query auto-completion');
 
         return $this;
     }

lib/classes/module/console/systemBackupDB.php

@@ -34,7 +34,7 @@ class module_console_systemBackupDB extends Command
         );
 
         $this
-            ->setDescription('Backup Phraseanet Databases')
+            ->setDescription('Backups Phraseanet Databases')
             ->addArgument('directory', null, 'The directory where to backup', $dir)
             ->addOption('timeout', 't', InputOption::VALUE_REQUIRED, 'The timeout for this command (default is 3600s / 1h). Set 0 to disable timeout.', 3600)
             ->addOption('gzip', 'g', null, 'Gzip the output (requires gzip utility)')

lib/classes/module/console/systemClearCache.php

@@ -27,7 +27,7 @@ class module_console_systemClearCache extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Empty cache directories, clear Memcached, Redis if avalaible');
+        $this->setDescription('Empties cache directories and cache-server data');
 
         return $this;
     }

lib/classes/module/console/systemExport.php

@@ -27,7 +27,7 @@ class module_console_systemExport extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Export all phraseanet records to a directory');
+        $this->setDescription('Exports all phraseanet records to a given directory');
 
         /**
          * To implement

lib/classes/module/console/systemMailCheck.php

@@ -27,7 +27,7 @@ class module_console_systemMailCheck extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Check if email addresses are unique (mandatory since 3.5)');
+        $this->setDescription('Checks if email addresses are uniques (mandatory since 3.5)');
         $this->addOption('list'
             , 'l'
             , null

lib/classes/module/console/systemTemplateGenerator.php

@@ -28,7 +28,7 @@ class module_console_systemTemplateGenerator extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('Generate template files');
+        $this->setDescription('Generates Twig templates files');
 
         return $this;
     }

lib/classes/module/console/systemUpgrade.php

@@ -29,7 +29,7 @@ class module_console_systemUpgrade extends Command
         parent::__construct($name);
 
         $this
-            ->setDescription('Upgrade Phraseanet to the latest version')
+            ->setDescription('Upgrades Phraseanet to the latest version')
             ->addOption('yes', 'y', InputOption::VALUE_NONE, 'Answers yes to all questions and do not ask the user')
             ->addOption('force', 'f', InputOption::VALUE_NONE, 'Forces the upgrade even if there is a concurrent upgrade')
             ->addOption('dump', 'd', InputOption::VALUE_NONE, 'Dumps SQL queries that can be used to clean database.');

lib/classes/module/console/taskState.php

@@ -45,7 +45,7 @@ class module_console_taskState extends Command
 
         $this->addArgument('task_id', InputArgument::REQUIRED, 'The task_id to test');
 
-        $this->setDescription('Get task state');
+        $this->setDescription('Returns a Phraseanet task state given its id');
 
         $this->addOption(
             'short'

lib/classes/module/console/tasklist.php

@@ -27,7 +27,7 @@ class module_console_tasklist extends Command
     {
         parent::__construct($name);
 
-        $this->setDescription('List tasks');
+        $this->setDescription('Lists Phraseanet tasks');
 
         return $this;
     }

lib/classes/module/console/taskrun.php

@@ -53,7 +53,7 @@ class module_console_taskrun extends Command
                 'threshold : (DEBUG|INFO|WARNING|ERROR|CRITICAL|ALERT)',
                 ''
             )
-            ->setDescription('Run task');
+            ->setDescription('Runs a Phraseanet task given its id');
 
         return $this;
     }