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.

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

Make the docs ready for 2.4 #2690

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Contributing

>**Note**
>Unless you're documenting a feature that's new to a specific version of Symfony
>(e.g. Symfony 2.2), all pull requests must be based off of the **2.1** branch,
>**not** the master or 2.2 branch.
>(e.g. Symfony 2.3), all pull requests must be based off of the **2.2** branch,
>**not** the master or 2.3 branch.

We love contributors! For more information on how you can contribute to the
Symfony documentation, please read
Expand Down
14 changes: 0 additions & 14 deletions book/routing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,6 @@ The route is simple:

return $collection;

.. versionadded:: 2.2
The ``path`` option is new in Symfony2.2, ``pattern`` is used in older
versions.

The path defined by the ``blog_show`` route acts like ``/blog/*`` where
the wildcard is given the name ``slug``. For the URL ``/blog/my-blog-post``,
the ``slug`` variable gets a value of ``my-blog-post``, which is available
Expand Down Expand Up @@ -681,10 +677,6 @@ be accomplished with the following route configuration:

return $collection;

.. versionadded:: 2.2
The ``methods`` option is added in Symfony2.2. Use the ``_method``
requirement in older versions.

Despite the fact that these two routes have identical paths (``/contact``),
the first route will match only GET requests and the second route will match
only POST requests. This means that you can display the form and submit the
Expand All @@ -697,9 +689,6 @@ form via the same URL, while using distinct controllers for the two actions.
Adding a Host
~~~~~~~~~~~~~

.. versionadded:: 2.2
Host matching support was added in Symfony 2.2

You can also match on the HTTP *host* of the incoming request. For more
information, see :doc:`/components/routing/hostname_pattern` in the Routing
component documentation.
Expand Down Expand Up @@ -1042,9 +1031,6 @@ from the new routing resource.
Adding a Host regex to Imported Routes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 2.2
Host matching support was added in Symfony 2.2

You can set the host regex on imported routes. For more information, see
:ref:`component-routing-host-imported`.

Expand Down
7 changes: 0 additions & 7 deletions book/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1333,10 +1333,6 @@ it as base64. In other words, the password has been greatly obfuscated so
that the hashed password can't be decoded (i.e. you can't determine the password
from the hashed password).

.. versionadded:: 2.2
As of Symfony 2.2 you can also use the :ref:`PBKDF2<reference-security-pbkdf2>`
and :ref:`BCrypt<reference-security-bcrypt>` password encoders.

Determining the Hashed Password
...............................

Expand Down Expand Up @@ -1955,9 +1951,6 @@ cookie will be ever created by Symfony2):
Utilities
---------

.. versionadded:: 2.2
The ``StringUtils`` and ``SecureRandom`` classes were added in Symfony 2.2

The Symfony Security Component comes with a collection of nice utilities related
to security. These utilities are used by Symfony, but you should also use
them if you want to solve the problem they address.
Expand Down
12 changes: 0 additions & 12 deletions book/templating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -376,11 +376,6 @@ When working with template inheritance, here are some tips to keep in mind:
Template Naming and Locations
-----------------------------

.. versionadded:: 2.2
Namespaced path support was added in 2.2, allowing for template names
like ``@AcmeDemo/layout.html.twig``. See :doc:`/cookbook/templating/namespaced_paths`
for more details.

By default, templates can live in two different locations:

* ``app/Resources/views/``: The applications ``views`` directory can contain
Expand Down Expand Up @@ -568,10 +563,6 @@ template using the ``with`` command.
maps (i.e. an array with named keys). If you needed to pass in multiple
elements, it would look like this: ``{'foo': foo, 'bar': bar}``.

.. versionadded:: 2.2
The ``include()`` function is a new Twig feature that's available in
Symfony 2.2. Prior, the ``{% include %}`` tag was used.

.. index::
single: Templating; Embedding action

Expand Down Expand Up @@ -750,9 +741,6 @@ in your application configuration:
),
));

.. versionadded:: 2.2
Default templates per render function was added in Symfony 2.2

You can define default templates per ``render`` function (which will override
any global default template that is defined):

Expand Down
10 changes: 2 additions & 8 deletions components/config/definition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,8 @@ node definition. Node type are available for:
* boolean
* array
* enum
* integer (new in 2.2)
* float (new in 2.2)
* integer
* float
* variable (no validation)

and are created with ``node($name, $type)`` or their associated shortcut
Expand All @@ -111,9 +111,6 @@ and are created with ``node($name, $type)`` or their associated shortcut
Numeric node constraints
~~~~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 2.2
The numeric (float and integer) nodes are new in 2.2

Numeric nodes (float and integer) provide two extra constraints -
:method:`Symfony\\Component\\Config\\Definition\\Builder::min` and
:method:`Symfony\\Component\\Config\\Definition\\Builder::max` -
Expand Down Expand Up @@ -270,9 +267,6 @@ has a certain value:
Optional Sections
-----------------

.. versionadded:: 2.2
The ``canBeEnabled`` and ``canBeDisabled`` methods are new in Symfony 2.2

If you have entire sections which are optional and can be enabled/disabled,
you can take advantage of the shortcut
:method:`Symfony\\Component\\Config\\Definition\\Builder\\ArrayNodeDefinition::canBeEnabled` and
Expand Down
13 changes: 0 additions & 13 deletions components/console/helpers/dialoghelper.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,6 @@ the default value (``AcmeDemoBundle`` here) is returned.
Autocompletion
~~~~~~~~~~~~~~

.. versionadded:: 2.2
Autocompletion for questions was added in Symfony 2.2.

You can also specify an array of potential answers for a given question. These
will be autocompleted as the user types::

Expand All @@ -74,9 +71,6 @@ will be autocompleted as the user types::
Hiding the User's Response
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 2.2
The ``askHiddenResponse`` method was added in Symfony 2.2.

You can also ask a question and hide the response. This is particularly
convenient for passwords::

Expand Down Expand Up @@ -144,9 +138,6 @@ be able to proceed if her input is valid.
Hiding the User's Response
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 2.2
The ``askHiddenResponseAndValidate`` method was added in Symfony 2.2.

You can also ask and validate a hidden response::

$dialog = $this->getHelperSet()->get('dialog');
Expand All @@ -171,10 +162,6 @@ some reason, pass true as the fifth argument.
Let the user choose from a list of Answers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 2.2
The :method:`Symfony\\Component\\Console\\Helper\\DialogHelper::select` method
was added in Symfony 2.2.

If you have a predefined set of answers the user can choose from, you
could use the ``ask`` method described above or, to make sure the user
provided a correct answer, the ``askAndValidate`` method. Both have
Expand Down
3 changes: 0 additions & 3 deletions components/console/helpers/progresshelper.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
Progress Helper
===============

.. versionadded:: 2.2
The ``progress`` helper was added in Symfony 2.2.

.. versionadded:: 2.3
The ``setCurrent`` method was added in Symfony 2.3.

Expand Down
3 changes: 0 additions & 3 deletions components/dependency_injection/compilation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -277,9 +277,6 @@ but also load a secondary one only if a certain parameter is set::
Prepending Configuration passed to the Extension
------------------------------------------------

.. versionadded:: 2.2
The ability to prepend the configuration of a bundle is new in Symfony 2.2.

An Extension can prepend the configuration of any Bundle before the ``load()``
method is called by implementing :class:`Symfony\\Component\\DependencyInjection\\Extension\\PrependExtensionInterface`::

Expand Down
6 changes: 0 additions & 6 deletions components/finder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,6 @@ Search in several locations by chaining calls to

$finder->files()->in(__DIR__)->in('/elsewhere');

.. versionadded:: 2.2
Wildcard support was added in version 2.2.

Use wildcard characters to search in the directories matching a pattern::

$finder->in('src/Symfony/*/*/Resources');
Expand Down Expand Up @@ -206,9 +203,6 @@ The ``notContains()`` method excludes files containing given pattern::
Path
~~~~

