[TASK] Streamline phpdoc annotations in EXT:fluid
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Be / Security / IfHasRoleViewHelper.php
1 <?php
2 namespace TYPO3\CMS\Fluid\ViewHelpers\Be\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 BE users/groups.
21 *
22 * = Examples =
23 *
24 * <code title="Basic usage">
25 * <f:be.security.ifHasRole role="Administrator">
26 * This is being shown in case the current BE user belongs to a BE usergroup (aka role) titled "Administrator" (case sensitive)
27 * </f:be.security.ifHasRole>
28 * </code>
29 * <output>
30 * Everything inside the <f:ifHasRole> tag is being displayed if the logged in BE user belongs to the specified role.
31 * </output>
32 *
33 * <code title="Using the usergroup uid as role identifier">
34 * <f:be.security.ifHasRole role="1">
35 * This is being shown in case the current BE user belongs to a BE usergroup (aka role) with the uid "1"
36 * </f:be.security.ifHasRole>
37 * </code>
38 * <output>
39 * Everything inside the <f:ifHasRole> tag is being displayed if the logged in BE user belongs to the specified role.
40 * </output>
41 *
42 * <code title="IfRole / then / else">
43 * <f:be.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:be.security.ifHasRole>
51 * </code>
52 * <output>
53 * Everything inside the "then" tag is displayed if the logged in BE user belongs to the specified role.
54 * Otherwise, everything inside the "else"-tag is displayed.
55 * </output>
56 */
57 class IfHasRoleViewHelper extends AbstractConditionViewHelper
58 {
59 /**
60 * Initializes the "role" argument.
61 * Renders <f:then> child if the current logged in BE 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 (!is_array($GLOBALS['BE_USER']->userGroups)) {
79 return false;
80 }
81 if (is_numeric($role)) {
82 foreach ($GLOBALS['BE_USER']->userGroups as $userGroup) {
83 if ((int)$userGroup['uid'] === (int)$role) {
84 return true;
85 }
86 }
87 } else {
88 foreach ($GLOBALS['BE_USER']->userGroups as $userGroup) {
89 if ($userGroup['title'] === $role) {
90 return true;
91 }
92 }
93 }
94 return false;
95 }
96 }