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.

Sign up for GitHub

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

Add documentation about access denied handler #7105

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
10eff85
add documentation about access denied handler
nykopol Oct 31, 2016
3d28e5b
fix yml marker to yaml
nykopol Nov 1, 2016
4731340
fix typo
nykopol Nov 1, 2016
e8b708b
xabbuh review
nykopol Nov 3, 2016
7922dc9
When talking about generic responses, don't spell it as Response (whi…
javiereguiluz Nov 21, 2016
b30ad2a
Minor rewordings
javiereguiluz Nov 21, 2016
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
Next Next commit
xabbuh review
  • Loading branch information
@nykopol
nykopol committed Nov 3, 2016
commit e8b708b2bb4237d6704b24601587711cad34adb0
20 changes: 14 additions & 6 deletions security/access_denied_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
How to Create a Custom Access Denied Handler
============================================

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

On each firewall context you can define a custom access denied handler.
Expand All @@ -19,6 +19,14 @@ On each firewall context you can define a custom access denied handler.
# ...
access_denied_handler: custom_handler.service.id

.. code-block:: xml

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

.. code-block:: php

// app/config/security.php
Expand All @@ -32,20 +40,20 @@ On each firewall context you can define a custom 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 interface
Your handler must implement the
:class:`Symfony\\Component\\Security\\Http\\Authorization\\AccessDeniedHandlerInterface`.
This interface define one method called ``handle()`` that can do whatever you want.
You can use it to send a mail, log a message, or generally return a custom Response.

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
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

namespace AppBundle\Security;
Copy link
Member

Choose a reason for hiding this comment

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

We should better not use AppBundle in this context.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What would be a good place for this class ? For me AppBundle\Security look like a perfect default place for a Foo project.

Copy link
Member

Choose a reason for hiding this comment

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

Ah sorry, I was confused. Of course let's keep it as is.


use Symfony\Component\Security\Http\Authorization\AccessDeniedHandlerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;
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 sort the use statements alphabetically?

use Symfony\Component\Security\Http\Authorization\AccessDeniedHandlerInterface;

class AccessDeniedHandler implements AccessDeniedHandlerInterface
{
Expand Down
0