Added an article about private console commands

symfony · javiereguiluz · Oct 10, 2016 · Nov 19, 2016 · Nov 19, 2016 · Oct 10, 2016
commit 925609a9d97e90520f59baf782d4ea8bc8c8f22d
diff --git a/console/private_commands.rst b/console/private_commands.rst
@@ -0,0 +1,34 @@
+Creating Private Console Commands
+=================================
+
+Console commands are public by default, meaning that they are listed alongside
+other commands 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 **private** setting the
+``setPublic()`` method to ``false`` in the command configuration::
+
+    // src/AppBundle/Command/FooCommand.php
+    namespace AppBundle\Command;
+
+    use Symfony\Component\Console\Command\Command;
+
+    class FooCommand extends Command
+    {
+        protected function configure()
+        {
+            $this
+                ->setName('app:foo')
+                // ...
+                ->setPublic(false)
+            ;
+        }
+    }
+
+Private commands behave the same as public commands and they can be executed as
+before, but they are no longer displayed in command listings, so end-users are
+not aware of their existence.