[TASK] Streamline phpdoc annotations in EXT:fluid
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / FlashMessagesViewHelper.php
index b0d2d8c..bb106a9 100644 (file)
@@ -1,27 +1,24 @@
 <?php
 namespace TYPO3\CMS\Fluid\ViewHelpers;
 
-/*                                                                        *
- * 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!                         *
- *                                                                        */
-use TYPO3\CMS\Core\Utility\DeprecationUtility;
+/*
+ * 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 TYPO3\CMS\Core\Messaging\FlashMessageRendererResolver;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
+use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
+use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
+use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * View helper which renders the flash messages (if there are any) as an unsorted list.
@@ -35,31 +32,29 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  * <f:flashMessages />
  * </code>
  * <output>
- * An ul-list of flash messages.
- * </output>
- *
- * <code title="Output with custom css class">
- * <f:flashMessages class="specialClass" />
- * </code>
- * <output>
- * <ul class="specialClass">
- * ...
- * </ul>
+ * A list of flash messages.
  * </output>
  *
  * <code title="TYPO3 core style">
  * <f:flashMessages />
  * </code>
  * <output>
- * <ul class="typo3-messages">
- * <li class="alert alert-ok">
- * <h4>Some Message Header</h4>
- * Some message body
- * </li>
- * <li class="alert alert-notice">
- * Some notice message without header
- * </li>
- * </ul>
+ * <div class="typo3-messages">
+ *  <div class="alert alert-info">
+ *      <div class="media">
+ *          <div class="media-left">
+ *              <span class="fa-stack fa-lg">
+ *                  <i class="fa fa-circle fa-stack-2x"></i>
+ *                  <i class="fa fa-info fa-stack-1x"></i>
+ *              </span>
+ *          </div>
+ *          <div class="media-body">
+ *              <h4 class="alert-title">Info - Title for Info message</h4>
+ *              <p class="alert-message">Message text here.</p>
+ *          </div>
+ *      </div>
+ *  </div>
+ * </div>
  * </output>
  * <code title="Output flash messages as a description list">
  * <f:flashMessages as="flashMessages">
@@ -81,29 +76,25 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  * <code title="Using a specific queue">
  * <f:flashMessages queueIdentifier="myQueue" />
  * </code>
- *
- * @api
  */
