-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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.
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
New Feature: Change the Default Command in the Console component #3426
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
b29ab89
Documented the Change the Default Command in the Console component
dcsg 11c7174
Added the version number where the setDefaultCommand was introduced
dcsg 60e2b3e
Added the delete document to avoid broken urls and added a notice that
dcsg af9eac4
Changed the code to remove references to Symfony Framework since it's
dcsg 730985f
Updated references to the new document
dcsg 012456d
Moved `versionadded` to the right section
dcsg c23f34e
Applied some suggestions
dcsg 5e97202
Applyed suggestions from @fabpot and @stof
dcsg c1b2aad
Applied suggestions from Ryan
dcsg File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
.. index:: | ||
single: Console; Changing the Default Command | ||
|
||
Changing the Default Command | ||
============================ | ||
|
||
.. versionadded:: 2.5, | ||
The :method:`Symfony\\Component\\Console\\Application::setDefaultCommand` | ||
method was introduced in version 2.5. | ||
|
||
will always run the ``ListCommand`` when no command name is passed. In order to change | ||
the default command you just need to pass the command name you want to run by | ||
default to the ``setDefaultCommand`` method:: | ||
|
||
namespace Acme\Command; | ||
|
||
use Symfony\Component\Console\Command\Command; | ||
use Symfony\Component\Console\Input\InputInterface; | ||
use Symfony\Component\Console\Output\OutputInterface; | ||
|
||
class HelloWorldCommand extends Command | ||
{ | ||
protected function configure() | ||
{ | ||
$this->setName('hello:world') | ||
->setDescription('Outputs \'Hello World\''); | ||
} | ||
|
||
protected function execute(InputInterface $input, OutputInterface $output) | ||
{ | ||
$output->writeln('Hello World'); | ||
} | ||
} | ||
|
||
Executing the application and changing the default Command:: | ||
|
||
// application.php | ||
|
||
use Acme\Command\HelloWorldCommand; | ||
use Symfony\Component\Console\Application; | ||
|
||
$command = new HelloWorldCommand(); | ||
$application = new Application(); | ||
$application->add($command); | ||
$application->setDefaultCommand($command->getName()); | ||
$application->run(); | ||
|
||
Test the new default console command by running the following: | ||
|
||
.. code-block:: bash | ||
|
||
$ php application.php | ||
|
||
This will print the following to the command line: | ||
|
||
.. code-block:: text | ||
|
||
Hello Fabien | ||
|
||
.. tip:: | ||
|
||
This feature has a limitation: you cannot use it with any Command arguments. | ||
|
||
Learn More! | ||
----------- | ||
|
||
* :doc:`/components/console/single_command_tool` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,7 @@ Console | |
|
||
introduction | ||
usage | ||
changing_default_command | ||
single_command_tool | ||
events | ||
helpers/index |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
apparently the indentation here was not correct before. Now is consistent with the other documents.