Merge pull request symfony#1966 from bicpi/add_role_previous_admin_explanation

weaverryan · weaverryan · commit 8abda413b831 · 2012-11-25T17:25:56.000-08:00
[Security] description for special role ROLE_PREVIOUS_ADMIN
diff --git a/book/security.rst b/book/security.rst
@@ -1644,6 +1644,24 @@ To switch back to the original user, use the special ``_exit`` username:
 
     http://example.com/somewhere?_switch_user=_exit
 
+During impersonation the user is provided with a special role called
+``ROLE_PREVIOUS_ADMIN``. In a template, for instance, this role can decide
+if a link to exit impersonation needs to be shown:
+
+.. configuration-block::
+
+    .. code-block:: html+jinja
+
+        {% if is_granted('ROLE_PREVIOUS_ADMIN') %}
+            <a href="{{ path('homepage', {_switch_user: '_exit'}) }}">Exit impersonation</a>
+        {% endif %}
+
+    .. code-block:: html+php
+
+        <?php if ($view['security']->isGranted('ROLE_PREVIOUS_ADMIN')): ?>
+            <a href="<?php echo $view['router']->generate('homepage', array('_switch_user' => '_exit') ?>">Exit impersonation</a>
+        <?php endif; ?>
+
 Of course, this feature needs to be made available to a small group of users.
 By default, access is restricted to users having the ``ROLE_ALLOWED_TO_SWITCH``
 role. The name of this role can be modified via the ``role`` setting. For
