Skip to content

Commit 1a73382

Browse files
committed
minor #15518 Remove 5.x versionadded directives (javiereguiluz)
This PR was squashed before being merged into the 6.0 branch. Discussion ---------- Remove 5.x versionadded directives This process had to be manual because some `versionadded` directives contained information that had to be moved to notes or normal paragraphs. Thanks! Commits ------- 6aa61a1 Remove 5.x versionadded directives
2 parents fe38f8b + 6aa61a1 commit 1a73382

File tree

154 files changed

+63
-1560
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

154 files changed

+63
-1560
lines changed

best_practices.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ Use the ``auto`` Password Hasher
368368

369369
The :ref:`auto password hasher <reference-security-encoder-auto>` automatically
370370
selects the best possible encoder/hasher depending on your PHP installation.
371-
Starting from Symfony 5.3, the default auto hasher is ``bcrypt``.
371+
Currently, the default auto hasher is ``bcrypt``.
372372

373373
Use Voters to Implement Fine-grained Security Restrictions
374374
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

cache.rst

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,6 @@ The Cache component comes with a series of adapters pre-configured:
107107
* :doc:`cache.adapter.redis </components/cache/adapters/redis_adapter>`
108108
* :ref:`cache.adapter.redis_tag_aware <redis-tag-aware-adapter>` (Redis adapter optimized to work with tags)
109109

110-
.. versionadded:: 5.2
111-
112-
``cache.adapter.redis_tag_aware`` has been introduced in Symfony 5.2.
113-
114110
Some of these adapters could be configured via shortcuts. Using these shortcuts
115111
will create pools with service IDs that follow the pattern ``cache.[type]``.
116112

@@ -725,11 +721,6 @@ Clear all caches everywhere:
725721
Encrypting the Cache
726722
--------------------
727723

728-
.. versionadded:: 5.1
729-
730-
The :class:`Symfony\\Component\\Cache\\Marshaller\\SodiumMarshaller`
731-
class was introduced in Symfony 5.1.
732-
733724
To encrypt the cache using ``libsodium``, you can use the
734725
:class:`Symfony\\Component\\Cache\\Marshaller\\SodiumMarshaller`.
735726

components/asset.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -179,10 +179,6 @@ with the :doc:`HttpClient component </http_client>`::
179179
$manifestUrl = 'https://cdn.example.com/rev-manifest.json';
180180
$package = new Package(new RemoteJsonManifestVersionStrategy($manifestUrl, $httpClient));
181181

182-
.. versionadded:: 5.1
183-
184-
The ``RemoteJsonManifestVersionStrategy`` was introduced in Symfony 5.1.
185-
186182
Custom Version Strategies
187183
.........................
188184

components/browser_kit.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,6 @@ convert the request parameters into a JSON string and set the needed HTTP header
9090
// this encodes parameters as JSON and sets the required CONTENT_TYPE and HTTP_ACCEPT headers
9191
$crawler = $client->jsonRequest('GET', '/', ['some_parameter' => 'some_value']);
9292

93-
.. versionadded:: 5.3
94-
95-
The ``jsonRequest()`` method was introduced in Symfony 5.3.
96-
9793
The :method:`Symfony\\Component\\BrowserKit\\AbstractBrowser::xmlHttpRequest` method,
9894
which defines the same arguments as the ``request()`` method, is a shortcut to
9995
make AJAX requests::
@@ -178,10 +174,6 @@ provides access to the form properties (e.g. ``$form->getUri()``,
178174
Custom Header Handling
179175
~~~~~~~~~~~~~~~~~~~~~~
180176

181-
.. versionadded:: 5.2
182-
183-
The ``getHeaders()`` method was introduced in Symfony 5.2.
184-
185177
The optional HTTP headers passed to the ``request()`` method follows the FastCGI
186178
request format (uppercase, underscores instead of dashes and prefixed with ``HTTP_``).
187179
Before saving those headers to the request, they are lower-cased, with ``HTTP_``

components/cache/adapters/array_cache_adapter.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,3 @@ method::
3030
// is reached, cache follows the LRU model (least recently used items are deleted)
3131
$maxItems = 0
3232
);
33-
34-
.. versionadded:: 5.1
35-
36-
The ``maxLifetime`` and ``maxItems`` options were introduced in Symfony 5.1.

components/cache/adapters/couchbasebucket_adapter.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@
77
Couchbase Cache Adapter
88
=======================
99

