feature #23887 [Console] Allow commands to provide a default name for compile time registration (chalasr, nicolas-grekas)

fabpot · fabpot · commit 2210dccd1586 · 2017-08-24T14:10:36.000-07:00
This PR was merged into the 3.4 branch. Discussion ---------- [Console] Allow commands to provide a default name for compile time registration | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #23796 | License | MIT | Doc PR | symfony/symfony-docs#8147 Commits ------- eda7d42955 [Console] Add protected static $defaultName to set the default name of a Command 5d9ae6b56f [Console] Allow commands to provide a default name for compile time registration
diff --git a/Command/AboutCommand.php b/Command/AboutCommand.php
@@ -28,15 +28,14 @@
  */
 class AboutCommand extends ContainerAwareCommand
 {
+    protected static $defaultName = 'about';
+
     /**
      * {@inheritdoc}
      */
     protected function configure()
     {
-        $this
-            ->setName('about')
-            ->setDescription('Displays information about the current project')
-        ;
+        $this->setDescription('Displays information about the current project');
     }
 
     /**
diff --git a/Command/AssetsInstallCommand.php b/Command/AssetsInstallCommand.php
@@ -35,6 +35,8 @@ class AssetsInstallCommand extends ContainerAwareCommand
     const METHOD_ABSOLUTE_SYMLINK = 'absolute symlink';
     const METHOD_RELATIVE_SYMLINK = 'relative symlink';
 
+    protected static $defaultName = 'assets:install';
+
     private $filesystem;
 
     /**
@@ -61,7 +63,6 @@ public function __construct($filesystem = null)
     protected function configure()
     {
         $this
-            ->setName('assets:install')
             ->setDefinition(array(
                 new InputArgument('target', InputArgument::OPTIONAL, 'The target directory', 'public'),
             ))
diff --git a/Command/CacheClearCommand.php b/Command/CacheClearCommand.php
@@ -32,6 +32,8 @@
  */
 class CacheClearCommand extends ContainerAwareCommand
 {
+    protected static $defaultName = 'cache:clear';
+
     private $cacheClearer;
     private $filesystem;
     private $warning;
@@ -62,7 +64,6 @@ public function __construct($cacheClearer = null, Filesystem $filesystem = null)
     protected function configure()
     {
         $this
-            ->setName('cache:clear')
             ->setDefinition(array(
                 new InputOption('no-warmup', '', InputOption::VALUE_NONE, 'Do not warm up the cache'),
                 new InputOption('no-optional-warmers', '', InputOption::VALUE_NONE, 'Skip optional cache warmers (faster)'),
diff --git a/Command/CachePoolClearCommand.php b/Command/CachePoolClearCommand.php
@@ -25,6 +25,8 @@
  */
 final class CachePoolClearCommand extends ContainerAwareCommand
 {
+    protected static $defaultName = 'cache:pool:clear';
+
     private $poolClearer;
 
     /**
@@ -51,7 +53,6 @@ public function __construct($poolClearer = null)
     protected function configure()
     {
         $this
-            ->setName('cache:pool:clear')
             ->setDefinition(array(
                 new InputArgument('pools', InputArgument::IS_ARRAY | InputArgument::REQUIRED, 'A list of cache pools or cache pool clearers'),
             ))
diff --git a/Command/CachePoolPruneCommand.php b/Command/CachePoolPruneCommand.php
@@ -24,6 +24,8 @@
  */
 final class CachePoolPruneCommand extends Command
 {
+    protected static $defaultName = 'cache:pool:prune';
+
     private $pools;
 
     /**
@@ -42,7 +44,6 @@ public function __construct($pools)
     protected function configure()
     {
         $this
-            ->setName('cache:pool:prune')
             ->setDescription('Prune cache pools')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command deletes all expired items from all pruneable pools.
diff --git a/Command/CacheWarmupCommand.php b/Command/CacheWarmupCommand.php
@@ -26,6 +26,8 @@
  */
 class CacheWarmupCommand extends ContainerAwareCommand
 {
+    protected static $defaultName = 'cache:warmup';
+
     private $cacheWarmer;
 
     /**
@@ -52,7 +54,6 @@ public function __construct($cacheWarmer = null)
     protected function configure()
     {
         $this
-            ->setName('cache:warmup')
             ->setDefinition(array(
                 new InputOption('no-optional-warmers', '', InputOption::VALUE_NONE, 'Skip optional cache warmers (faster)'),
             ))
diff --git a/Command/ConfigDebugCommand.php b/Command/ConfigDebugCommand.php
@@ -28,13 +28,14 @@
  */
 class ConfigDebugCommand extends AbstractConfigCommand
 {
+    protected static $defaultName = 'debug:config';
+
     /**
      * {@inheritdoc}
      */
     protected function configure()
     {
         $this
-            ->setName('debug:config')
             ->setDefinition(array(
                 new InputArgument('name', InputArgument::OPTIONAL, 'The bundle name or the extension alias'),
                 new InputArgument('path', InputArgument::OPTIONAL, 'The configuration option path'),
diff --git a/Command/ConfigDumpReferenceCommand.php b/Command/ConfigDumpReferenceCommand.php
@@ -30,13 +30,14 @@
  */
 class ConfigDumpReferenceCommand extends AbstractConfigCommand
 {
+    protected static $defaultName = 'config:dump-reference';
+
     /**
      * {@inheritdoc}
      */
     protected function configure()
     {
         $this
-            ->setName('config:dump-reference')
             ->setDefinition(array(
                 new InputArgument('name', InputArgument::OPTIONAL, 'The Bundle name or the extension alias'),
                 new InputArgument('path', InputArgument::OPTIONAL, 'The configuration option path'),
diff --git a/Command/ContainerDebugCommand.php b/Command/ContainerDebugCommand.php
@@ -32,6 +32,8 @@
  */
 class ContainerDebugCommand extends ContainerAwareCommand
 {
+    protected static $defaultName = 'debug:container';
+
     /**
      * @var ContainerBuilder|null
      */
@@ -43,7 +45,6 @@ class ContainerDebugCommand extends ContainerAwareCommand
     protected function configure()
     {
         $this
-            ->setName('debug:container')
             ->setDefinition(array(
                 new InputArgument('name', InputArgument::OPTIONAL, 'A service name (foo)'),
                 new InputOption('show-private', null, InputOption::VALUE_NONE, 'Used to show public *and* private services'),
diff --git a/Command/EventDispatcherDebugCommand.php b/Command/EventDispatcherDebugCommand.php
@@ -28,6 +28,7 @@
  */
 class EventDispatcherDebugCommand extends ContainerAwareCommand
 {
+    protected static $defaultName = 'debug:event-dispatcher';
     private $dispatcher;
 
     /**
@@ -54,7 +55,6 @@ public function __construct($dispatcher = null)
     protected function configure()
     {
         $this
-            ->setName('debug:event-dispatcher')
             ->setDefinition(array(
                 new InputArgument('event', InputArgument::OPTIONAL, 'An event name'),
                 new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format  (txt, xml, json, or md)', 'txt'),
diff --git a/Command/RouterDebugCommand.php b/Command/RouterDebugCommand.php
@@ -32,6 +32,7 @@
  */
 class RouterDebugCommand extends ContainerAwareCommand
 {
+    protected static $defaultName = 'debug:router';
     private $router;
 
     /**
@@ -79,7 +80,6 @@ public function isEnabled()
     protected function configure()
     {
         $this
-            ->setName('debug:router')
             ->setDefinition(array(
                 new InputArgument('name', InputArgument::OPTIONAL, 'A route name'),
                 new InputOption('show-controllers', null, InputOption::VALUE_NONE, 'Show assigned controllers in overview'),
diff --git a/Command/RouterMatchCommand.php b/Command/RouterMatchCommand.php
@@ -29,6 +29,8 @@
  */
 class RouterMatchCommand extends ContainerAwareCommand
 {
+    protected static $defaultName = 'router:match';
+
     private $router;
 
     /**
@@ -76,7 +78,6 @@ public function isEnabled()
     protected function configure()
     {
         $this
-            ->setName('router:match')
             ->setDefinition(array(
                 new InputArgument('path_info', InputArgument::REQUIRED, 'A path info'),
                 new InputOption('method', null, InputOption::VALUE_REQUIRED, 'Sets the HTTP method'),
diff --git a/Command/TranslationDebugCommand.php b/Command/TranslationDebugCommand.php
@@ -40,6 +40,8 @@ class TranslationDebugCommand extends ContainerAwareCommand
     const MESSAGE_UNUSED = 1;
     const MESSAGE_EQUALS_FALLBACK = 2;
 
+    protected static $defaultName = 'debug:translation';
+
     private $translator;
     private $loader;
     private $extractor;
@@ -72,7 +74,6 @@ public function __construct($translator = null, TranslationLoader $loader = null
     protected function configure()
     {
         $this
-            ->setName('debug:translation')
             ->setDefinition(array(
                 new InputArgument('locale', InputArgument::REQUIRED, 'The locale'),
                 new InputArgument('bundle', InputArgument::OPTIONAL, 'The bundle name or directory where to load the messages, defaults to app/Resources folder'),
diff --git a/Command/TranslationUpdateCommand.php b/Command/TranslationUpdateCommand.php
@@ -33,6 +33,8 @@
  */
 class TranslationUpdateCommand extends ContainerAwareCommand
 {
+    protected static $defaultName = 'translation:update';
+
     private $writer;
     private $loader;
     private $extractor;
@@ -68,7 +70,6 @@ public function __construct($writer = null, TranslationLoader $loader = null, Ex
     protected function configure()
     {
         $this
-            ->setName('translation:update')
             ->setDefinition(array(
                 new InputArgument('locale', InputArgument::REQUIRED, 'The locale'),
                 new InputArgument('bundle', InputArgument::OPTIONAL, 'The bundle name or directory where to load the messages, defaults to app/Resources folder'),
diff --git a/Command/WorkflowDumpCommand.php b/Command/WorkflowDumpCommand.php
@@ -25,6 +25,8 @@
  */
 class WorkflowDumpCommand extends ContainerAwareCommand
 {
+    protected static $defaultName = 'workflow:dump';
+
     /**
      * {@inheritdoc}
      *
@@ -41,7 +43,6 @@ public function isEnabled()
     protected function configure()
     {
         $this
-            ->setName('workflow:dump')
             ->setDefinition(array(
                 new InputArgument('name', InputArgument::REQUIRED, 'A workflow name'),
                 new InputArgument('marking', InputArgument::IS_ARRAY, 'A marking (a list of places)'),
diff --git a/Command/XliffLintCommand.php b/Command/XliffLintCommand.php
@@ -24,6 +24,8 @@
  */
 class XliffLintCommand extends BaseLintCommand
 {
+    protected static $defaultName = 'lint:xliff';
+
     public function __construct($name = null, $directoryIteratorProvider = null, $isReadableProvider = null)
     {
         if (func_num_args()) {
diff --git a/Command/YamlLintCommand.php b/Command/YamlLintCommand.php
@@ -23,6 +23,8 @@
  */
 class YamlLintCommand extends BaseLintCommand
 {
+    protected static $defaultName = 'lint:yaml';
+
     public function __construct($name = null, $directoryIteratorProvider = null, $isReadableProvider = null)
     {
         if (func_num_args()) {

Original file line number	Diff line number	Diff line change
`@@ -28,15 +28,14 @@`
`28`	`28`	`*/`
`29`	`29`	`class AboutCommand extends ContainerAwareCommand`
`30`	`30`	`{`
	`31`	`+ protected static $defaultName = 'about';`
	`32`	`+`
`31`	`33`	`/**`
`32`	`34`	`* {@inheritdoc}`
`33`	`35`	`*/`
`34`	`36`	`protected function configure()`
`35`	`37`	`{`
`36`		`- $this`
`37`		`- ->setName('about')`
`38`		`- ->setDescription('Displays information about the current project')`
`39`		`- ;`
	`38`	`+ $this->setDescription('Displays information about the current project');`
`40`	`39`	`}`
`41`	`40`
`42`	`41`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@`
`28`	`28`	`*/`
`29`	`29`	`class EventDispatcherDebugCommand extends ContainerAwareCommand`
`30`	`30`	`{`
	`31`	`+ protected static $defaultName = 'debug:event-dispatcher';`
`31`	`32`	`private $dispatcher;`
`32`	`33`
`33`	`34`	`/**`
`@@ -54,7 +55,6 @@ public function __construct($dispatcher = null)`
`54`	`55`	`protected function configure()`
`55`	`56`	`{`
`56`	`57`	`$this`
`57`		`- ->setName('debug:event-dispatcher')`
`58`	`58`	`->setDefinition(array(`
`59`	`59`	`new InputArgument('event', InputArgument::OPTIONAL, 'An event name'),`
`60`	`60`	`new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt'),`