.. include:: ../../../../../Includes.txt

.. _typo3-fluid-be-security-ifhasrole:

=====================
be.security.ifHasRole
=====================


This ViewHelper implements an ifHasRole/else condition for backend users
and backend groups.

Role refers to backend user groups. The :html:`role` attribute can either be
the title of a group, or the uid.

Examples
========

Basic usage::

   <f:be.security.ifHasRole role="Administrator">
      This is being shown in case the current BE user belongs to a BE usergroup (aka role) titled "Administrator" (case sensitive)
   </f:be.security.ifHasRole>

Everything inside the :html:`<f:ifHasRole>` tag is being displayed if the
logged in backend user belongs to the specified backend group.

Using the usergroup uid as role identifier::

   <f:be.security.ifHasRole role="1">
      This is being shown in case the current BE user belongs to a BE usergroup (aka role) with the uid "1"
   </f:be.security.ifHasRole>

Everything inside the :html:`<f:ifHasRole>` tag is being displayed if the
logged in backend user belongs to the specified backend group.

IfRole / then / else::

   <f:be.security.ifHasRole role="Administrator">
      <f:then>
         This is being shown in case you have the role.
      </f:then>
      <f:else>
         This is being displayed in case you do not have the role.
      </f:else>
   </f:be.security.ifHasRole>

Everything inside the :html:`<f:then></f:then>` tag is displayed if the
logged in backend user belongs to the specified backend group.
Otherwise, everything inside the :html:`<f:else></f:else>` tag is displayed.

Arguments
=========


.. _be.security.ifhasrole_then:
then
----

:aspect:`DataType`
   mixed

:aspect:`Required`
   false
:aspect:`Description`
   Value to be returned if the condition if met.

.. _be.security.ifhasrole_else:
else
----

:aspect:`DataType`
   mixed

:aspect:`Required`
   false
:aspect:`Description`
   Value to be returned if the condition if not met.

.. _be.security.ifhasrole_role:
role
----

:aspect:`DataType`
   string

:aspect:`Required`
   false
:aspect:`Description`
   The usergroup (either the usergroup uid or its title).