[TASK] Streamline phpdoc annotations in EXT:fluid
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Be / Security / IfHasRoleViewHelper.php
index d0abedf..ff37b95 100644 (file)
@@ -1,25 +1,21 @@
 <?php
 namespace TYPO3\CMS\Fluid\ViewHelpers\Be\Security;
 
-/*                                                                        *
- * This script is backported from the TYPO3 Flow package "TYPO3.Fluid".   *
- *                                                                        *
- * It is free software; you can redistribute it and/or modify it under    *
- * the terms of the GNU Lesser General Public License, either version 3   *
- *  of the License, or (at your option) any later version.                *
- *                                                                        *
- *                                                                        *
- * This script is distributed in the hope that it will be useful, but     *
- * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN-    *
- * TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser       *
- * General Public License for more details.                               *
- *                                                                        *
- * You should have received a copy of the GNU Lesser General Public       *
- * License along with the script.                                         *
- * If not, see http://www.gnu.org/licenses/lgpl.html                      *
- *                                                                        *
- * The TYPO3 project - inspiring people to share!                         *
- *                                                                        */
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
+
 /**
  * This view helper implements an ifHasRole/else condition for BE users/groups.
  *
@@ -57,47 +53,44 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Be\Security;
  * Everything inside the "then" tag is displayed if the logged in BE user belongs to the specified role.
  * Otherwise, everything inside the "else"-tag is displayed.
  * </output>
- *
- * @api
  */
-class IfHasRoleViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractConditionViewHelper {
-
-       /**
-        * renders <f:then> child if the current logged in BE user belongs to the specified role (aka usergroup)
-        * otherwise renders <f:else> child.
-        *
-        * @param string $role The usergroup (either the usergroup uid or its title)
-        * @return string the rendered string
-        * @api
-        */
-       public function render($role = '') {
-               return parent::render($role);
-       }
+class IfHasRoleViewHelper extends AbstractConditionViewHelper
+{
+    /**
+     * Initializes the "role" argument.
+     * Renders <f:then> child if the current logged in BE user belongs to the specified role (aka usergroup)
+     * otherwise renders <f:else> child.
+     */
+    public function initializeArguments()
+    {
+        $this->registerArgument('role', 'string', 'The usergroup (either the usergroup uid or its title).');
+    }
 
-       /**
-        * This method decides if the condition is TRUE or FALSE. It can be overriden in extending viewhelpers to adjust functionality.
-        *
-        * @param array $arguments ViewHelper arguments to evaluate the condition for this ViewHelper, allows for flexiblity in overriding this method.
-        * @return bool
-        */
-       static protected function evaluateCondition($arguments = NULL) {
-               $role = $arguments['role'];
-               if (!is_array($GLOBALS['BE_USER']->userGroups)) {
-                       return FALSE;
-               }
-               if (is_numeric($role)) {
-                       foreach ($GLOBALS['BE_USER']->userGroups as $userGroup) {
-                               if ((int)$userGroup['uid'] === (int)$role) {
-                                       return TRUE;
-                               }
-                       }
-               } else {
-                       foreach ($GLOBALS['BE_USER']->userGroups as $userGroup) {
-                               if ($userGroup['title'] === $role) {
-                                       return TRUE;
-                               }
-                       }
-               }
-               return FALSE;
-       }
+    /**
+     * This method decides if the condition is TRUE or FALSE. It can be overridden in extending viewhelpers to adjust functionality.
+     *
+     * @param array $arguments ViewHelper arguments to evaluate the condition for this ViewHelper, allows for flexiblity in overriding this method.
+     * @return bool
+     */
+    protected static function evaluateCondition($arguments = null)
+    {
+        $role = $arguments['role'];
+        if (!is_array($GLOBALS['BE_USER']->userGroups)) {
+            return false;
+        }
+        if (is_numeric($role)) {
+            foreach ($GLOBALS['BE_USER']->userGroups as $userGroup) {
+                if ((int)$userGroup['uid'] === (int)$role) {
+                    return true;
+                }
+            }
+        } else {
+            foreach ($GLOBALS['BE_USER']->userGroups as $userGroup) {
+                if ($userGroup['title'] === $role) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
 }