-class FlashMessagesViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper
+class FlashMessagesViewHelper extends AbstractViewHelper
 {
-    const RENDER_MODE_UL = 'ul';
-    const RENDER_MODE_DIV = 'div';
+    use CompileWithRenderStatic;
 
     /**
-     * @var string
+     * ViewHelper outputs HTML therefore output escaping has to be disabled
+     *
+     * @var bool
      */
-    protected $tagName = 'ul';
+    protected $escapeOutput = false;
 
     /**
      * Initialize arguments
-     *
-     * @return void
-     * @api
      */
     public function initializeArguments()
     {
-        $this->registerUniversalTagAttributes();
-        $this->registerArgument('queueIdentifier', 'string', 'Flash-message queue to use', false);
+        $this->registerArgument('queueIdentifier', 'string', 'Flash-message queue to use');
+        $this->registerArgument('as', 'string', 'The name of the current flashMessage variable for rendering inside');
     }
 
     /**
@@ -112,100 +103,31 @@ class FlashMessagesViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractT
      * from being cached.
      *
      * @see \TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::no_cache
-     * @param string $renderMode @deprecated since TYPO3 CMS 7.3. If you need custom output, use <f:flashMessages as="messages"><f:for each="messages" as="message">...</f:for></f:flashMessages>
-     * @param string $as The name of the current flashMessage variable for rendering inside
-     * @return string rendered Flash Messages, if there are any.
-     * @api
+     * @param array $arguments
+     * @param \Closure $renderChildrenClosure
+     * @param RenderingContextInterface $renderingContext
+     * @return mixed
      */
-    public function render($renderMode = null, $as = null)
+    public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
     {
-        $queueIdentifier = isset($this->arguments['queueIdentifier']) ? $this->arguments['queueIdentifier'] : null;
-        $flashMessages = $this->controllerContext->getFlashMessageQueue($queueIdentifier)->getAllMessagesAndFlush();
+        $as = $arguments['as'];
+        $queueIdentifier = $arguments['queueIdentifier'] ?? null;
+        $flashMessages = $renderingContext->getControllerContext()
+            ->getFlashMessageQueue($queueIdentifier)->getAllMessagesAndFlush();
         if ($flashMessages === null || count($flashMessages) === 0) {
             return '';
         }
-        if ($renderMode !== null) {
-            DeprecationUtility::logMessage('renderMode has been deprecated in TYPO3 CMS 7.3 and will be removed in TYPO3 CMS 8');
-            if ($renderMode === self::RENDER_MODE_DIV) {
-                $content = $this->renderDiv($flashMessages);
-            } else {
-                $content = $this->renderAsList($flashMessages);
-            }
-        } else {
-            if ($as === null) {
-                $content = $this->renderAsList($flashMessages);
-            } else {
-                $content = $this->renderFromTemplate($flashMessages, $as);
-            }
-        }
 
-        return $content;
-    }
-
-    /**
-     * Renders the flash messages as unordered list
-     *
-     * @param array $flashMessages \TYPO3\CMS\Core\Messaging\FlashMessage[]
-     * @return string
-     */
-    protected function renderAsList(array $flashMessages)
-    {
-        $flashMessagesClass = $this->hasArgument('class') ? $this->arguments['class'] : 'typo3-messages';
-        $tagContent = '';
-        $this->tag->addAttribute('class', $flashMessagesClass);
-        /** @var $singleFlashMessage \TYPO3\CMS\Core\Messaging\FlashMessage */
-        foreach ($flashMessages as $singleFlashMessage) {
-            $severityClass = sprintf('alert %s', $singleFlashMessage->getClass());
-            $messageContent = htmlspecialchars($singleFlashMessage->getMessage());
-            if ($singleFlashMessage->getTitle() !== '') {
-                $messageContent = sprintf('<h4>%s</h4>', htmlspecialchars($singleFlashMessage->getTitle())) . $messageContent;
-            }
-            $tagContent .= sprintf('<li class="%s">%s</li>', htmlspecialchars($severityClass), $messageContent);
+        if ($as === null) {
+            return GeneralUtility::makeInstance(FlashMessageRendererResolver::class)
+                ->resolve()
+                ->render($flashMessages);
         }
-        $this->tag->setContent($tagContent);
-        return $this->tag->render();
-    }
-
-    /**
-     * 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)
-    {
-        $templateVariableContainer = $this->renderingContext->getTemplateVariableContainer();
+        $templateVariableContainer = $renderingContext->getVariableProvider();
         $templateVariableContainer->add($as, $flashMessages);
-        $content = $this->renderChildren();
+        $content = $renderChildrenClosure();
         $templateVariableContainer->remove($as);
 
         return $content;
     }
-
-    /**
-     * Renders the flash messages as nested divs
-     *
-     * @deprecated in 7.3 will be removed in 8.0
-     * @param array $flashMessages \TYPO3\CMS\Core\Messaging\FlashMessage[]
-     * @return string
-     */
-    protected function renderDiv(array $flashMessages)
-    {
-        $this->tag->setTagName('div');
-        if ($this->hasArgument('class')) {
-            $this->tag->addAttribute('class', $this->arguments['class']);
-        } else {
-            $this->tag->addAttribute('class', 'typo3-messages');
-        }
-        $tagContent = '';
-        foreach ($flashMessages as $singleFlashMessage) {
-            $tagContent .= $singleFlashMessage->render();
-        }
-        $this->tag->setContent($tagContent);
-        return $this->tag->render();
-    }
 }