8000 Add documentation about access denied handler by nykopol · Pull Request #7105 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

Add documentation about access denied handler #7105

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
wants to merge 6 commits into from
Closed
Changes from 1 commit
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
Prev Previous commit
Minor rewordings
  • Loading branch information
javiereguiluz authored Nov 21, 2016
commit b30ad2a4e5c60611c7b442135562d83cf23a328b
23 changes: 12 additions & 11 deletions security/access_denied_handler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
How to Create a Custom Access Denied Handler
============================================

When your application throws an ``AccessDeniedException``, you can catch this exception
When your application throws an ``AccessDeniedException``, you can handle this exception
with a service to return a custom response.

On each firewall context you can define a custom access denied handler.
Each firewall context can define its own custom access denied handler:

.. configuration-block::

Expand All @@ -17,13 +17,13 @@ On each firewall context you can define a custom access denied handler.
firewalls:
foo:
# ...
access_denied_handler: custom_handler.service.id
access_denied_handler: app.security.access_denied_handler

.. code-block:: xml

<config>
<firewall name="foo">
<access_denied_handler>custom_handler.service.id</access_denied_handler>
<access_denied_handler>app.security.access_denied_handler</access_denied_handler>
</firewall>
</config>

Expand All @@ -34,16 +34,16 @@ On each firewall context you can define a custom access denied handler.
'firewalls' => array(
'foo' => array(
// ...
'access_denied_handler' => 'custom_handler.service.id',
'access_denied_handler' => 'app.security.access_denied_handler',
),
),
));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please also add an XML config example?



Your handler must implement the
:class:`Symfony\\Component\\Security\\Http\\Authorization\\AccessDeniedHandlerInterface`.
This interface defines one method called ``handle()`` that implements the logic you want
to execute when access is denied to the current user (send a mail, log a message, or
This interface defines one method called ``handle()`` that implements the logic to
execute when access is denied to the current user (send a mail, log a message, or
generally return a custom response).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove one blank line.

.. code-block:: php
Expand All @@ -59,18 +59,19 @@ generally return a custom response).
{
public function handle(Request $request, AccessDeniedException $accessDeniedException)
{
// to some stuff...
// ...

return new Response($content, 403);
}
}

Then you must register your service :
Then, register the service for the access denied handler:

.. code-block:: yaml

# app/config/services.yml
services:
custom_handler.service.id:
app.security.access_denied_handler:
class: AppBundle\Security\AccessDeniedHandler

That's it, now on the ``foo`` firewall, all ``AccessDeniedException`` will be notified to your service.
That's it! Any ``AccessDeniedException`` thrown by the ``foo`` firewall will now be handled by your service.
0