Skip to content
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

Removed code references to Symfony Standard Distribution #3427

Merged
merged 1 commit into from
Jan 9, 2014
Merged

Removed code references to Symfony Standard Distribution #3427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 15 additions & 14 deletions components/console/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Creating a basic Command
To make a console command that greets you from the command line, create ``GreetCommand.php``
and add the following to it::

namespace Acme\DemoBundle\Command;
namespace Acme\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
Expand Down Expand Up @@ -86,9 +86,9 @@ an ``Application`` and adds commands to it::

#!/usr/bin/env php
<?php
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 tag too, it breaks highlighting.

Copy link
Member Author

Choose a reason for hiding this comment

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

done!

// app/console
// application.php

use Acme\DemoBundle\Command\GreetCommand;
use Acme\Command\GreetCommand;
use Symfony\Component\Console\Application;

$application = new Application();
Expand All @@ -99,7 +99,7 @@ Test the new console command by running the following

.. code-block:: bash

$ app/console demo:greet Fabien
$ php application.php demo:greet Fabien
Copy link
Contributor

Choose a reason for hiding this comment

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

why not just php console ... ? presents better practices? with the shebang

Copy link
Member

Choose a reason for hiding this comment

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

Windows does not support the shebang, so you have to generate a bat file for that (or Composer does it for you). To make this example simple, I suggest doing it this way.


This will print the following to the command line:

Expand All @@ -111,7 +111,7 @@ You can also use the ``--yell`` option to make everything uppercase:

.. code-block:: bash

$ app/console demo:greet Fabien --yell
$ php application.php demo:greet Fabien --yell

This prints::

Expand Down Expand Up @@ -232,8 +232,8 @@ The command can now be used in either of the following ways:

.. code-block:: bash

$ app/console demo:greet Fabien
$ app/console demo:greet Fabien Potencier
$ php application.php demo:greet Fabien
$ php application.php demo:greet Fabien Potencier

It is also possible to let an argument take a list of values (imagine you want
to greet all your friends). For this it must be specified at the end of the
Expand All @@ -251,7 +251,7 @@ To use this, just specify as many names as you want:

.. code-block:: bash

$ app/console demo:greet Fabien Ryan Bernhard
$ php application.php demo:greet Fabien Ryan Bernhard

You can access the ``names`` argument as an array::

Expand Down Expand Up @@ -321,8 +321,8 @@ flag:

.. code-block:: bash

$ app/console demo:greet Fabien
$ app/console demo:greet Fabien --iterations=5
$ php application.php demo:greet Fabien
$ php application.php demo:greet Fabien --iterations=5

The first example will only print once, since ``iterations`` is empty and
defaults to ``1`` (the last argument of ``addOption``). The second example
Expand All @@ -333,8 +333,8 @@ will work:

.. code-block:: bash

$ app/console demo:greet Fabien --iterations=5 --yell
$ app/console demo:greet Fabien --yell --iterations=5
$ php application.php demo:greet Fabien --iterations=5 --yell
$ php application.php demo:greet Fabien --yell --iterations=5

There are 4 option variants you can use:

Expand Down Expand Up @@ -380,9 +380,9 @@ useful one is the :class:`Symfony\\Component\\Console\\Tester\\CommandTester`
class. It uses special input and output classes to ease testing without a real
console::

use Acme\Command\GreetCommand;
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Tester\CommandTester;
use Acme\DemoBundle\Command\GreetCommand;

class ListCommandTest extends \PHPUnit_Framework_TestCase
{
Expand All @@ -409,9 +409,9 @@ You can test sending arguments and options to the command by passing them
as an array to the :method:`Symfony\\Component\\Console\\Tester\\CommandTester::execute`
method::

use Acme\Command\GreetCommand;
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Tester\CommandTester;
use Acme\DemoBundle\Command\GreetCommand;

class ListCommandTest extends \PHPUnit_Framework_TestCase
{
Expand Down Expand Up @@ -491,6 +491,7 @@ Learn More!

* :doc:`/components/console/usage`
* :doc:`/components/console/single_command_tool`
* :doc:`/components/console/events`

.. _Packagist: https://packagist.org/packages/symfony/console
.. _ANSICON: https://github.com/adoxa/ansicon/downloads
1 change: 1 addition & 0 deletions components/console/single_command_tool.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ You can also simplify how you execute the application::
#!/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.

What's the reason behind moving this?

Copy link
Member Author

Choose a reason for hiding this comment

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

Windows does not support the shebang, so you have to generate a bat file for that (or Composer does it for you). To make this example simple, I suggest doing it this way.

@weaverryan: basically what @wouterj said above

Copy link
Member

Choose a reason for hiding this comment

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

But does the presence of this hurt Windows? From what I know (and I suck at Windows :P), if we have this, then shebang is possible on Unix (but not on Windows). Without this, shebang is not possible on either system. So even though we're not using the shebang syntax in this entry, having this still makes shebang possible, which seems like a good thing.

Thanks Daniel :)

Copy link
Member

Choose a reason for hiding this comment

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

Well, it doesn't hurt with Windows. The only problem is that you can't execute the code on Windows. That's why I suggested removing the shebang and using php the_file.php, so all people can follow the article, independent from their OS.

Copy link
Member

Choose a reason for hiding this comment

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

it does not hurt on Windows. PHP is smart enough to avoid sending it to the output. It simply means that Windows users either need to

