*
*
*
* Title: {title}
*
* Tags: {tags -> f:join(separator: ', ')}
*
* User: {user}
*
* The following render calls will be successful:
*
* .. code-block:: xml
*
*
*
*
*
*
*
*
* The following render calls will result in an exception:
*
* .. code-block:: xml
*
*
*
*
*
*
* @api
* @see https://docs.typo3.org/permalink/fluid:typo3fluid-fluid-argument
*/
final class ArgumentViewHelper extends AbstractViewHelper implements ViewHelperNodeInitializedEventInterface
{
/**
* No need to add escaping nodes since the ViewHelper doesn't output anything
*/
protected $escapeOutput = false;
public function initializeArguments(): void
{
$this->registerArgument('name', 'string', 'name of the template argument', true);
$this->registerArgument('type', 'string', 'type of the template argument', true);
$this->registerArgument('description', 'string', 'description of the template argument');
$this->registerArgument('optional', 'boolean', 'true if the defined argument should be optional', false, false);
$this->registerArgument('default', 'mixed', 'default value for optional argument');
}
public function render(): string
{
return '';
}
public function compile($argumentsName, $closureName, &$initializationPhpCode, ViewHelperNode $node, TemplateCompiler $compiler): string
{
return '\'\'';
}
public static function nodeInitializedEvent(ViewHelperNode $node, array $arguments, ParsingState $parsingState): void
{
// Create static values of supplied arguments. A new empty rendering context is used here
// because argument definitions shouldn't be dependent on any variables in the template.
// Any variables that are used anyway (e. g. in default values) will be interpreted as "null"
$emptyRenderingContext = new RenderingContext();
$evaluatedArguments = array_map(
static fn(NodeInterface $node): mixed => $node->evaluate($emptyRenderingContext),
$arguments,
);
$argumentName = (string)$evaluatedArguments['name'];
// Make sure that arguments are not nested into other ViewHelpers as this might create confusion
if ($parsingState->hasNodeTypeInStack(ViewHelperNode::class)) {
throw new \TYPO3Fluid\Fluid\Core\Parser\Exception(sprintf(
'Template argument "%s" needs to be defined at the root level of the template, not within a ViewHelper.',
$argumentName,
), 1744908510);
}
// Make sure that this argument hasn't already been defined in the template
$argumentDefinitions = $parsingState->getArgumentDefinitions();
if (isset($argumentDefinitions[$argumentName])) {
throw new \TYPO3Fluid\Fluid\Core\Parser\Exception(sprintf(
'Template argument "%s" has been defined multiple times.',
$argumentName,
), 1744908509);
}
// Automatically make the argument definition optional if it has a default value
$hasDefaultValue = array_key_exists('default', $evaluatedArguments);
$optional = ($evaluatedArguments['optional'] ?? false) || $hasDefaultValue;
// Create argument definition to be interpreted later during rendering
// This will also be written to the cache by the TemplateCompiler
$argumentDefinitions[$argumentName] = new ArgumentDefinition(
$argumentName,
(string)$evaluatedArguments['type'],
array_key_exists('description', $evaluatedArguments) ? (string)$evaluatedArguments['description'] : '',
!$optional,
$hasDefaultValue ? $evaluatedArguments['default'] : null,
);
$parsingState->setArgumentDefinitions($argumentDefinitions);
}
}