Skip to content

Patches end of page #3459

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

Closed
wants to merge 32 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
d9c6a85
add empty_data option where required option is used
xabbuh Jan 3, 2014
9b1aab8
add missing code-block directive
xabbuh Jan 3, 2014
244d756
add note when forbidding access to anonymous users on custom authenti…
cordoval Jan 4, 2014
2888d00
answer some questions and clarify the best chapter imo from the symfo…
cordoval Jan 4, 2014
771b862
address comments from @WouterJ
cordoval Jan 5, 2014
8cfb850
[Reference][Form Types] Document "with_minutes" time/datetime option
bicpi Jan 6, 2014
1e88b9d
Fix "versionadded" position
bicpi Jan 6, 2014
2156545
add max_length to form field type
nykopol Jan 6, 2014
391fe30
fix typo in previous commit
nykopol Jan 7, 2014
d6800d3
fix typo in previous commit
nykopol Jan 7, 2014
b53a227
fix last typo on max length option
nykopol Jan 7, 2014
e255de9
minor #3429 [Reference][Form Types] Document "with_minutes" time/date…
weaverryan Jan 7, 2014
559a227
Fix issue #3442
ifdattic Jan 8, 2014
8f3e6c7
[#3407] Adding a missing section via tip from @WouterJ
weaverryan Jan 9, 2014
e1d344f
[Contributing] Clarify the rebase operation
lemoinem Jan 4, 2014
4544ea1
[Contributing] Fix single vs double backtick issues
lemoinem Jan 4, 2014
d5009c1
[Contributing] Add PSR-1 and 2 links
lemoinem Jan 4, 2014
1a670d1
[Contributing] Replace mentions of 2.2 for 2.3
lemoinem Jan 4, 2014
806a86f
[Contributing] Fix "When you finish" => "When you are finished"
lemoinem Jan 6, 2014
13222c9
[Contributing] Replace HEAD~3 by upstream/master
lemoinem Jan 6, 2014
2be3f52
minor #3422 [Cookbook][Custom Authentication Provider] add a note of …
weaverryan Jan 9, 2014
26a7b1b
bug #3423 [Session Configuration] add clarifying notes on session sav…
weaverryan Jan 9, 2014
4988118
bug #3432 [Reference][Form Types] Add "max_length" option in form typ…
weaverryan Jan 9, 2014
0b2a491
bug #3414 add missing code-block directive (xabbuh)
weaverryan Jan 9, 2014
69a2ed1
the data_class option was not introduced in 2.4
xabbuh Jan 3, 2014
26b8146
bug #3415 [#3334] the data_class option was not introduced in 2.4 (xa…
weaverryan Jan 9, 2014
1e0311e
minor #3416 add empty_data option where required option is used (xabbuh)
weaverryan Jan 9, 2014
4fd7022
Removed code references to Symfony Standard Distribution
dcsg Jan 9, 2014
9e2e64b
bug #3427 Removed code references to Symfony Standard Distribution (d…
weaverryan Jan 9, 2014
d9d7c58
bug #3444 Fix issue #3442 (ifdattic)
weaverryan Jan 10, 2014
42c80d1
bug #3448 Overridden tweak (weaverryan)
weaverryan Jan 10, 2014
d5ab588
Removed spaces at the beginning of the final paragraph
alexislefebvre Jan 10, 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
29 changes: 15 additions & 14 deletions components/console/introduction.rst
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
// 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

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
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
<?php
// command.php

use Acme\Tool\MyApplication;

$application = new MyApplication();
Expand Down
48 changes: 24 additions & 24 deletions components/console/usage.rst
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
13 changes: 10 additions & 3 deletions components/http_foundation/session_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,12 @@ PHP or provided by PHP extensions, such as PHP-Sqlite, PHP-Memcached and so on.
All native save handlers are internal to PHP and as such, have no public facing API.
They must be configured by ``php.ini`` directives, usually ``session.save_path`` and
potentially other driver specific directives. Specific details can be found in
docblock of the ``setOptions()`` method of each class.
the docblock of the ``setOptions()`` method of each class. For instance, the one
provided by the Memcached extension can be found on `php.net/memcached.setoption`_

While native save handlers can be activated by directly using
``ini_set('session.save_handler', $name);``, Symfony2 provides a convenient way to
activate these in the same way as custom handlers.
activate these in the same way as it does for custom handlers.

Symfony2 provides drivers for the following native save handler as an example:

Expand Down Expand Up @@ -61,7 +62,7 @@ Example usage::
Custom Save Handlers
--------------------

Custom handlers are those which completely replace PHP's built in session save
Custom handlers are those which completely replace PHP's built-in session save
handlers by providing six callback functions which PHP calls internally at
various points in the session workflow.

Expand Down Expand Up @@ -234,6 +235,11 @@ PHP 5.4 functionality if it is available.
Save Handler Proxy
~~~~~~~~~~~~~~~~~~

A Save Handler Proxy is basically a wrapper around a Save Handler that was
introduced to support seamlessly the migration from PHP 5.3 to PHP 5.4+. It
further creates an extension point from where custom logic can be added that
works independently of which handler is being wrapped inside.

There are two kinds of save handler class proxies which inherit from
:class:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\Handler\\AbstractProxy`:
they are :class:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\Handler\\NativeProxy`
Expand Down Expand Up @@ -263,3 +269,4 @@ without knowledge of the specific save handler.

.. _`php.net/session.customhandler`: http://php.net/session.customhandler
.. _`php.net/session.configuration`: http://php.net/session.configuration
.. _`php.net/memcached.setoption`: http://php.net/memcached.setoption
Loading