Skip to content

Added an article about private console commands #7052

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Added an article about private console commands #7052

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
925609a
Added an article about private console commands
javiereguiluz Oct 10, 2016
0ff16d2
Reflect renaming from private to hidden
wouterj Nov 19, 2016
ad22aed
Reflect private to hidden renaming in the file name
wouterj Nov 19, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions console/hide_commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.