[TASK] Convert ViewHelpers to static calling 07/52707/4
authorClaus Due <claus@namelesscoder.net>
Fri, 5 May 2017 01:31:07 +0000 (03:31 +0200)
committerWouter Wolters <typo3@wouterwolters.nl>
Thu, 11 May 2017 13:06:45 +0000 (15:06 +0200)
Several ViewHelpers were not yet converted to use
the renderStatic method and CompileWith* traits
from Fluid. This patch converts those.

Change-Id: I17773d4014969c5ad5a3b87bffd34c14871a2958
Releases: master
Resolves: #81143
Reviewed-on: https://review.typo3.org/52707
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Jan Helke <typo3@helke.de>
Tested-by: Jan Helke <typo3@helke.de>
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
typo3/sysext/fluid/Classes/ViewHelpers/BaseViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/FlashMessagesViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/CropViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlentitiesDecodeViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlentitiesViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/JsonViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/StripTagsViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/RenderChildrenViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/TranslateViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Uri/ActionViewHelper.php

index d21d2ab..fd79f5d 100644 (file)
@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Fluid\ViewHelpers;
 
 use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
+use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * View helper which creates a <base href="..."></base> tag. The Base URI is taken from the
@@ -36,6 +37,8 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  */
 class BaseViewHelper extends AbstractViewHelper
 {
+    use CompileWithRenderStatic;
+
     /**
      * As this ViewHelper renders HTML, the output must not be escaped.
      *
@@ -49,24 +52,6 @@ class BaseViewHelper extends AbstractViewHelper
      * Note: renders as <base></base>, because IE6 will else refuse to display
      * the page...
      *
-     * @return string "base"-Tag.
-     * @api
-     */
-    public function render()
-    {
-        return static::renderStatic(
-            [],
-            $this->buildRenderChildrenClosure(),
-            $this->renderingContext
-        );
-    }
-
-    /**
-     * Render the "Base" tag by outputting $request->getBaseUri()
-     *
-     * Note: renders as <base></base>, because IE6 will else refuse to display
-     * the page...
-     *
      * @param array $arguments
      * @param \Closure $renderChildrenClosure
      * @param RenderingContextInterface $renderingContext
@@ -76,7 +61,6 @@ class BaseViewHelper extends AbstractViewHelper
      */
     public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
     {
-        $controllerContext = $renderingContext->getControllerContext();
-        return '<base href="' . htmlspecialchars($controllerContext->getRequest()->getBaseUri()) . '" />';
+        return '<base href="' . htmlspecialchars($renderingContext->getControllerContext()->getRequest()->getBaseUri()) . '" />';
     }
 }
index 4280c08..874e006 100644 (file)
@@ -17,6 +17,8 @@ namespace TYPO3\CMS\Fluid\ViewHelpers;
 use TYPO3\CMS\Core\Messaging\FlashMessageRendererResolver;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
