Skip to content

Documenting createAccessDeniedException() method #3486

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

Merged
merged 4 commits into from
Feb 2, 2014
Merged

Documenting createAccessDeniedException() method #3486

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6fd3f93
Documenting createAccessDeniedException() method
klaussilveira Jan 17, 2014
53f156c
Updating references to match doc format
klaussilveira Jan 17, 2014
b1b9090
Adding versionadded detail
klaussilveira Jan 17, 2014
da6002d
Wrapping line
klaussilveira Jan 17, 2014
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
9 changes: 7 additions & 2 deletions book/security.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1072,19 +1072,24 @@ fine-grained enough in certain cases. When necessary, you can easily force
authorization from inside a controller::

// ...
use Symfony\Component\Security\Core\Exception\AccessDeniedException;

public function helloAction($name)
{
if (false === $this->get('security.context')->isGranted('ROLE_ADMIN')) {
throw new AccessDeniedException();
throw $this->createAccessDeniedException('Unable to access this page!');
}

// ...
}

.. _book-security-securing-controller-annotations:

.. versionadded:: 2.5
The ``createAccessDeniedException`` method was introduced in Symfony 2.5.

The :method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::createAccessDeniedException()` method creates a special :class:`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.

Let's add a versionadded block above this:

.. versionadded:: 2.5
    The ``createAccessDeniedException`` method was introduced in Symfony 2.5.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, missed that. Updated.

object, which ultimately triggers a 403 HTTP response inside Symfony.
Copy link
Member

Choose a reason for hiding this comment

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

And can you please wrap lines after the first word that crosses the 72nd character?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.


Thanks to the SensioFrameworkExtraBundle, you can also secure your controller using annotations::

// ...
Expand Down