.. versionadded:: 2.2
The ``path()`` and ``notPath()`` methods were added in version 2.2.

Restrict files and directories by path with the
:method:`Symfony\\Component\\Finder\\Finder::path` method::

Expand Down
7 changes: 0 additions & 7 deletions components/http_foundation/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -240,9 +240,6 @@ by using the following methods:
* :method:`Symfony\\Component\\HttpFoundation\\Request::getCharsets`:
returns the list of accepted charsets ordered by descending quality;

.. versionadded:: 2.2
The :class:`Symfony\\Component\\HttpFoundation\\AcceptHeader` class is new in Symfony 2.2.

If you need to get full access to parsed data from ``Accept``, ``Accept-Language``,
``Accept-Charset`` or ``Accept-Encoding``, you can use
:class:`Symfony\\Component\\HttpFoundation\\AcceptHeader` utility class::
Expand Down Expand Up @@ -430,10 +427,6 @@ abstracts the hard work behind a simple API::

$response->headers->set('Content-Disposition', $d);

.. versionadded:: 2.2
The :class:`Symfony\\Component\\HttpFoundation\\BinaryFileResponse`
class was added in Symfony 2.2.

Alternatively, if you are serving a static file, you can use a
:class:`Symfony\\Component\\HttpFoundation\\BinaryFileResponse`::