+use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
+use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * View helper which renders the flash messages (if there are any) as an unsorted list.
@@ -79,6 +81,8 @@ use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
  */
 class FlashMessagesViewHelper extends AbstractViewHelper
 {
+    use CompileWithRenderStatic;
+
     /**
      * ViewHelper outputs HTML therefore output escaping has to be disabled
      *
@@ -104,58 +108,32 @@ class FlashMessagesViewHelper extends AbstractViewHelper
      * from being cached.
      *
      * @see \TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::no_cache
-     * @return string rendered Flash Messages, if there are any.
-     * @api
+     * @param array $arguments
+     * @param \Closure $renderChildrenClosure
+     * @param RenderingContextInterface $renderingContext
+     * @return mixed
      */
-    public function render()
+    public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
     {
-        $as = $this->arguments['as'];
-        $queueIdentifier = isset($this->arguments['queueIdentifier']) ? $this->arguments['queueIdentifier'] : null;
-        $flashMessages = $this->renderingContext->getControllerContext()
+        $as = $arguments['as'];
+        $queueIdentifier = isset($arguments['queueIdentifier']) ? $arguments['queueIdentifier'] : null;
+        $flashMessages = $renderingContext->getControllerContext()
             ->getFlashMessageQueue($queueIdentifier)->getAllMessagesAndFlush();
         if ($flashMessages === null || count($flashMessages) === 0) {
             return '';
         }
 
         if ($as === null) {
-            $content = $this->renderDefault($flashMessages);
+            return GeneralUtility::makeInstance(FlashMessageRendererResolver::class)
+                ->resolve()
+                ->render($flashMessages);
         } else {
-            $content = $this->renderFromTemplate($flashMessages, $as);
+            $templateVariableContainer = $renderingContext->getVariableProvider();
+            $templateVariableContainer->add($as, $flashMessages);
+            $content = $renderChildrenClosure();
+            $templateVariableContainer->remove($as);
         }
 
         return $content;
     }
-
-    /**
-     * Renders the flash messages
-     *
-     * @param array $flashMessages \TYPO3\CMS\Core\Messaging\FlashMessage[]
-     * @return string
-     */
-    protected function renderDefault(array $flashMessages) : string
-    {
-        return GeneralUtility::makeInstance(FlashMessageRendererResolver::class)
-            ->resolve()
-            ->render($flashMessages);
-    }
-
-    /**
-     * Renders the flash messages as nested divs
-     * Defer the rendering of Flash Messages to the template. In this case,
-     * the flash messages are stored in the template inside the variable specified
-     * in "as".
-     *
-     * @param array $flashMessages \TYPO3\CMS\Core\Messaging\FlashMessage[]
-     * @param string $as
-     * @return string
-     */
-    protected function renderFromTemplate(array $flashMessages, $as) : string
-    {
-        $templateVariableContainer = $this->renderingContext->getVariableProvider();
-        $templateVariableContainer->add($as, $flashMessages);
-        $content = $this->renderChildren();
-        $templateVariableContainer->remove($as);
-
-        return $content;
-    }
 }
index 19e8ac8..c228d7c 100644 (file)
@@ -19,6 +19,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
 use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
