typo3/sysext/fluid/Classes/ViewHelpers/Security/IfHasRoleViewHelper.php

   1 <?php
   2 namespace TYPO3\CMS\Fluid\ViewHelpers\Security;
   3
   4 /*
   5  * This file is part of the TYPO3 CMS project.
   6  *
   7  * It is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU General Public License, either version 2
   9  * of the License, or any later version.
  10  *
  11  * For the full copyright and license information, please read the
  12  * LICENSE.txt file that was distributed with this source code.
  13  *
  14  * The TYPO3 project - inspiring people to share!
  15  */
  16
  17 use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
  18
  19 /**
  20  * This view helper implements an ifHasRole/else condition for FE users/groups.
  21  *
  22  * = Examples =
  23  *
  24  * <code title="Basic usage">
  25  * <f:security.ifHasRole role="Administrator">
  26  * This is being shown in case the current FE user belongs to a FE usergroup (aka role) titled "Administrator" (case sensitive)
  27  * </f:security.ifHasRole>
  28  * </code>
  29  * <output>
  30  * Everything inside the <f:ifHasRole> tag is being displayed if the logged in FE user belongs to the specified role.
  31  * </output>
  32  *
  33  * <code title="Using the usergroup uid as role identifier">
  34  * <f:security.ifHasRole role="1">
  35  * This is being shown in case the current FE user belongs to a FE usergroup (aka role) with the uid "1"
  36  * </f:security.ifHasRole>
  37  * </code>
  38  * <output>
  39  * Everything inside the <f:ifHasRole> tag is being displayed if the logged in FE user belongs to the specified role.
  40  * </output>
  41  *
  42  * <code title="IfRole / then / else">
  43  * <f:security.ifHasRole role="Administrator">
  44  * <f:then>
  45  * This is being shown in case you have the role.
  46  * </f:then>
  47  * <f:else>
  48  * This is being displayed in case you do not have the role.
  49  * </f:else>
  50  * </f:security.ifHasRole>
  51  * </code>
  52  * <output>
  53  * Everything inside the "then" tag is displayed if the logged in FE user belongs to the specified role.
  54  * Otherwise, everything inside the "else"-tag is displayed.
  55  * </output>
  56  *
  57  * @api
  58  */
  59 class IfHasRoleViewHelper extends AbstractConditionViewHelper
  60 {
  61     /**
  62      * Initializes the "role" argument.
  63      * Renders <f:then> child if the current logged in FE user belongs to the specified role (aka usergroup)
  64      * otherwise renders <f:else> child.
  65      */
  66     public function initializeArguments()
  67     {
  68         $this->registerArgument('role', 'string', 'The usergroup (either the usergroup uid or its title).');
  69     }
  70
  71     /**
  72      * This method decides if the condition is TRUE or FALSE. It can be overridden in extending viewhelpers to adjust functionality.
  73      *
  74      * @param array $arguments ViewHelper arguments to evaluate the condition for this ViewHelper, allows for flexiblity in overriding this method.
  75      * @return bool
  76      */
  77     protected static function evaluateCondition($arguments = null)
  78     {
  79         $role = $arguments['role'];
  80         if (!isset($GLOBALS['TSFE']) || !$GLOBALS['TSFE']->loginUser) {
  81             return false;
  82         }
  83         if (is_numeric($role)) {
  84             return is_array($GLOBALS['TSFE']->fe_user->groupData['uid']) && in_array($role, $GLOBALS['TSFE']->fe_user->groupData['uid']);
  85         }
  86         return is_array($GLOBALS['TSFE']->fe_user->groupData['title']) && in_array($role, $GLOBALS['TSFE']->fe_user->groupData['title']);
  87     }
  88 }