Skip to content

remove obsolete versionadded directives #11068

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
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
6 changes: 0 additions & 6 deletions best_practices/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -208,12 +208,6 @@ through environment variables:
# ...
password: "%env(DB_PASSWORD)%"

.. versionadded:: 3.2

Support for runtime environment variables via the ``%env(...)%`` syntax
was added in Symfony 3.2. Prior to version 3.2, you needed to use the
:doc:`special SYMFONY__ variables </configuration/external_parameters>`.

----

Next: :doc:`/best_practices/business-logic`
Expand Down
8 changes: 0 additions & 8 deletions bundles/extension.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,10 +139,6 @@ Symfony creates a big ``classes.php`` file in the cache directory to aggregate
the contents of the PHP classes that are used in every request. This reduces the
I/O operations and increases the application performance.

.. versionadded:: 3.2

The ``addAnnotatedClassesToCompile()`` method was added in Symfony 3.2.

Your bundles can also add their own classes into this file thanks to the
``addClassesToCompile()`` and ``addAnnotatedClassesToCompile()`` methods (both
work in the same way, but the second one is for classes that contain PHP
Expand Down Expand Up @@ -176,10 +172,6 @@ class names::
If some class extends from other classes, all its parents are automatically
included in the list of classes to compile.

.. versionadded:: 3.2

The option to add classes to compile using patterns was introduced in Symfony 3.2.

The classes to compile can also be added using file path patterns::

// ...
Expand Down
4 changes: 0 additions & 4 deletions components/cache.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ The Cache Component
adapters for the most common caching backends, including proxies for adapting
from/to `Doctrine Cache`_.

.. versionadded:: 3.3

The PSR-16 "Simple Cache" implementation was introduced in Symfony 3.3.

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

Expand Down
4 changes: 0 additions & 4 deletions components/cache/adapters/memcached_adapter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@
Memcached Cache Adapter
=======================

.. versionadded:: 3.3

The Memcached adapter was introduced in Symfony 3.3.

This adapter stores the values in-memory using one (or more) `Memcached server`_
instances. Unlike the :ref:`APCu adapter <apcu-adapter>`, and similarly to the
:ref:`Redis adapter <redis-adapter>`, it is not limited to the current server's
Expand Down
4 changes: 0 additions & 4 deletions components/cache/adapters/pdo_doctrine_dbal_adapter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@
PDO & Doctrine DBAL Cache Adapter
=================================

.. versionadded:: 3.2

The PDO & Doctrine DBAL adapter was introduced in Symfony 3.2.

This adapter stores the cache items in an SQL database. It requires a `PDO`_,
`Doctrine DBAL Connection`_, or `Data Source Name (DSN)`_ as its first parameter, and
optionally a namespace, default cache lifetime, and options array as its second,
Expand Down
4 changes: 0 additions & 4 deletions components/cache/cache_invalidation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@ The Symfony Cache component provides two mechanisms to help solving this problem
Using Cache Tags
----------------

.. versionadded:: 3.2

Tags-based invalidation was introduced in Symfony 3.2.

To benefit from tags-based invalidation, you need to attach the proper tags to
each cached item. Each tag is a plain string identifier that you can use at any
time to trigger the removal of all items associated with this tag.
Expand Down
11 changes: 0 additions & 11 deletions components/config/definition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,22 +187,11 @@ Or you may define a prototype for each node inside an array node::
->end()
;

.. versionadded:: 3.3

The ``arrayPrototype()`` method (and the related ``booleanPrototype()``
``integerPrototype()``, ``floatPrototype()``, ``scalarPrototype()`` and
``enumPrototype()``) was introduced in Symfony 3.3. In previous versions,
you needed to use ``prototype('array')``, ``prototype('boolean')``, etc.

A prototype can be used to add a definition which may be repeated many times
inside the current node. According to the prototype definition in the example
above, it is possible to have multiple connection arrays (containing a ``driver``,
``host``, etc.).

.. versionadded:: 3.3

The ``castToArray()`` helper was added in Symfony 3.3.

Sometimes, to improve the user experience of your application or bundle, you may
allow to use a simple string or numeric value where an array value is required.
Use the ``castToArray()`` helper to turn those variables into arrays::
Expand Down
8 changes: 0 additions & 8 deletions components/console/helpers/questionhelper.rst
Original file line number Diff line number Diff line change
Expand Up @@ -230,10 +230,6 @@ convenient for passwords::
// ...
}