  • create a bat file (generally letting composer do it as it is easier)
  • run it with PHP explicitly (as described in the doc)
  • use GitBash or Cygwin for their console, and then profit of the Unix shebang

Copy link
Member

Choose a reason for hiding this comment

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

@wouterj I suggest keeping the shebang while still calling PHP explicitly in the doc

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 agree with @stof. If using the php the_file.php in Windows works with the shebang there is no need to remove it.

If you all agree I will revert the changes of the shebang?

/cc @wouterj @weaverryan

Copy link
Member

Choose a reason for hiding this comment

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

+1 :)

Copy link
Member

Choose a reason for hiding this comment

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

well, if everyone likes it: let's do it!

<?php
// command.php

use Acme\Tool\MyApplication;

$application = new MyApplication();
Expand Down
48 changes: 24 additions & 24 deletions components/console/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ built-in options as well as a couple of built-in commands for the Console compon

.. note::

These examples assume you have added a file ``app/console`` to run at
These examples assume you have added a file ``application.php`` to run at
the cli::

#!/usr/bin/env php
# app/console
<?php
// application.php

use Symfony\Component\Console\Application;

Expand All @@ -30,26 +30,26 @@ and the registered commands:

.. code-block:: bash

$ php app/console list
$ php application.php list

You can get the same output by not running any command as well

.. code-block:: bash

$ php app/console
$ php application.php

The help command lists the help information for the specified command. For
example, to get the help for the ``list`` command:

.. code-block:: bash

$ php app/console help list
$ php application.php help list

Running ``help`` without specifying a command will list the global options:

.. code-block:: bash

$ php app/console help
$ php application.php help

Global Options
~~~~~~~~~~~~~~
Expand All @@ -59,33 +59,33 @@ get help for the list command:

.. code-block:: bash

$ php app/console list --help
$ php app/console list -h
$ php application.php list --help
$ php application.php list -h

You can suppress output with:

.. code-block:: bash

$ php app/console list --quiet
$ php app/console list -q
$ php application.php list --quiet
$ php application.php list -q

You can get more verbose messages (if this is supported for a command)
with:

.. code-block:: bash

$ php app/console list --verbose
$ php app/console list -v
$ php application.php list --verbose
$ php application.php list -v

The verbose flag can optionally take a value between 1 (default) and 3 to
output even more verbose messages:

.. code-block:: bash

$ php app/console list --verbose=2
$ php app/console list -vv
$ php app/console list --verbose=3
$ php app/console list -vvv
$ php application.php list --verbose=2
$ php application.php list -vv
$ php application.php list --verbose=3
$ php application.php list -vvv

If you set the optional arguments to give your application a name and version::

Expand All @@ -95,8 +95,8 @@ then you can use:

.. code-block:: bash

$ php app/console list --version
$ php app/console list -V
$ php application.php list --version
$ php application.php list -V

to get this information output:

Expand All @@ -114,20 +114,20 @@ You can force turning on ANSI output coloring with:

.. code-block:: bash

$ php app/console list --ansi
$ php application.php list --ansi

or turn it off with:

.. code-block:: bash

$ php app/console list --no-ansi
$ php application.php list --no-ansi

You can suppress any interactive questions from the command you are running with:

.. code-block:: bash

$ php app/console list --no-interaction
$ php app/console list -n
$ php application.php list --no-interaction
$ php application.php list -n

Shortcut Syntax
~~~~~~~~~~~~~~~
Expand All @@ -138,7 +138,7 @@ commands, then you can run ``help`` like this:

.. code-block:: bash

$ php app/console h
$ php application.php h

If you have commands using ``:`` to namespace commands then you just have
to type the shortest unambiguous text for each part. If you have created the
Expand All @@ -147,7 +147,7 @@ can run it with:

.. code-block:: bash

$ php app/console d:g Fabien
$ php application.php d:g Fabien

If you enter a short command that's ambiguous (i.e. there are more than one
command that match), then no command will be run and some suggestions of
Expand Down