Your IP : 216.73.216.220
<?php
/*
* This file belongs to the package "TYPO3 Fluid".
* See LICENSE.txt that was shipped with this package.
*/
namespace TYPO3Fluid\Fluid\ViewHelpers;
use TYPO3Fluid\Fluid\Core\Parser\ParsedTemplateInterface;
use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
use TYPO3Fluid\Fluid\Core\ViewHelper\Exception;
use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
/**
* A ViewHelper to render a section, a partial, a specified section in a partial
* or a delegate ParsedTemplateInterface implementation.
*
* Examples
* ========
*
* Rendering partials
* ------------------
*
* ::
*
* <f:render partial="SomePartial" arguments="{foo: someVariable}" />
*
* Output::
*
* the content of the partial "SomePartial". The content of the variable {someVariable} will be available in the partial as {foo}
*
* Rendering sections
* ------------------
*
* ::
*
* <f:section name="someSection">This is a section. {foo}</f:section>
* <f:render section="someSection" arguments="{foo: someVariable}" />
*
* Output::
*
* the content of the section "someSection". The content of the variable {someVariable} will be available in the partial as {foo}
*
* Rendering recursive sections
* ----------------------------
*
* ::
*
* <f:section name="mySection">
* <ul>
* <f:for each="{myMenu}" as="menuItem">
* <li>
* {menuItem.text}
* <f:if condition="{menuItem.subItems}">
* <f:render section="mySection" arguments="{myMenu: menuItem.subItems}" />
* </f:if>
* </li>
* </f:for>
* </ul>
* </f:section>
* <f:render section="mySection" arguments="{myMenu: menu}" />
*
* Output::
*
* <ul>
* <li>menu1
* <ul>
* <li>menu1a</li>
* <li>menu1b</li>
* </ul>
* </li>
* [...]
* (depending on the value of {menu})
*
*
* Passing all variables to a partial
* ----------------------------------
*
* ::
*
* <f:render partial="somePartial" arguments="{_all}" />
*
* Output::
*
* the content of the partial "somePartial".
* Using the reserved keyword "_all", all available variables will be passed along to the partial
*
*
* Rendering via a delegate ParsedTemplateInterface implementation w/ custom arguments
* -----------------------------------------------------------------------------------
*
* ::
*
* <f:render delegate="My\Special\ParsedTemplateImplementation" arguments="{_all}" />
*
* This will output whichever output was generated by calling ``My\Special\ParsedTemplateImplementation->render()``
* with cloned RenderingContextInterface $renderingContext as only argument and content of arguments
* assigned in VariableProvider of cloned context. Supports all other input arguments including
* recursive rendering, contentAs argument, default value etc.
*
* Note that while ParsedTemplateInterface supports returning a Layout name, this Layout will not
* be respected when rendering using this method. Only the ``render()`` method will be called!
*
* @api
*/
class RenderViewHelper extends AbstractViewHelper
{
use CompileWithRenderStatic;
/**
* @var bool
*/
protected $escapeOutput = false;
public function initializeArguments()
{
parent::initializeArguments();
$this->registerArgument('section', 'string', 'Section to render - combine with partial to render section in partial');
$this->registerArgument('partial', 'string', 'Partial to render, with or without section');
$this->registerArgument('delegate', 'string', 'Optional PHP class name of a permanent, included-in-app ParsedTemplateInterface implementation to override partial/section');
$this->registerArgument('arguments', 'array', 'Array of variables to be transferred. Use {_all} for all variables', false, []);
$this->registerArgument('optional', 'boolean', 'If TRUE, considers the *section* optional. Partial never is.', false, false);
$this->registerArgument('default', 'mixed', 'Value (usually string) to be displayed if the section or partial does not exist');
$this->registerArgument('contentAs', 'string', 'If used, renders the child content and adds it as a template variable with this name for use in the partial/section');
}
/**
* @return mixed
*/
public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
{
$section = $arguments['section'];
$partial = $arguments['partial'];
$variables = (array)$arguments['arguments'];
$optional = (bool)$arguments['optional'];
$delegate = $arguments['delegate'];
$tagContent = null;
if ($arguments['contentAs']) {
$tagContent = $renderChildrenClosure();
$variables[$arguments['contentAs']] = $tagContent;
}
$view = $renderingContext->getViewHelperVariableContainer()->getView();
if (!$view) {
throw new Exception(
'The f:render ViewHelper was used in a context where the ViewHelperVariableContainer does not contain ' .
'a reference to the View. Normally this is taken care of by the TemplateView, so most likely this ' .
'error is because you overrode AbstractTemplateView->initializeRenderingContext() and did not call ' .
'$renderingContext->getViewHelperVariableContainer()->setView($this) or parent::initializeRenderingContext. ' .
'This is an issue you must fix in your code as f:render is fully unable to render anything without a View.'
);
}
$content = '';
if ($delegate !== null) {
if (!is_a($delegate, ParsedTemplateInterface::class, true)) {
throw new \InvalidArgumentException(sprintf('Cannot render %s - must implement ParsedTemplateInterface!', $delegate));
}
$renderingContext = clone $renderingContext;
$renderingContext->getVariableProvider()->setSource($variables);
$content = (new $delegate())->render($renderingContext);
} elseif ($partial !== null) {
$content = $view->renderPartial($partial, $section, $variables, $optional);
} elseif ($section !== null) {
$content = $view->renderSection($section, $variables, $optional);
} elseif (!$optional) {
throw new \InvalidArgumentException('ViewHelper f:render called without either argument section, partial or delegate and optional flag is false');
}
// Replace empty content with default value. If default is
// not set, NULL is returned and cast to a new, empty string
// outside this ViewHelper.
if ($content === '') {
$content = $arguments['default'] ?: $tagContent ?: $renderChildrenClosure();
}
return $content;
}
}