.. versionadded:: 3.3

The ``QuestionHelper::disableStty()`` method was introduced in Symfony 3.3.

Normalizing the Answer
----------------------

Expand Down Expand Up @@ -370,10 +366,6 @@ from the command line, you need to set the inputs that the command expects::
// $this->assertRegExp('/.../', $commandTester->getDisplay());
}

.. versionadded:: 3.2

The ``CommandTester::setInputs()`` method was introduced in Symfony 3.2.

By calling :method:`Symfony\\Component\\Console\\Tester\\CommandTester::setInputs`,
you imitate what the console would do internally with all user input through the CLI.
This method takes an array as only argument with, for each input that the command expects,
Expand Down
4 changes: 0 additions & 4 deletions components/console/logger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,6 @@ constructor::
Errors
------

.. versionadded:: 3.2

The ``hasErrored()`` method was introduced in Symfony 3.2.

The Console logger includes a ``hasErrored()`` method which returns ``true`` as
soon as any error message has been logged during the execution of the command.
This is useful to decide which status code to return as the result of executing
Expand Down
4 changes: 0 additions & 4 deletions components/dependency_injection/compilation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -423,10 +423,6 @@ been run, use::
PassConfig::TYPE_AFTER_REMOVING
);

.. versionadded:: 3.2

The option to prioritize compiler passes was added in Symfony 3.2.

You can also control the order in which compiler passes are run for each
compilation phase. Use the optional third argument of ``addCompilerPass()`` to
set the priority as an integer number. The default priority is ``0`` and the higher
Expand Down
12 changes: 0 additions & 12 deletions components/dom_crawler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -300,11 +300,6 @@ and :phpclass:`DOMNode` objects::
Expression Evaluation
~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 3.2

The :method:`Symfony\\Component\\DomCrawler\\Crawler::evaluate` method was
introduced in Symfony 3.2.

The ``evaluate()`` method evaluates the given XPath expression. The return
value depends on the XPath expression. If the expression evaluates to a scalar
value (e.g. HTML attributes), an array of results will be returned. If the
Expand Down Expand Up @@ -444,13 +439,6 @@ than just return the ``action`` attribute of the form. If the form method
is GET, then it mimics the browser's behavior and returns the ``action``
attribute followed by a query string of all of the form's values.

.. versionadded:: 3.3

Starting from Symfony 3.3, the optional ``formaction`` and ``formmethod``
button attributes are supported. The ``getUri()`` and ``getMethod()``
methods take into account those attributes to always return the right action
and method depending on the button used to get the form.

You can virtually set and get values on the form::

// sets values on the form internally
Expand Down
4 changes: 0 additions & 4 deletions components/dotenv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ The Dotenv Component
The Dotenv Component parses ``.env`` files to make environment variables
stored in them accessible via ``getenv()``, ``$_ENV`` or ``$_SERVER``.

.. versionadded:: 3.3

The Dotenv component was introduced in Symfony 3.3.

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

Expand Down
7 changes: 0 additions & 7 deletions components/expression_language/caching.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,6 @@ ones and injecting this using the constructor::
$cache = new RedisAdapter(...);
$expressionLanguage = new ExpressionLanguage($cache);

.. versionadded:: 3.2

PSR-6 caching support was introduced in Symfony 3.2. Prior to version 3.2,
a
:class:`Symfony\\Component\\ExpressionLanguage\\ParserCache\\ParserCacheInterface`
instance had to be injected.