Expand Down
3 changes: 0 additions & 3 deletions components/process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@ a command in a sub-process::
The component takes care of the subtle differences between the different platforms
when executing the command.

.. versionadded:: 2.2
The ``getIncrementalOutput()`` and ``getIncrementalErrorOutput()`` methods were added in Symfony 2.2.

The ``getOutput()`` method always return the whole content of the standard
output of the command and ``getErrorOutput()`` the content of the error
output. Alternatively, the :method:`Symfony\\Component\\Process\\Process::getIncrementalOutput`
Expand Down
4 changes: 0 additions & 4 deletions components/property_access/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ The PropertyAccess Component
The PropertyAccess component provides function to read and write from/to an
object or array using a simple string notation.

.. versionadded:: 2.2
The PropertyAccess Component is new to Symfony 2.2. Previously, the
``PropertyPath`` class was located in the ``Form`` component.

Installation
------------

Expand Down
3 changes: 0 additions & 3 deletions components/routing/hostname_pattern.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
How to match a route based on the Host
======================================

.. versionadded:: 2.2
Host matching support was added in Symfony 2.2

You can also match on the HTTP *host* of the incoming request.

.. configuration-block::
Expand Down
7 changes: 0 additions & 7 deletions components/routing/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,6 @@ are the least commonly needed.
7. An array of methods. These enforce a certain HTTP request method (``HEAD``,
``GET``, ``POST``, ...).

.. versionadded:: 2.2
Host matching support was added in Symfony 2.2

Take the following route, which combines several of these ideas::