10-
.. versionadded:: 5.1
11-
12-
The CouchbaseBucketAdapter was introduced in Symfony 5.1.
13-
1410
This adapter stores the values in-memory using one (or more) `Couchbase server`_
1511
instances. Unlike the :ref:`APCu adapter <apcu-adapter>`, and similarly to the
1612
:ref:`Memcached adapter <memcached-adapter>`, it is not limited to the current server's

components/config/definition.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -435,13 +435,6 @@ The following example shows these methods in practice::
435435
Deprecating the Option
436436
----------------------
437437

438-
.. versionadded:: 5.1
439-
440-
The signature of the ``setDeprecated()`` method changed from
441-
``setDeprecated(?string $message)`` to
442-
``setDeprecated(string $package, string $version, ?string $message)``
443-
in Symfony 5.1.
444-
445438
You can deprecate options using the
446439
:method:`Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition::setDeprecated`
447440
method::

components/console/helpers/cursor.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@
44
Cursor Helper
55
=============
66

7-
.. versionadded:: 5.1
8-
9-
The :class:`Symfony\\Component\\Console\\Cursor` class was introduced
10-
in Symfony 5.1.
11-
127
The :class:`Symfony\\Component\\Console\\Cursor` allows you to change the
138
cursor position in a console command. This allows you to write on any position
149
of the output:

components/console/helpers/questionhelper.rst

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -117,10 +117,6 @@ from a predefined list::
117117
// ... do something with the color
118118
}
119119

120-
.. versionadded:: 5.2
121-
122-
Support for using PHP objects as choice values was introduced in Symfony 5.2.
123-
124120
The option which should be selected by default is provided with the third
125121
argument of the constructor. The default is ``null``, which means that no
126122
option is the default one.
@@ -242,11 +238,6 @@ You can also specify if you want to not trim the answer by setting it directly w
242238
Accept Multiline Answers
243239
~~~~~~~~~~~~~~~~~~~~~~~~
244240

245-
.. versionadded:: 5.2
246-
247-
The ``setMultiline()`` and ``isMultiline()`` methods were introduced in
248-
Symfony 5.2.
249-
250241
By default, the question helper stops reading user input when it receives a newline
251242
character (i.e., when the user hits ``ENTER`` once). However, you may specify that
252243
the response to a question should allow multiline answers by passing ``true`` to

components/console/helpers/table.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -265,10 +265,6 @@ Here is a full list of things you can customize:
265265

266266
This method can also be used to override a built-in style.
267267

268-
.. versionadded:: 5.2
269-
270-
The option to style table cells was introduced in Symfony 5.2.
271-
272268
In addition to the built-in table styles, you can also apply different styles
273269
to each table cell via :class:`Symfony\\Component\\Console\\Helper\\TableCellStyle`::
274270

components/console/single_command_tool.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,6 @@ Building a single Command Application
77
When building a command line tool, you may not need to provide several commands.
88
In such case, having to pass the command name each time is tedious.
99

10-
.. versionadded:: 5.1
11-
12-
The :class:`Symfony\\Component\\Console\\SingleCommandApplication` class was
13-
introduced in Symfony 5.1.
14-
1510
Fortunately, it is possible to remove this need by declaring a single command
1611
application::
1712

components/dependency_injection.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -299,12 +299,10 @@ config files:
299299
$services = $configurator->services();
300300
301301
$services->set('mailer', 'Mailer')
302-
// the param() method was introduced in Symfony 5.2.
303302
->args([param('mailer.transport')])
304303
;
305304
306305
$services->set('newsletter_manager', 'NewsletterManager')
307-
// In versions earlier to Symfony 5.1 the service() function was called ref()
308306
->call('setMailer', [service('mailer')])
309307
;
310308
};

components/dom_crawler.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -192,10 +192,6 @@ Get all the child or ancestor nodes::
192192
$crawler->filter('body')->children();
193193
$crawler->filter('body > p')->ancestors();
194194

195-
.. versionadded:: 5.3
196-
197-
The ``ancestors()`` method was introduced in Symfony 5.3.
198-
199195
Get all the direct child nodes matching a CSS selector::
200196

201197
$crawler->filter('body')->children('p.lorem');
@@ -633,10 +629,6 @@ the whole form or specific field(s)::
633629
Resolving a URI
634630
~~~~~~~~~~~~~~~
635631

