feature #7052 Added an article about private console commands (javiereguiluz, wouterj)

xabbuh · xabbuh · commit b08bbd0c3c20 · 2017-01-10T21:11:18.000+01:00
This PR was submitted for the master branch but it was merged into the 3.2 branch instead (closes #7052). Discussion ---------- Added an article about private console commands This documents symfony/symfony#20029. Commits ------- d1cb043 Reflect private to hidden renaming in the file name 01f474f Reflect renaming from private to hidden 9415643 Added an article about private console commands
diff --git a/console/hide_commands.rst b/console/hide_commands.rst
@@ -0,0 +1,32 @@
+How to Hide Console Commands
+============================
+
+By default, all console commands are listed when executing the console application
+script without arguments or when using the ``list`` command.
+
+However, sometimes commands are not intended to be executed by end-users; for
+example, commands for the legacy parts of the application, commands exclusively
+executed through scheduled tasks, etc.
+
+In those cases, you can define the command as **hidden** by setting the
+``setHidden()`` method to ``true`` in the command configuration::
+
+    // src/AppBundle/Command/LegacyCommand.php
+    namespace AppBundle\Command;
+
+    use Symfony\Component\Console\Command\Command;
+
+    class LegacyCommand extends Command
+    {
+        protected function configure()
+        {
+            $this
+                ->setName('app:legacy')
+                ->setHidden(true)
+                // ...
+            ;
+        }
+    }
+
+Hidden commands behave the same as normal commands but they are no longer displayed
+in command listings, so end-users are not aware of their existence.