.. seealso::

See the :doc:`/components/cache` documentation for more information about
Expand Down
4 changes: 0 additions & 4 deletions components/expression_language/extending.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,6 @@ register::

ExpressionFunction::fromPhp('My\strtoupper', 'my_strtoupper');

.. versionadded:: 3.3

The ``ExpressionFunction::fromPhp()`` method was introduced in Symfony 3.3.

You can register providers using
:method:`Symfony\\Component\\ExpressionLanguage\\ExpressionLanguage::registerProvider`
or by using the second argument of the constructor::
Expand Down
9 changes: 0 additions & 9 deletions components/filesystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -212,10 +212,6 @@ support symbolic links, a third boolean argument is available::
readlink
~~~~~~~~

.. versionadded:: 3.2

The :method:`Symfony\\Component\\Filesystem\\Filesystem::readlink` method was introduced in Symfony 3.2.

:method:`Symfony\\Component\\Filesystem\\Filesystem::readlink` read links targets.

PHP's ``readlink()`` function returns the target of a symbolic link. However, its behavior
Expand Down Expand Up @@ -307,11 +303,6 @@ The ``file.txt`` file contains ``Hello World`` now.
appendToFile
~~~~~~~~~~~~

.. versionadded:: 3.3

The :method:`Symfony\\Component\\Filesystem\\Filesystem::appendToFile`
method was introduced in Symfony 3.3.

:method:`Symfony\\Component\\Filesystem\\Filesystem::appendToFile` adds new
contents at the end of some file::

Expand Down
13 changes: 0 additions & 13 deletions components/http_foundation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -390,10 +390,6 @@ Note you can create a
:class:`Symfony\\Component\\HttpFoundation\\Cookie` object from a raw header
value using :method:`Symfony\\Component\\HttpFoundation\\Cookie::fromString`.

.. versionadded:: 3.3

The ``Cookie::fromString()`` method was introduced in Symfony 3.3.

Managing the HTTP Cache
~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -539,10 +535,6 @@ It is possible to delete the file after the request is sent with the
:method:`Symfony\\Component\\HttpFoundation\\BinaryFileResponse::deleteFileAfterSend` method.
Please note that this will not work when the ``X-Sendfile`` header is set.

.. versionadded:: 3.3

The ``Stream`` class was introduced in Symfony 3.3.

If the size of the served file is unknown (e.g. because it's being generated on the fly,
or because a PHP stream filter is registered on it, etc.), you can pass a ``Stream``
instance to ``BinaryFileResponse``. This will disable ``Range`` and ``Content-Length``
Expand Down Expand Up @@ -594,11 +586,6 @@ class, which can make this even easier::
// if the data to send is already encoded in JSON
$response = JsonResponse::fromJsonString('{ "data": 123 }');

.. versionadded:: 3.2

The :method:`Symfony\\Component\\HttpFoundation\\JsonResponse::fromJsonString`
method was added in Symfony 3.2.

The ``JsonResponse`` class sets the ``Content-Type`` header to
``application/json`` and encodes your data to JSON when needed.

Expand Down
5 changes: 0 additions & 5 deletions components/phpunit_bridge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -540,11 +540,6 @@ the namespaces of the tested classes in your phpunit.xml.dist
Modified PHPUnit script
-----------------------

.. versionadded:: 3.2

This modified PHPUnit script was introduced in the 3.2 version of
this component.

This bridge provides a modified version of PHPUnit that you can call by using
its ``bin/simple-phpunit`` command. It has the following features:

Expand Down
14 changes: 0 additions & 14 deletions components/process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,6 @@ for new output before going to the next iteration::
echo $data."\n";
}

.. versionadded:: 3.2

The ``getIterator()`` method was introduced in Symfony 3.2.

