RenderChildrenViewHelper.php

Go to the documentation of this file.

<?php
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Fluid\ViewHelpers;
 
use ‪TYPO3\CMS\Fluid\Core\Widget\Exception\RenderingContextNotFoundException;
use ‪TYPO3\CMS\Fluid\Core\Widget\Exception\WidgetRequestNotFoundException;
use ‪TYPO3\CMS\Fluid\Core\Widget\WidgetRequest;
use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
class ‪RenderChildrenViewHelper extends AbstractViewHelper
{
    use CompileWithRenderStatic;
 
    protected ‪$escapeOutput = false;
 
    public function ‪initializeArguments()
    {
        $this->registerArgument('arguments', 'array', 'Arguments to assign as template variables', false, []);
    }
 
    public static function ‪renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
    {
        $subRenderingContext = static::getWidgetRenderingContext($renderingContext);
        $widgetChildNodes = static::getWidgetChildNodes($renderingContext);
        static::addArgumentsToTemplateVariableContainer($subRenderingContext, $arguments['arguments']);
        ‪$output = $widgetChildNodes->evaluate($subRenderingContext);
        static::removeArgumentsFromTemplateVariableContainer($subRenderingContext, $arguments['arguments']);
        return ‪$output;
    }
 
    protected static function ‪getWidgetRenderingContext(RenderingContextInterface $renderingContext)
    {
        $subRenderingContext = static::getWidgetContext($renderingContext)->getViewHelperChildNodeRenderingContext();
        if (!$subRenderingContext instanceof RenderingContextInterface) {
            throw new ‪RenderingContextNotFoundException('Rendering Context not found inside Widget. <f:renderChildren> has been used in an AJAX Request, but is only usable in non-ajax mode.', 1284986604);
        }
        return $subRenderingContext;
    }
 
    protected static function ‪getWidgetChildNodes(RenderingContextInterface $renderingContext)
    {
        return static::getWidgetContext($renderingContext)->getViewHelperChildNodes();
    }
 
    protected static function ‪getWidgetContext(RenderingContextInterface $renderingContext)
    {
        $request = $renderingContext->getControllerContext()->getRequest();
        if (!$request instanceof ‪WidgetRequest) {
            throw new ‪WidgetRequestNotFoundException('The Request is not a WidgetRequest! <f:renderChildren> must be called inside a Widget Template.', 1284986120);
        }
        return $request->getWidgetContext();
    }
 
    protected static function ‪addArgumentsToTemplateVariableContainer(RenderingContextInterface $renderingContext, array $arguments)
    {
        $templateVariableContainer = $renderingContext->getVariableProvider();
        foreach ($arguments as $identifier => $value) {
            $templateVariableContainer->add($identifier, $value);
        }
    }
 
    protected static function ‪removeArgumentsFromTemplateVariableContainer(RenderingContextInterface $renderingContext, array $arguments)
    {
        $templateVariableContainer = $renderingContext->getVariableProvider();
        foreach ($arguments as $identifier => $value) {
            $templateVariableContainer->remove($identifier);
        }
    }
}