636-
.. versionadded:: 5.1
637-
638-
The :class:`Symfony\\Component\\DomCrawler\\UriResolver` helper class was added in Symfony 5.1.
639-
640632
The :class:`Symfony\\Component\\DomCrawler\\UriResolver` class takes an URI
641633
(relative, absolute, fragment, etc.) and turns it into an absolute URI against
642634
another given base URI::

components/filesystem.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -287,10 +287,6 @@ exception on failure::
287287
// returns a path like : /tmp/prefix_wyjgtF.png
288288
$filesystem->tempnam('/tmp', 'prefix_', '.png');
289289

290-
.. versionadded:: 5.1
291-
292-
The option to set a suffix in ``tempnam()`` was introduced in Symfony 5.1.
293-
294290
``dumpFile``
295291
~~~~~~~~~~~~
296292

components/http_foundation.rst

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -198,10 +198,6 @@ If the request body is a JSON string, it can be accessed using
198198

199199
$data = $request->toArray();
200200

201-
.. versionadded:: 5.2
202-
203-
The ``toArray()`` method was introduced in Symfony 5.2.
204-
205201
Identifying a Request
206202
~~~~~~~~~~~~~~~~~~~~~
207203

@@ -288,10 +284,6 @@ this complexity and defines some methods for the most common tasks::
288284
HeaderUtils::parseQuery('foo[bar.baz]=qux');
289285
// => ['foo' => ['bar.baz' => 'qux']]
290286

291-
.. versionadded:: 5.2
292-
293-
The ``parseQuery()`` method was introduced in Symfony 5.2.
294-
295287
Accessing ``Accept-*`` Headers Data
296288
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
297289

@@ -475,10 +467,6 @@ a new object with the modified property::
475467
->withDomain('.example.com')
476468
->withSecure(true);
477469

478-
.. versionadded:: 5.1
479-
480-
The ``with*()`` methods were introduced in Symfony 5.1.
481-
482470
Managing the HTTP Cache
483471
~~~~~~~~~~~~~~~~~~~~~~~
484472

@@ -523,11 +511,6 @@ call::
523511
'etag' => 'abcdef',
524512
]);
525513

526-
.. versionadded:: 5.1
527-
528-
The ``must_revalidate``, ``no_cache``, ``no_store``, ``no_transform`` and
529-
``proxy_revalidate`` directives were introduced in Symfony 5.1.
530-
531514
To check if the Response validators (``ETag``, ``Last-Modified``) match a
532515
conditional value specified in the client Request, use the
533516
:method:`Symfony\\Component\\HttpFoundation\\Response::isNotModified`
@@ -766,11 +749,6 @@ Symfony offers two methods to interact with this preference:
766749
* :method:`Symfony\\Component\\HttpFoundation\\Request::preferSafeContent`;
767750
* :method:`Symfony\\Component\\HttpFoundation\\Response::setContentSafe`;
768751

769-
.. versionadded:: 5.1
770-
771-
The ``preferSafeContent()`` and ``setContentSafe()`` methods were introduced
772-
in Symfony 5.1.
773-
774752
The following example shows how to detect if the user agent prefers "safe" content::
775753

