Skip to content

Commit bcb0e34

Browse files
committed
Merge remote-tracking branch 'upstream/7.3' into 7.3
* upstream/7.3: Fix more heading levels in the security reference Update overview.rst update internal ref in event dispatcher
2 parents 0473a80 + a35d0b0 commit bcb0e34

File tree

3 files changed

+16
-87
lines changed

3 files changed

+16
-87
lines changed

contributing/documentation/overview.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -113,16 +113,16 @@ memorable name for the new branch (if you are fixing a reported issue, use
113113

114114
.. code-block:: terminal
115115
116-
$ git checkout -b improve_install_article upstream/5.4
116+
$ git checkout -b improve_install_article upstream/6.4
117117
118118
In this example, the name of the branch is ``improve_install_article`` and the
119-
``upstream/5.4`` value tells Git to create this branch based on the ``5.4``
119+
``upstream/6.4`` value tells Git to create this branch based on the ``6.4``
120120
branch of the ``upstream`` remote, which is the original Symfony Docs repository.
121121

122122
Fixes should always be based on the **oldest maintained branch** which contains
123-
the error. Nowadays this is the ``5.4`` branch. If you are instead documenting a
123+
the error. Nowadays this is the ``6.4`` branch. If you are instead documenting a
124124
new feature, switch to the first Symfony version that included it, e.g.
125-
``upstream/6.2``.
125+
``upstream/7.2``.
126126

127127
**Step 5.** Now make your changes in the documentation. Add, tweak, reword and
128128
even remove any content and do your best to comply with the
@@ -156,7 +156,7 @@ changes should be applied:
156156
:alt: The base branch select option on the GitHub page.
157157

158158
In this example, the **base fork** should be ``symfony/symfony-docs`` and
159-
the **base** branch should be the ``5.4``, which is the branch that you selected
159+
the **base** branch should be the ``4.4``, which is the branch that you selected
160160
to base your changes on. The **head fork** should be your forked copy
161161
of ``symfony-docs`` and the **compare** branch should be ``improve_install_article``,
162162
which is the name of the branch you created and where you made your changes.
@@ -209,7 +209,7 @@ contribution to the Symfony docs:
209209
# create a new branch based on the oldest maintained version
210210
$ cd projects/symfony-docs/
211211
$ git fetch upstream
212-
$ git checkout -b my_changes upstream/5.4
212+
$ git checkout -b my_changes upstream/6.4
213213
214214
# ... do your changes
215215
@@ -258,8 +258,8 @@ into multiple branches, corresponding to the different versions of Symfony itsel
258258
The latest (e.g. ``5.x``) branch holds the documentation for the development branch of
259259
the code.
260260

261-
Unless you're documenting a feature that was introduced after Symfony 5.4,
262-
your changes should always be based on the ``5.4`` branch. Documentation managers
261+
Unless you're documenting a feature that was introduced after Symfony 6.4,
262+
your changes should always be based on the ``6.4`` branch. Documentation managers
263263
will use the necessary Git-magic to also apply your changes to all the active
264264
branches of the documentation.
265265

event_dispatcher.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -541,7 +541,7 @@ Creating an Event Subscriber
541541

542542
Next, you'll need to create an event subscriber, which will hold the logic
543543
that you want to be executed before your controllers. If you're not familiar with
544-
event subscribers, you can learn more about them at :doc:`/event_dispatcher`::
544+
event subscribers, you can learn more about :ref:`how to use them <events-subscriber>`::
545545

546546
// src/EventSubscriber/TokenSubscriber.php
547547
namespace App\EventSubscriber;

reference/configuration/security.rst

+7-78
Original file line numberDiff line numberDiff line change
@@ -38,94 +38,23 @@ separate articles:
3838
* `role_hierarchy`_
3939

4040
access_denied_url
41-
~~~~~~~~~~~~~~~~~
41+
-----------------
4242

4343
**type**: ``string`` **default**: ``null``
4444

4545
Defines the URL where the user is redirected after a ``403`` HTTP error (unless
4646
you define a custom access denial handler). Example: ``/no-permission``
4747

48-
delete_cookies
49-
~~~~~~~~~~~~~~
50-
51-
**type**: ``array`` **default**: ``[]``
52-
53-
Lists the names (and other optional features) of the cookies to delete when the
54-
user logs out::
55-
56-
.. configuration-block::
57-
58-
.. code-block:: yaml
59-
60-
# config/packages/security.yaml
61-
security:
62-
# ...
63-
64-
firewalls:
65-
main:
66-
# ...
67-
logout:
68-
delete_cookies:
69-
cookie1-name: null
70-
cookie2-name:
71-
path: '/'
72-
cookie3-name:
73-
path: null
74-
domain: example.com
75-
76-
.. code-block:: xml
77-
78-
<!-- config/packages/security.xml -->
79-
<?xml version="1.0" encoding="UTF-8" ?>
80-
<srv:container xmlns="http://symfony.com/schema/dic/security"
81-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
82-
xmlns:srv="http://symfony.com/schema/dic/services"
83-
xsi:schemaLocation="http://symfony.com/schema/dic/services
84-
https://symfony.com/schema/dic/services/services-1.0.xsd">
85-
86-
<config>
87-
<!-- ... -->
88-
89-
<firewall name="main">
90-
<!-- ... -->
91-
<logout path="...">
92-
<delete-cookie name="cookie1-name"/>
93-
<delete-cookie name="cookie2-name" path="/"/>
94-
<delete-cookie name="cookie3-name" domain="example.com"/>
95-
</logout>
96-
</firewall>
97-
</config>
98-
</srv:container>
99-
100-
.. code-block:: php
101-
102-
// config/packages/security.php
103-
104-
// ...
105-
106-
return static function (SecurityConfig $securityConfig): void {
107-
// ...
108-
109-
$securityConfig->firewall('main')
110-
->logout()
111-
->deleteCookie('cookie1-name')
112-
->deleteCookie('cookie2-name')
113-
->path('/')
114-
->deleteCookie('cookie3-name')
115-
->path(null)
116-
->domain('example.com');
117-
};
118-
11948
erase_credentials
120-
~~~~~~~~~~~~~~~~~
49+
-----------------
12150

12251
**type**: ``boolean`` **default**: ``true``
12352

12453
If ``true``, the ``eraseCredentials()`` method of the user object is called
12554
after authentication.
12655

12756
hide_user_not_found
128-
~~~~~~~~~~~~~~~~~~~
57+
-------------------
12958

13059
**type**: ``boolean`` **default**: ``true``
13160

@@ -138,7 +67,7 @@ If ``false``, the exception thrown is of type
13867
and it includes the given not found user identifier.
13968

14069
session_fixation_strategy
141-
~~~~~~~~~~~~~~~~~~~~~~~~~
70+
-------------------------
14271

14372
**type**: ``string`` **default**: ``SessionAuthenticationStrategy::MIGRATE``
14473

@@ -157,7 +86,7 @@ The possible values of this option are:
15786
other session attributes are lost.
15887

15988
access_control
160-
~~~~~~~~~~~~~~
89+
--------------
16190

16291
Defines the security protection of the URLs of your application. It's used for
16392
example to trigger the user authentication when trying to access to the backend
@@ -166,7 +95,7 @@ and to allow unauthenticated users to the login form page.
16695
This option is explained in detail in :doc:`/security/access_control`.
16796

16897
firewalls
169-
~~~~~~~~~
98+
---------
17099

171100
This is arguably the most important option of the security config file. It
172101
defines the authentication mechanism used for each URL (or URL pattern) of your
@@ -427,7 +356,7 @@ delete_cookies
427356
**type**: ``array`` **default**: ``[]``
428357

429358
Lists the names (and other optional features) of the cookies to delete when the
430-
user logs out::
359+
user logs out:
431360

432361
.. configuration-block::
433362

0 commit comments

Comments
 (0)