Skip to content

Commit 8c44f29

Browse files
committed
Merge branch '5.2' into 5.x
* 5.2: [RateLimiter] Adding config reference for policy and lock_factory remove mention of master branch, no longer exists [Session] Update incorrect default value for session.handler_id Added redirections to specific anchors for removed Templating articles Update lockable_trait.rst
2 parents 11f6160 + 95d52ea commit 8c44f29

File tree

5 files changed

+54
-16
lines changed

5 files changed

+54
-16
lines changed

_build/redirection_map

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -449,15 +449,15 @@
449449
/reference/requirements /setup
450450
/bundles/inheritance /bundles/override
451451
/templating /templates
452-
/templating/escaping /templates
453-
/templating/syntax /templates
454-
/templating/debug /templates
455-
/templating/render_without_controller /templates
456-
/templating/app_variable /templates
452+
/templating/escaping /templates#output-escaping
453+
/templating/syntax /templates#linting-twig-templates
454+
/templating/debug /templates#the-dump-twig-utilities
455+
/templating/render_without_controller /templates#rendering-a-template-directly-from-a-route
456+
/templating/app_variable /templates#the-app-global-variable
457457
/templating/formats /templates
458-
/templating/namespaced_paths /templates
459-
/templating/embedding_controllers /templates
460-
/templating/inheritance /templates
458+
/templating/namespaced_paths /templates#template-namespaces
459+
/templating/embedding_controllers /templates#embedding-controllers
460+
/templating/inheritance /templates#template-inheritance-and-layouts
461461
/testing/doctrine /testing/database
462462
/doctrine/lifecycle_callbacks /doctrine/events
463463
/doctrine/event_listeners_subscribers /doctrine/events

console/lockable_trait.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ that adds two convenient methods to lock and release commands::
3939
// automatically when the execution of the command ends
4040
$this->release();
4141

42-
return Command:SUCCESS;
42+
return Command::SUCCESS;
4343
}
4444
}
4545

contributing/documentation/overview.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ branch of the ``upstream`` remote, which is the original Symfony Docs repository
121121
Fixes should always be based on the **oldest maintained branch** which contains
122122
the error. Nowadays this is the ``4.4`` branch. If you are instead documenting a
123123
new feature, switch to the first Symfony version that included it, e.g.
124-
``upstream/3.1``. Not sure? That's OK! Just use the ``upstream/master`` branch.
124+
``upstream/3.1``.
125125

126126
**Step 5.** Now make your changes in the documentation. Add, tweak, reword and
127127
even remove any content and do your best to comply with the
@@ -295,12 +295,12 @@ Please be patient. It can take up to several days before your pull request can
295295
be fully reviewed. After merging the changes, it could take again several hours
296296
before your changes appear on the Symfony website.
297297

298-
Why Should I Use the Oldest Maintained Branch Instead of the Master Branch?
298+
Why Should I Use the Oldest Maintained Branch Instead of the Latest Branch?
299299
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
300300

301301
Consistent with Symfony's source code, the documentation repository is split
302302
into multiple branches, corresponding to the different versions of Symfony itself.
303-
The ``master`` branch holds the documentation for the development branch of
303+
The latest (e.g. ``5.x``) branch holds the documentation for the development branch of
304304
the code.
305305

306306
Unless you're documenting a feature that was introduced after Symfony 4.4,

rate_limiter.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Symfony uses these rate limiters in built-in features like "login throttling",
1616
which limits how many failed login attempts a user can make in a given period of
1717
time, but you can use them for your own features too.
1818

19+
.. _rate-limiter-policies:
20+
1921
Rate Limiting Policies
2022
----------------------
2123

reference/configuration/framework.rst

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,13 @@ Configuration
211211

212212
* :ref:`enabled <reference-property-info-enabled>`
213213

214+
* `rate_limiter`_:
215+
216+
* :ref:`name <reference-rate-limiter-name>`
217+
218+
* `lock_factory`_
219+
* `policy`_
220+
214221
* `request`_:
215222

216223
* `formats`_
@@ -1226,6 +1233,35 @@ dsn
12261233

12271234
The DSN where to store the profiling information.
12281235

1236+
rate_limiter
1237+
~~~~~~~~~~~~
1238+
1239+
.. _reference-rate-limiter-name:
1240+
1241+
name
1242+
....
1243+
1244+
**type**: ``prototype``
1245+
1246+
Name of the rate limiter you want to create.
1247+
1248+
lock_factory
1249+
""""""""""""
1250+
1251+
**type**: ``string`` **default:** ``lock.factory``
1252+
1253+
The service that is used to create a lock. The service has to be an instance of
1254+
the :class:`Symfony\\Component\\Lock\\LockFactory` class.
1255+
1256+
policy
1257+
""""""
1258+
1259+
**type**: ``string`` **required**
1260+
1261+
The name of the rate limiting algorithm to use. Example names are ``fixed_window``,
1262+
``sliding_window`` and ``no_limit``. See :ref:`Rate Limiter Policies <rate-limiter-policies>`)
1263+
for more information.
1264+
12291265
request
12301266
~~~~~~~
12311267

@@ -1399,11 +1435,11 @@ alias will be set to this service id. This class has to implement
13991435
handler_id
14001436
..........
14011437

1402-
**type**: ``string`` **default**: ``null``
1438+
**type**: ``string`` **default**: ``'session.handler.native_file'``
14031439

1404-
The service id used for session storage. The default ``null`` value means to use
1405-
the native PHP session mechanism. Set it to ``'session.handler.native_file'`` to
1406-
let Symfony manage the sessions itself using files to store the session metadata.
1440+
The service id used for session storage. The default value ``'session.handler.native_file'``
1441+
will let Symfony manage the sessions itself using files to store the session metadata.
1442+
Set it to ``null`` to use the native PHP session mechanism.
14071443
You can also :doc:`store sessions in a database </session/database>`.
14081444

14091445
.. _name:

0 commit comments

Comments
 (0)