CompileWithContentArgumentAndRenderStatic.php

Go to the documentation of this file.

<?php
namespace TYPO3Fluid\Fluid\Core\ViewHelper\Traits;

/*
 * 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\Fluid\Core\Compiler\TemplateCompiler;
use TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode;
use TYPO3\CMS\Fluid\Core\ViewHelper\Exception;

trait CompileWithContentArgumentAndRenderStatic
{

    protected $contentArgumentName;

    abstract protected function buildRenderChildrenClosure();

    abstract public function prepareArguments();

    public function render()
    {
        $argumentName = $this->resolveContentArgumentName();
        $arguments = $this->arguments;
        if (!empty($argumentName) && isset($arguments[$argumentName])) {
            $renderChildrenClosure = function () use ($arguments, $argumentName) {
                return $arguments[$argumentName];
            };
        } else {
            $renderChildrenClosure = $this->buildRenderChildrenClosure();
        }
        return static::renderStatic(
            $arguments,
            $renderChildrenClosure,
            $this->renderingContext
        );
    }

    public function compile(
        $argumentsName,
        $closureName,
        &$initializationPhpCode,
        AbstractNode $node,
        TemplateCompiler $compiler
    ) {
        $contentArgumentName = $this->resolveContentArgumentName();
        return sprintf(
            '%s::renderStatic(%s, isset(%s[\'%s\']) ? function() use (%s) { return %s[\'%s\']; } : %s, $renderingContext)',
            static::class,
            $argumentsName,
            $argumentsName,
            $contentArgumentName,
            $argumentsName,
            $argumentsName,
            $contentArgumentName,
            $closureName
        );
    }

    protected function resolveContentArgumentName()
    {
        if (empty($this->contentArgumentName)) {
            foreach ($this->prepareArguments() as $registeredArgument) {
                if (!$registeredArgument->isRequired()) {
                    return $registeredArgument->getName();
                }
            }
            throw new Exception(
                'Attempting to compile %s failed. Chosen compile method requires that ViewHelper has ' .
                'at least one registered and optional argument'
            );
        }
        return $this->contentArgumentName;
    }
}