[TASK] Update php-cs-fixer to 2.5.0
[Packages/TYPO3.CMS.git] / 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 /**
18 * This view helper implements an ifHasRole/else condition for FE users/groups.
19 *
20 * = Examples =
21 *
22 * <code title="Basic usage">
23 * <f:security.ifHasRole role="Administrator">
24 * This is being shown in case the current FE user belongs to a FE usergroup (aka role) titled "Administrator" (case sensitive)
25 * </f:security.ifHasRole>
26 * </code>
27 * <output>
28 * Everything inside the <f:ifHasRole> tag is being displayed if the logged in FE user belongs to the specified role.
29 * </output>
30 *
31 * <code title="Using the usergroup uid as role identifier">
32 * <f:security.ifHasRole role="1">
33 * This is being shown in case the current FE user belongs to a FE usergroup (aka role) with the uid "1"
34 * </f:security.ifHasRole>
35 * </code>
36 * <output>
37 * Everything inside the <f:ifHasRole> tag is being displayed if the logged in FE user belongs to the specified role.
38 * </output>
39 *
40 * <code title="IfRole / then / else">
41 * <f:security.ifHasRole role="Administrator">
42 * <f:then>
43 * This is being shown in case you have the role.
44 * </f:then>
45 * <f:else>
46 * This is being displayed in case you do not have the role.
47 * </f:else>
48 * </f:security.ifHasRole>
49 * </code>
50 * <output>
51 * Everything inside the "then" tag is displayed if the logged in FE user belongs to the specified role.
52 * Otherwise, everything inside the "else"-tag is displayed.
53 * </output>
54 *
55 * @api
56 */
57 class IfHasRoleViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractConditionViewHelper
58 {
59 /**
60 * Initializes the "role" argument.
61 * Renders <f:then> child if the current logged in FE user belongs to the specified role (aka usergroup)
62 * otherwise renders <f:else> child.
63 */
64 public function initializeArguments()
65 {
66 $this->registerArgument('role', 'string', 'The usergroup (either the usergroup uid or its title).');
67 }
68
69 /**
70 * This method decides if the condition is TRUE or FALSE. It can be overridden in extending viewhelpers to adjust functionality.
71 *
72 * @param array $arguments ViewHelper arguments to evaluate the condition for this ViewHelper, allows for flexiblity in overriding this method.
73 * @return bool
74 */
75 protected static function evaluateCondition($arguments = null)
76 {
77 $role = $arguments['role'];
78 if (!isset($GLOBALS['TSFE']) || !$GLOBALS['TSFE']->loginUser) {
79 return false;
80 }
81 if (is_numeric($role)) {
82 return is_array($GLOBALS['TSFE']->fe_user->groupData['uid']) && in_array($role, $GLOBALS['TSFE']->fe_user->groupData['uid']);
83 }
84 return is_array($GLOBALS['TSFE']->fe_user->groupData['title']) && in_array($role, $GLOBALS['TSFE']->fe_user->groupData['title']);
85 }
86
87 /**
88 * @return mixed
89 */
90 public function render()
91 {
92 if (static::evaluateCondition($this->arguments)) {
93 return $this->renderThenChild();
94 }
95 return $this->renderElseChild();
96 }
97 }