$route = new Route(
Expand Down Expand Up @@ -160,10 +157,6 @@ the :method:`Symfony\\Component\\Routing\\RouteCollection::addPrefix` method::

$rootCollection->addCollection($subCollection);

.. versionadded:: 2.2
The ``addPrefix`` method is added in Symfony2.2. This was part of the
``addCollection`` method in older versions.

Set the Request Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
4 changes: 0 additions & 4 deletions components/stopwatch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ The Stopwatch Component

Stopwatch component provides a way to profile code.

.. versionadded:: 2.2
The Stopwatch Component is new to Symfony 2.2. Previously, the ``Stopwatch``
class was located in the ``HttpKernel`` component (and was new in 2.1).

Installation
------------

Expand Down
2 changes: 1 addition & 1 deletion components/using_components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,4 @@ And have fun!

.. _Composer: http://getcomposer.org
.. _Install composer: http://getcomposer.org/download/
.. _packagist.org: https://packagist.org/
.. _packagist.org: https://packagist.org/
11 changes: 2 additions & 9 deletions components/yaml/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,15 +130,8 @@ It may also be convenient to use the
$yaml = Yaml::parse(file_get_contents('/path/to/file.yml'));

The :method:`Symfony\\Component\\Yaml\\Yaml::parse` static method takes a YAML
string or a file containing YAML. Internally, it calls the
:method:`Symfony\\Component\\Yaml\\Parser::parse` method, but enhances the
error if something goes wrong by adding the filename to the message.

.. caution::

Because it is currently possible to pass a filename to this method, you
must validate the input first. Passing a filename is deprecated in
Symfony 2.2, and will be removed in Symfony 3.0.
string. Internally, it calls the
:method:`Symfony\\Component\\Yaml\\Parser::parse` method.

Writing YAML Files
~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion contributing/community/releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,4 +147,4 @@ upgrade.
.. _Git repository: https://github.com/symfony/symfony
.. _SensioLabs: http://sensiolabs.com/
.. _roadmap: http://symfony.com/roadmap
.. _`timeline calculator`: http://symfony.com/roadmap
.. _`timeline calculator`: http://symfony.com/roadmap
4 changes: 2 additions & 2 deletions contributing/documentation/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ the base branch to be 2.1 on the preview page:

.. note::

All changes made to a branch (e.g. 2.1) will be merged up to each "newer"
branch (e.g. 2.2, master, etc) for the next release on a weekly basis.
All changes made to a branch (e.g. 2.2) will be merged up to each "newer"
branch (e.g. 2.3, master, etc) for the next release on a weekly basis.

GitHub covers the topic of `pull requests`_ in detail.

Expand Down
7 changes: 2 additions & 5 deletions cookbook/console/sending_emails.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,10 @@ and per Command.
Configuring the Request Context globally
----------------------------------------

.. versionadded: 2.2
The ``base_url`` parameter is available since Symfony 2.2

To configure the Request Context - which is used by the URL Generator - you can
redefine the parameters it uses as default values to change the default host
(localhost) and scheme (http). Starting with Symfony 2.2 you can also configure
the base path if Symfony is not running in the root directory.
(localhost) and scheme (http). You can also configure the base path if Symfony
is not running in the root directory.

Note that this does not impact URLs generated via normal web requests, since those
will override the defaults.
Expand Down
8 changes: 1 addition & 7 deletions cookbook/form/dynamic_form_modification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,13 +112,7 @@ Inside the Event Subscriber Class

The goal is to create a "name" field *only* if the underlying Product object
is new (e.g. hasn't been persisted to the database). Based on that, the subscriber
might look like the following:

.. versionadded:: 2.2
The ability to pass a string into :method:`FormInterface::add<Symfony\\Component\\Form\\FormInterface::add>`
was added in Symfony 2.2.

.. code-block:: php
might look like the following::

// src/Acme/DemoBundle/Form/EventListener/AddNameFieldSubscriber.php
namespace Acme\DemoBundle\Form\EventListener;
Expand Down
8 changes: 3 additions & 5 deletions cookbook/routing/method_parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,9 @@ Faking the Method with _method

.. note::

The ``_method`` functionality shown here is disabled by default in Symfony 2.2
and enabled by default in Symfony 2.3. To control it in Symfony 2.2, you
must call :method:`Request::enableHttpMethodParameterOverride <Symfony\\Component\\HttpFoundation\\Request::enableHttpMethodParameterOverride>`
before you handle the request (e.g. in your front controller). In Symfony
2.3, use the :ref:`configuration-framework-http_method_override` option.
The ``_method`` functionality shown here is enabled by default in Symfony
2.3. To control it use the
:ref:`configuration-framework-http_method_override` option.

Unfortunately, life isn't quite this simple, since most browsers do not
support sending PUT and DELETE requests. Fortunately Symfony2 provides you
Expand Down
Loading