8000 New Feature: Change the Default Command in the Console component by dcsg · Pull Request #3426 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

New Feature: Change the Default Command in the Console component #3426

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

Merged
merged 9 commits into from
Jan 9, 2014
Merged

New Feature: Change the Default Command in the Console component #3426

Show file tree
Hide file tree
Changes from 1 commit
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 Jan 4, 2014
11c7174
Added the version number where the setDefaultCommand was introduced
dcsg Jan 5, 2014
60e2b3e
Added the delete document to avoid broken urls and added a notice that
dcsg Jan 5, 2014
af9eac4
Changed the code to remove references to Symfony Framework since it's
dcsg Jan 5, 2014
730985f
Updated references to the new document
dcsg Jan 5, 2014
012456d
Moved `versionadded` to the right section
dcsg Jan 5, 2014
c23f34e
Applied some suggestions
dcsg Jan 5, 2014
5e97202
Applyed suggestions from @fabpot and @stof
dcsg Jan 7, 2014
c1b2aad
Applied suggestions from Ryan
dcsg Jan 9, 2014
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
Next Next commit
Documented the Change the Default Command in the Console component
  • Loading branch information
@dcsg
dcsg committed Jan 4, 2014
commit b29ab899a445a2686189a9266e6ec8fea4b3cae4
45 changes: 43 additions & 2 deletions components/console/single_command_tool.rst → ...nts/console/changing_default_behavior.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,49 @@
.. index::
single: Console; Single command application
single: Console; Changing the Default Behavior

Changing the Default Behavior
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This title does not describe what the doc is about (default behavior of what ? Any doc about extending a part of Symfony could use this title)

=============================

When building a command line tool, you may need to customize it to fit your needs.
Probably you want to change the Default Command that the Application runs or
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

default command (lowercased)

maybe you just want to run a Single Command instead of have to pass the command
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

single command (lowercased)

name each time. Fortunately it is possible to do both.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing comma after Fortunately I think


Changing the Default Command
----------------------------

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing .. version-added:: 2.5, saying "The setDefaultCommand method was introduced in Symfony 2.5."

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will add it 👍

By default the Application will always run the ListCommand. In order to change
the default command you just need to pass the command name you want to run by
< 8000 /td> default to the :method:`Symfony\\Component\\Console\\Application::setDefaultCommand`
method::

#!/usr/bin/env php
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm also not sure if the bang comment is used before in the docs, if not I prefer to remove it for consistency.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I copied it from the official documentation, more specific the introduction part of the Console Component

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, then we keep this.

<?php
// app/console
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you should remove this file comment, it's symfony specific and that's not something we do in the component docs.


use Acme\DemoBundle\Command\GreetCommand;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is also Symfony specific, use something like Acme\DemoLib\Command\GreetCommand

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kept the same logic that exists in the introduction documentation for the component, but I can change it. Let me know what will work better for it!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should not use Bundle in the components. Maybe just "Acme\Demo" (without Lib)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do agree, since components are separated from the Framework. But that would change all documentation for each component

use Symfony\Component\Console\Application;

$command = new GreetCommand();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where does it come from? When I read this document, I might not know about this command described in another part of the documentation. And anyway, this command won't work as a default command, which cannot have any argument... which is a "limitation" that should be explained in this doc.

$application = new Application();
$application->add($command);
$application->setDefaultCommand($command->getName());
$application->run()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing ;


Test the new console command by running the following

.. code-block:: bash

$ app/console Fabien
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That won't work as we are talking about replacing the default command, when there are no argument.


This will print the following to the command line:

.. code-block:: text

Hello Fabien

Building a Single Command Application
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should stay in a separate page, as it is a totally separate feature than changing the default command

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, I think the best solution is to keep it in its original location. It may be referenced from the page about changing the default command, to wanT than changing the default is not the best way if you only want 1 command, but it should not be in the same page IMO. It makes it harder to find the feature

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @stof

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1, and it would also solve the redirect_map problem I think :)

=====================================
-------------------------------------

When building a command line tool, you may not need to provide several commands.
In such case, having to pass the command name each time is tedious. Fortunately,
Expand Down
2 changes: 1 addition & 1 deletion components/console/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ Console

introduction
usage
single_command_tool
changing_default_behavior
events
helpers/index
0