IfHasRoleViewHelper extends AbstractConditionViewHelper
This ViewHelper implements an ifHasRole/else condition for frontend groups.
Examples
Basic usage
::
<f:security.ifHasRole role="Administrator"> This is being shown in case the current FE user belongs to a FE usergroup (aka role) titled "Administrator" (case sensitive) </f:security.ifHasRole>
Everything inside the :html:<f:security.ifHasRole> tag is being displayed if the
logged in frontend user belongs to the specified frontend user group.
Comparison is done by comparing to title of the user groups.
Using the usergroup uid as role identifier
::
<f:security.ifHasRole role="1"> This is being shown in case the current FE user belongs to a FE usergroup (aka role) with the uid "1" </f:security.ifHasRole>
Everything inside the :html:<f:security.ifHasRole> tag is being displayed if the
logged in frontend user belongs to the specified role. Comparison is done
using the uid of frontend user groups.
IfRole / then / else
::
<f: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:security.ifHasRole>
Everything inside the :html:<f:then></f:then> tag is displayed if the logged in FE user belongs to the specified role.
Otherwise, everything inside the :html:<f:else></f:else> tag is displayed.
Table of Contents
Methods
- initializeArguments() : mixed
- Initializes the "role" argument.
- evaluateCondition() : bool
- This method decides if the condition is TRUE or FALSE. It can be overridden in extending viewhelpers to adjust functionality.
Methods
initializeArguments()
Initializes the "role" argument.
public
initializeArguments() : mixed
Renders <f:then> child if the current logged in FE user belongs to the specified role (aka usergroup) otherwise renders <f:else> child.
evaluateCondition()
This method decides if the condition is TRUE or FALSE. It can be overridden in extending viewhelpers to adjust functionality.
protected
static evaluateCondition([array<string|int, mixed> $arguments = null ]) : bool
Parameters
- $arguments : array<string|int, mixed> = null
-
ViewHelper arguments to evaluate the condition for this ViewHelper, allows for flexibility in overriding this method.