+use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * Use this view helper to crop the text between its opening and closing tags.
@@ -63,6 +64,8 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  */
 class CropViewHelper extends AbstractViewHelper
 {
+    use CompileWithRenderStatic;
+
     /**
      * The output may contain HTML and can not be escaped.
      *
@@ -85,31 +88,6 @@ class CropViewHelper extends AbstractViewHelper
     }
 
     /**
-     * Render the cropped text.
-     *
-     * @return string cropped text
-     * @throws \InvalidArgumentException
-     */
-    public function render()
-    {
-        $maxCharacters = $this->arguments['maxCharacters'];
-        $append = $this->arguments['append'];
-        $respectWordBoundaries = $this->arguments['respectWordBoundaries'];
-        $respectHtml = $this->arguments['respectHtml'];
-
-        return static::renderStatic(
-            [
-                'maxCharacters' => $maxCharacters,
-                'append' => $append,
-                'respectWordBoundaries' => $respectWordBoundaries,
-                'respectHtml' => $respectHtml,
-            ],
-            $this->buildRenderChildrenClosure(),
-            $this->renderingContext
-        );
-    }
-
-    /**
      * @param array $arguments
      * @param \Closure $renderChildrenClosure
      * @param RenderingContextInterface $renderingContext
index 0097c07..9ed1a22 100644 (file)
@@ -15,6 +15,7 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Format;
  */
 
 use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
+use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderStatic;
 
 /**
  * Applies html_entity_decode() to a value
@@ -40,6 +41,8 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  */
 class HtmlentitiesDecodeViewHelper extends AbstractEncodingViewHelper
 {
+    use CompileWithContentArgumentAndRenderStatic;
+
     /**
      * We accept value and children interchangeably, thus we must disable children escaping.
      *
@@ -68,19 +71,7 @@ class HtmlentitiesDecodeViewHelper extends AbstractEncodingViewHelper
     /**
      * Converts all HTML entities to their applicable characters as needed using PHPs html_entity_decode() function.
      *
-     * @return string the altered string
      * @see http://www.php.net/html_entity_decode
-     */
-    public function render()
-    {
-        return static::renderStatic(
-            $this->arguments,
-            $this->buildRenderChildrenClosure(),
-            $this->renderingContext
-        );
-    }
-
-    /**
      * @param array $arguments
      * @param \Closure $renderChildrenClosure
      * @param RenderingContextInterface $renderingContext
@@ -89,13 +80,10 @@ class HtmlentitiesDecodeViewHelper extends AbstractEncodingViewHelper
      */
     public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
     {
-        $value = $arguments['value'];
+        $value = $renderChildrenClosure();
         $encoding = $arguments['encoding'];
         $keepQuotes = $arguments['keepQuotes'];
 
-        if ($value === null) {
-            $value = $renderChildrenClosure();
-        }
         if (!is_string($value)) {
             return $value;
         }
index bb5188d..0495f12 100644 (file)
@@ -14,7 +14,8 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Format;
  * The TYPO3 project - inspiring people to share!
  */
 
-use TYPO3\CMS\Core\SingletonInterface;
+use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
+use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderStatic;
 
 /**
  * Applies htmlentities() escaping to a value
@@ -38,8 +39,10 @@ use TYPO3\CMS\Core\SingletonInterface;
  *
  * @api
  */
-class HtmlentitiesViewHelper extends AbstractEncodingViewHelper implements SingletonInterface
+class HtmlentitiesViewHelper extends AbstractEncodingViewHelper
 {
+    use CompileWithContentArgumentAndRenderStatic;
+
     /**
      * Output gets encoded by this viewhelper
      *
@@ -68,20 +71,19 @@ class HtmlentitiesViewHelper extends AbstractEncodingViewHelper implements Singl
     /**
      * Escapes special characters with their escaped counterparts as needed using PHPs htmlentities() function.
      *
-     * @return string the altered string
      * @see http://www.php.net/manual/function.htmlentities.php
-     * @api
+     * @param array $arguments
+     * @param \Closure $renderChildrenClosure
+     * @param RenderingContextInterface $renderingContext
+     * @return mixed
      */
-    public function render()
+    public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
     {
-        $value = $this->arguments['value'];
-        $encoding = $this->arguments['encoding'];
-        $keepQuotes = $this->arguments['keepQuotes'];
-        $doubleEncode = $this->arguments['doubleEncode'];
+        $value = $renderChildrenClosure();
+        $encoding = $arguments['encoding'];
+        $keepQuotes = $arguments['keepQuotes'];
+        $doubleEncode = $arguments['doubleEncode'];
 
-        if ($value === null) {
-            $value = $this->renderChildren();
-        }
         if (!is_string($value)) {
             return $value;
         }
index 3b8d16e..7f913de 100644 (file)
@@ -18,6 +18,7 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Format;
 
 use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
+use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderStatic;
 
 /**
  * Wrapper for PHPs json_encode function.
@@ -50,11 +51,16 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  */
 class JsonViewHelper extends AbstractViewHelper
 {
+    use CompileWithContentArgumentAndRenderStatic;
+
     /**
      * @var bool
      */
     protected $escapeChildren = false;
 
+    /**
+     * Initialize arguments
+     */
     public function initializeArguments()
     {
         $this->registerArgument('value', 'mixed', 'The incoming data to convert, or null if VH children should be used');
@@ -62,35 +68,23 @@ class JsonViewHelper extends AbstractViewHelper
     }
 
     /**
+     * Applies json_encode() on the specified value.
+     *
      * Outputs content with its JSON representation. To prevent issues in HTML context, occurrences
      * of greater-than or less-than characters are converted to their hexadecimal representations.
      *
      * If $forceObject is TRUE a JSON object is outputted even if the value is a non-associative array
      * Example: array('foo', 'bar') as input will not be ["foo","bar"] but {"0":"foo","1":"bar"}
      *
-     * @return string the JSON-encoded string.
-     * @see http://www.php.net/manual/en/function.json-encode.php
-     * @api
-     */
-    public function render()
-    {
-        return self::renderStatic($this->arguments, $this->buildRenderChildrenClosure(), $this->renderingContext);
-    }
-
-    /**
-     * Applies json_encode() on the specified value.
-     *
      * @param array $arguments
      * @param \Closure $renderChildrenClosure
      * @param RenderingContextInterface $renderingContext
+     * @see http://www.php.net/manual/en/function.json-encode.php
      * @return string
      */
     public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
     {
-        $value = $arguments['value'];
-        if ($value === null) {
-            $value = $renderChildrenClosure();
-        }
+        $value = $renderChildrenClosure();
         $options = JSON_HEX_TAG;
         if ($arguments['forceObject'] !== false) {
             $options = $options | JSON_FORCE_OBJECT;
index e6b52e5..8601728 100644 (file)
@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Format;
 
 use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
+use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderStatic;
 
 /**
  * Removes tags from the given string (applying PHPs strip_tags() function)
@@ -42,6 +43,8 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  */
 class StripTagsViewHelper extends AbstractViewHelper
 {
+    use CompileWithContentArgumentAndRenderStatic;
+
     /**
      * No output escaping as some tags may be allowed
      *
@@ -69,33 +72,12 @@ unction');
     protected $escapeChildren = false;
 
     /**
-     * Escapes special characters with their escaped counterparts as needed using PHPs strip_tags() function.
-     *
-     * @return mixed
-     * @see http://www.php.net/manual/function.strip-tags.php
-     * @api
-     */
-    public function render()
-    {
-        $value = $this->arguments['value'];
-        $allowedTags = $this->arguments['allowedTags'];
-
-        return static::renderStatic(
-            [
-                'value' => $value,
-                'allowedTags' => $allowedTags
-            ],
-            $this->buildRenderChildrenClosure(),
-            $this->renderingContext
-        );
-    }
-
-    /**
      * Applies strip_tags() on the specified value.
      *
      * @param array $arguments
      * @param \Closure $renderChildrenClosure
      * @param \TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface $renderingContext
+     * @see http://www.php.net/manual/function.strip-tags.php
      * @return string
      */
     public static function renderStatic(
@@ -103,11 +85,8 @@ unction');
         \Closure $renderChildrenClosure,
         RenderingContextInterface $renderingContext
     ) {
-        $value = $arguments['value'];
+        $value = $renderChildrenClosure();
         $allowedTags = $arguments['allowedTags'];
-        if ($value === null) {
-            $value = $renderChildrenClosure();
-        }
         if (!is_string($value)) {
             return $value;
         }
index 333b6a7..61451c1 100644 (file)
@@ -33,16 +33,24 @@ class RenderChildrenViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\Abstract
     protected $escapeOutput = false;
 
     /**
-     * @param array $arguments
+     * Initialize arguments
+     */
+    public function initializeArguments()
+    {
+        parent::initializeArguments();
+        $this->registerArgument('arguments', 'array', 'Arguments to assign as template variables', false, []);
+    }
+
+    /**
      * @return string
      */
-    public function render(array $arguments = [])
+    public function render()
     {
         $renderingContext = $this->getWidgetRenderingContext();
         $widgetChildNodes = $this->getWidgetChildNodes();
-        $this->addArgumentsToTemplateVariableContainer($arguments);
+        $this->addArgumentsToTemplateVariableContainer($this->arguments['arguments']);
         $output = $widgetChildNodes->evaluate($renderingContext);
-        $this->removeArgumentsFromTemplateVariableContainer($arguments);
+        $this->removeArgumentsFromTemplateVariableContainer($this->arguments['arguments']);
         return $output;
     }
 
index 0d3eaac..3046929 100644 (file)
@@ -17,6 +17,7 @@ use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableException;
 use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
+use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * Translate a key from locallang. The files are loaded from the folder
@@ -71,6 +72,8 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  */
 class TranslateViewHelper extends AbstractViewHelper
 {
+    use CompileWithRenderStatic;
+
     /**
      * Output is escaped already. We must not escape children, to avoid double encoding.
      *
@@ -94,20 +97,6 @@ class TranslateViewHelper extends AbstractViewHelper
     }
 
     /**
-     * Render translation
-     *
-     * @return string The translated key or tag body if key doesn't exist
-     */
-    public function render()
-    {
-        return static::renderStatic(
-            $this->arguments,
-            $this->buildRenderChildrenClosure(),
-            $this->renderingContext
-        );
-    }
-
-    /**
      * Return array element by key.
      *
      * @param array $arguments
index 85101d4..571b2f8 100644 (file)
@@ -14,6 +14,9 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Uri;
  * The TYPO3 project - inspiring people to share!
  */
 
+use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
+use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
+
 /**
  * A view helper for creating URIs to extbase actions.
  *
@@ -29,6 +32,8 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Uri;
  */
 class ActionViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 {
+    use CompileWithRenderStatic;
+
     /**
      * Initialize arguments
      *
@@ -57,30 +62,32 @@ class ActionViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelp
     }
 
     /**
-     * @return string Rendered link
+     * @param array $arguments
+     * @param \Closure $renderChildrenClosure
+     * @param RenderingContextInterface $renderingContext
+     * @return string
      */
-    public function render()
+    public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
     {
-        $pageUid = $this->arguments['pageUid'];
-        $pageType = $this->arguments['pageType'];
-        $noCache = $this->arguments['noCache'];
-        $noCacheHash = $this->arguments['noCacheHash'];
-        $section = $this->arguments['section'];
-        $format = $this->arguments['format'];
-        $linkAccessRestrictedPages = $this->arguments['linkAccessRestrictedPages'];
-        $additionalParams = $this->arguments['additionalParams'];
-        $absolute = $this->arguments['absolute'];
-        $addQueryString = $this->arguments['addQueryString'];
-        $argumentsToBeExcludedFromQueryString = $this->arguments['argumentsToBeExcludedFromQueryString'];
-        $addQueryStringMethod = $this->arguments['addQueryStringMethod'];
-        $action = $this->arguments['action'];
-        $arguments = $this->arguments['arguments'];
-        $controller = $this->arguments['controller'];
-        $extensionName = $this->arguments['extensionName'];
-        $pluginName = $this->arguments['pluginName'];
+        $pageUid = $arguments['pageUid'];
+        $pageType = $arguments['pageType'];
+        $noCache = $arguments['noCache'];
+        $noCacheHash = $arguments['noCacheHash'];
+        $section = $arguments['section'];
+        $format = $arguments['format'];
+        $linkAccessRestrictedPages = $arguments['linkAccessRestrictedPages'];
+        $additionalParams = $arguments['additionalParams'];
+        $absolute = $arguments['absolute'];
+        $addQueryString = $arguments['addQueryString'];
+        $argumentsToBeExcludedFromQueryString = $arguments['argumentsToBeExcludedFromQueryString'];
+        $addQueryStringMethod = $arguments['addQueryStringMethod'];
+        $action = $arguments['action'];
+        $arguments = $arguments['arguments'];
+        $controller = $arguments['controller'];
+        $extensionName = $arguments['extensionName'];
+        $pluginName = $arguments['pluginName'];
 
-        $uriBuilder = $this->controllerContext->getUriBuilder();
-        $uri = $uriBuilder
+        $uri = $renderingContext->getControllerContext()->getUriBuilder()
             ->reset()
             ->setTargetPageUid($pageUid)
             ->setTargetPageType($pageType)