The ``mustRun()`` method is identical to ``run()``, except that it will throw
a :class:`Symfony\\Component\\Process\\Exception\\ProcessFailedException`
if the process couldn't be executed successfully (i.e. the process exited
Expand All @@ -103,11 +99,6 @@ with a non-zero code)::

.. tip::

.. versionadded:: 3.3

The ability to define commands as arrays of arguments was introduced in
Symfony 3.3.

Using array of arguments is the recommended way to define commands. This
saves you from any escaping and allows sending signals seamlessly
(e.g. to stop processes before completion.)::
Expand Down Expand Up @@ -419,11 +410,6 @@ Use :method:`Symfony\\Component\\Process\\Process::disableOutput` and
However, it is possible to pass a callback to the ``start``, ``run`` or ``mustRun``
methods to handle process output in a streaming fashion.

.. versionadded:: 3.1

The ability to pass a callback to these methods when output is disabled
was added in Symfony 3.1.

Finding the Executable PHP Binary
---------------------------------

Expand Down
4 changes: 0 additions & 4 deletions components/property_info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -273,10 +273,6 @@ and plural property names::
$propertyInfo->isWritable(SomeClass::class, 'analyses'); // returns true
$propertyInfo->isWritable(SomeClass::class, 'feet'); // returns true

.. versionadded:: 3.2

The support of adder/remover methods was introduced in Symfony 3.2.

.. tip::

The main :class:`Symfony\\Component\\PropertyInfo\\PropertyInfoExtractor`
Expand Down
5 changes: 0 additions & 5 deletions components/routing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -383,11 +383,6 @@ automatically in the background if you want to use it. A basic example of the
Unicode Routing Support
~~~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 3.2

UTF-8 support for route paths and requirements was introduced in
Symfony 3.2.

The Routing component supports UTF-8 characters in route paths and requirements.
Thanks to the ``utf8`` route option, you can make Symfony match and generate
routes with UTF-8 characters:
Expand Down
4 changes: 0 additions & 4 deletions components/security/firewall.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,6 @@ further than allowed.
Firewall Config
~~~~~~~~~~~~~~~

.. versionadded:: 3.2

The ``FirewallConfig`` class was introduced in Symfony 3.2.

The information about a given firewall, such as its name, provider, context,
entry point and access denied URL, is provided by instances of the
:class:`Symfony\\Bundle\\SecurityBundle\\Security\\FirewallConfig` class.
Expand Down
14 changes: 0 additions & 14 deletions components/serializer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,11 +165,6 @@ needs three parameters:
#. The name of the class this information will be decoded to
#. The encoder used to convert that information into an array

.. versionadded:: 3.3

Support for the ``allow_extra_attributes`` key in the context was introduced
in Symfony 3.3.

By default, additional attributes that are not mapped to the denormalized object
will be ignored by the Serializer component. If you prefer to throw an exception
when this happens, set the ``allow_extra_attributes`` context option to
Expand Down Expand Up @@ -624,11 +619,6 @@ There are several types of normalizers available:
:phpclass:`DateTime` and :phpclass:`DateTimeImmutable`) into strings.
By default it uses the RFC3339_ format.

.. versionadded:: 3.2

Support for specifying datetime format during denormalization was
introduced in the ``DateTimeNormalizer`` in Symfony 3.2.

:class:`Symfony\\Component\\Serializer\\Normalizer\\DataUriNormalizer`
This normalizer converts :phpclass:`SplFileInfo` objects into a data URI
string (``data:...``) such that files can be embedded into serialized data.
Expand Down Expand Up @@ -664,10 +654,6 @@ The Serializer component supports many formats out of the box:
All these encoders are enabled by default when using the Symfony Standard Edition
with the serializer enabled.

.. versionadded:: 3.2

The ``YamlEncoder`` and ``CsvEncoder`` encoders were introduced in Symfony 3.2

.. _component-serializer-handling-circular-references:

Handling Circular References
Expand Down
Loading