776754
if ($request->preferSafeContent()) {

components/http_foundation/sessions.rst

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -166,14 +166,6 @@ and "Remember Me" login settings or other user based state information.
166166
:class:`Symfony\\Component\\HttpFoundation\\Session\\Attribute\\AttributeBag`
167167
This is the standard default implementation.
168168

169-
:class:`Symfony\\Component\\HttpFoundation\\Session\\Attribute\\NamespacedAttributeBag`
170-
This implementation allows for attributes to be stored in a structured namespace.
171-
172-
.. deprecated:: 5.3
173-
174-
The ``NamespacedAttributeBag`` class is deprecated since Symfony 5.3.
175-
If you need this feature, you will have to implement the class yourself.
176-
177169
:class:`Symfony\\Component\\HttpFoundation\\Session\\Attribute\\AttributeBagInterface`
178170
has the API
179171

@@ -242,20 +234,6 @@ So any processing of this might quickly get ugly, even adding a token to the arr
242234
$tokens['c'] = $value;
243235
$session->set('tokens', $tokens);
244236

245-
.. deprecated:: 5.3
246-
247-
The ``NamespacedAttributeBag`` class is deprecated since Symfony 5.3.
248-
If you need this feature, you will have to implement the class yourself.
249-
250-
With structured namespacing, the key can be translated to the array
251-
structure like this using a namespace character (which defaults to ``/``)::
252-
253-
// ...
254-
use Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag;
255-
256-
$session = new Session(new NativeSessionStorage(), new NamespacedAttributeBag());
257-
$session->set('tokens/c', $value);
258-
259237
Flash Messages
260238
~~~~~~~~~~~~~~
261239

components/intl.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -250,10 +250,6 @@ can change if the number is used in cash transactions or in other scenarios
250250
$fractionDigits = Currencies::getFractionDigits('SEK'); // returns: 2
251251
$cashFractionDigits = Currencies::getCashFractionDigits('SEK'); // returns: 0
252252

253-
.. versionadded:: 5.3
254-
255-
The ``getCashFractionDigits()`` method was introduced in Symfony 5.3.
256-
257253
Some currencies require to round numbers to the nearest increment of some value
258254
(e.g. 5 cents). This increment might be different if numbers are formatted for
259255
cash transactions or other scenarios (e.g. accounting)::
@@ -268,10 +264,6 @@ cash transactions or other scenarios (e.g. accounting)::
268264
$roundingIncrement = Currencies::getRoundingIncrement('CAD'); // returns: 0
269265
$cashRoundingIncrement = Currencies::getCashRoundingIncrement('CAD'); // returns: 5
270266

271-
.. versionadded:: 5.3
272-
273-
The ``getCashRoundingIncrement()`` method was introduced in Symfony 5.3.
274-
275267
All methods (except for ``getFractionDigits()``, ``getCashFractionDigits()``,
276268
``getRoundingIncrement()`` and ``getCashRoundingIncrement()``) accept the
277269
translation locale as the last, optional parameter, which defaults to the

components/ldap.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -160,11 +160,6 @@ delete existing ones::
160160
// Removing an existing entry
161161
$entryManager->remove(new Entry('cn=Test User,dc=symfony,dc=com'));
162162

163-
.. versionadded:: 5.3
164-
165-
The option to make attribute names case-insensitive in ``getAttribute()``
166-
and ``hasAttribute()`` was introduced in Symfony 5.3.
167-
168163
Batch Updating
169164
______________
170165

components/lock.rst

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -123,14 +123,9 @@ they can be decorated with the ``RetryTillSaveStore`` class::
123123
When the provided store does not implement the
124124
:class:`Symfony\\Component\\Lock\\BlockingStoreInterface` interface, the
125125
``Lock`` class will retry to acquire the lock in a non-blocking way until the
126-
lock is acquired.
127-
128-
.. deprecated:: 5.2
129-
130-
As of Symfony 5.2, you don't need to use the ``RetryTillSaveStore`` class
131-
anymore. The ``Lock`` class now provides the default logic to acquire locks
132-
in blocking mode when the store does not implement the
133-
``BlockingStoreInterface`` interface.
126+
lock is acquired. However, the ``Lock`` class also provides the default logic to
127+
acquire locks in blocking mode when the store does not implement the
128+
``BlockingStoreInterface`` interface.
134129

135130
Expiring Locks
136131
--------------
@@ -242,11 +237,6 @@ or until ``Lock::release()`` is called.
242237
Shared Locks
243238
------------
244239

245-
.. versionadded:: 5.2
246-
247-
Shared locks (and the associated ``acquireRead()`` method and
248-
``SharedLockStoreInterface``) were introduced in Symfony 5.2.
249-
250240
A shared or `readers–writer lock`_ is a synchronization primitive that allows
251241
concurrent access for read-only operations, while write operations require
252242
exclusive access. This means that multiple threads can read the data in parallel
@@ -410,10 +400,6 @@ support blocking, and expects a TTL to avoid stalled locks::
410400
MongoDbStore
411401
~~~~~~~~~~~~
412402

413-
.. versionadded:: 5.1
414-
415-
The ``MongoDbStore`` was introduced in Symfony 5.1.
416-
417403
The MongoDbStore saves locks on a MongoDB server ``>=2.2``, it requires a
418404
``\MongoDB\Collection`` or ``\MongoDB\Client`` from `mongodb/mongodb`_ or a
419405
`MongoDB Connection String`_.
@@ -510,10 +496,6 @@ locks::
510496
In opposite to the ``PdoStore``, the ``PostgreSqlStore`` does not need a table to
511497
store locks and does not expire.
512498

513-
.. versionadded:: 5.2
514-
515-
The ``PostgreSqlStore`` was introduced in Symfony 5.2.
516-
517499
.. _lock-store-redis:
518500

519501
RedisStore

0 commit comments

Comments
 (0)