[TASK] Streamline phpdoc annotations in EXT:fluid
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Be / Security / IfHasRoleViewHelper.php
index 99dc147..ff37b95 100644 (file)
@@ -1,24 +1,20 @@
 <?php
+namespace TYPO3\CMS\Fluid\ViewHelpers\Be\Security;
 
-/*                                                                        *
- * This script is backported from the FLOW3 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.
@@ -27,7 +23,7 @@
  *
  * <code title="Basic usage">
  * <f:be.security.ifHasRole role="Administrator">
- *   This is being shown in case the current BE user belongs to a BE usergroup (aka role) titled "Administrator" (case sensitive)
+ * This is being shown in case the current BE user belongs to a BE usergroup (aka role) titled "Administrator" (case sensitive)
  * </f:be.security.ifHasRole>
  * </code>
  * <output>
@@ -36,7 +32,7 @@
  *
  * <code title="Using the usergroup uid as role identifier">
  * <f:be.security.ifHasRole role="1">
- *   This is being shown in case the current BE user belongs to a BE usergroup (aka role) with the uid "1"
+ * This is being shown in case the current BE user belongs to a BE usergroup (aka role) with the uid "1"
  * </f:be.security.ifHasRole>
  * </code>
  * <output>
  *
  * <code title="IfRole / then / else">
  * <f:be.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: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:be.security.ifHasRole>
  * </code>
  * <output>
  * 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 Tx_Fluid_ViewHelpers_Be_Security_IfHasRoleViewHelper extends Tx_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) {
-               if ($this->backendUserHasRole($role)) {
-                       return $this->renderThenChild();
-               } else {
-                       return $this->renderElseChild();
-               }
-       }
+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).');
+    }
 
-       /**
-        * Determines whether the currently logged in BE user belongs to the specified usergroup
-        *
-        * @param string $role The usergroup (either the usergroup uid or its title)
-        * @return boolean TRUE if the currently logged in BE user belongs to $role
-        */
-       protected function backendUserHasRole($role) {
-               if (!is_array($GLOBALS['BE_USER']->userGroups)) {
-                       return FALSE;
-               }
-               if (is_numeric($role)) {
-                       foreach($GLOBALS['BE_USER']->userGroups as $userGroup) {
-                               if ((integer)$userGroup['uid'] === (integer)$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;
+    }
 }
-?>
\ No newline at end of file