AbstractTemplateView.php

Go to the documentation of this file.

<?php

/*                                                                        *
 * This script belongs to the FLOW3 package "Fluid".                      *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License as published by the *
 * Free Software Foundation, 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!                         *
 *                                                                        */

/**
 * Abstract Fluid Template View.
 *
 * Contains the fundamental methods which any Fluid based template view needs.
 *
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
 */
abstract class Tx_Fluid_View_AbstractTemplateView implements Tx_Extbase_MVC_View_ViewInterface {

    /**
     * Constants defining possible rendering types
     */
    const RENDERING_TEMPLATE = 1;
    const RENDERING_PARTIAL = 2;
    const RENDERING_LAYOUT = 3;

    /**
     * @var Tx_Extbase_MVC_Controller_ControllerContext
     */
    protected $controllerContext;

    /**
     * @var Tx_Extbase_Object_ObjectManagerInterface
     */
    protected $objectManager;

    /**
     * @var Tx_Fluid_Core_Parser_TemplateParser
     */
    protected $templateParser;

    /**
     * The initial rendering context for this template view.
     * Due to the rendering stack, another rendering context might be active
     * at certain points while rendering the template.
     *
     * @var Tx_Fluid_Core_Rendering_RenderingContextInterface
     */
    protected $baseRenderingContext;

    /**
     * Stack containing the current rendering type, the current rendering context, and the current parsed template
     * Do not manipulate directly, instead use the methods"getCurrent*()", "startRendering(...)" and "stopRendering()"
     * @var array
     */
    protected $renderingStack = array();

    /**
     * @param Tx_Extbase_Object_ObjectManagerInterface $objectManager
     * @return void
     * @author Robert Lemke <robert@typo3.org>
     */
    public function injectObjectManager(Tx_Extbase_Object_ObjectManagerInterface $objectManager) {
        $this->objectManager = $objectManager;
    }

    /**
     * Inject the Template Parser
     *
     * @param Tx_Fluid_Core_Parser_TemplateParser $templateParser The template parser
     * @return void
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     */
    public function injectTemplateParser(Tx_Fluid_Core_Parser_TemplateParser $templateParser) {
        $this->templateParser = $templateParser;
    }

    /**
     * Injects a fresh rendering context
     *
     * @param Tx_Fluid_Core_Rendering_RenderingContextInterface $renderingContext
     * @return void
     * @author Robert Lemke <robert@typo3.org>
     */
    public function setRenderingContext(Tx_Fluid_Core_Rendering_RenderingContextInterface $renderingContext) {
        $this->baseRenderingContext = $renderingContext;
        $this->baseRenderingContext->getViewHelperVariableContainer()->setView($this);
        $this->controllerContext = $renderingContext->getControllerContext();
    }

    /**
     * Sets the current controller context
     *
     * @param Tx_Extbase_MVC_Controller_ControllerContext $controllerContext
     * @return void
     * @author Robert Lemke <robert@typo3.org>
     * @api
     */
    public function setControllerContext(Tx_Extbase_MVC_Controller_ControllerContext $controllerContext) {
        $this->controllerContext = $controllerContext;
    }

    public function initializeView() {
    }
    // Here, the backporter can insert the initializeView method, which is needed for Fluid v4.

    /**
     * Assign a value to the variable container.
     *
     * @param string $key The key of a view variable to set
     * @param mixed $value The value of the view variable
     * @return Tx_Fluid_View_AbstractTemplateView the instance of this view to allow chaining
     * @author Robert Lemke <robert@typo3.org>
     * @api
     */
    public function assign($key, $value) {
        $templateVariableContainer = $this->baseRenderingContext->getTemplateVariableContainer();
        if ($templateVariableContainer->exists($key)) {
            $templateVariableContainer->remove($key);
        }
        $templateVariableContainer->add($key, $value);
        return $this;
    }

    /**
     * Assigns multiple values to the JSON output.
     * However, only the key "value" is accepted.
     *
     * @param array $values Keys and values - only a value with key "value" is considered
     * @return Tx_Fluid_View_AbstractTemplateView the instance of this view to allow chaining
     * @author Robert Lemke <robert@typo3.org>
     * @api
     */
    public function assignMultiple(array $values) {
        $templateVariableContainer = $this->baseRenderingContext->getTemplateVariableContainer();
        foreach ($values as $key => $value) {
            if ($templateVariableContainer->exists($key)) {
                $templateVariableContainer->remove($key);
            }
            $templateVariableContainer->add($key, $value);
        }
        return $this;
    }

    /**
     * Loads the template source and render the template.
     * If "layoutName" is set in a PostParseFacet callback, it will render the file with the given layout.
     *
     * @param string $actionName If set, the view of the specified action will be rendered instead. Default is the action specified in the Request object
     * @return string Rendered Template
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     * @author Robert Lemke <robert@typo3.org>
     * @api
     */
    public function render($actionName = NULL) {
        $this->baseRenderingContext->setControllerContext($this->controllerContext);
        $this->templateParser->setConfiguration($this->buildParserConfiguration());
        $parsedTemplate = $this->templateParser->parse($this->getTemplateSource($actionName));

        if ($this->isLayoutDefinedInTemplate($parsedTemplate)) {
            $this->startRendering(self::RENDERING_LAYOUT, $parsedTemplate, $this->baseRenderingContext);
            $parsedLayout = $this->templateParser->parse($this->getLayoutSource($this->getLayoutNameInTemplate($parsedTemplate)));
            $output = $parsedLayout->render($this->baseRenderingContext);
            $this->stopRendering();
        } else {
            $this->startRendering(self::RENDERING_TEMPLATE, $parsedTemplate, $this->baseRenderingContext);
            $output = $parsedTemplate->render($this->baseRenderingContext);
            $this->stopRendering();
        }

        return $output;
    }

    /**
     * Renders a given section.
     *
     * @param string $sectionName Name of section to render
     * @param array $variables the variables to use.
     * @return string rendered template for the section
     * @throws Tx_Fluid_View_Exception_InvalidSectionException
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    public function renderSection($sectionName, array $variables) {
        $parsedTemplate = $this->getCurrentParsedTemplate();

        $sections = $parsedTemplate->getVariableContainer()->get('sections');
        if(!array_key_exists($sectionName, $sections)) {
            throw new Tx_Fluid_View_Exception_InvalidSectionException('The given section does not exist!', 1227108982);
        }
        $section = $sections[$sectionName];

        $renderingContext = $this->getCurrentRenderingContext();
        if ($this->getCurrentRenderingType() === self::RENDERING_LAYOUT) {
            // in case we render a layout right now, we will render a section inside a TEMPLATE.
            $renderingTypeOnNextLevel = self::RENDERING_TEMPLATE;
        } else {
            $variableContainer = $this->objectManager->create('Tx_Fluid_Core_ViewHelper_TemplateVariableContainer', $variables);
            $renderingContext = clone $renderingContext;
            $renderingContext->setTemplateVariableContainer($variableContainer);
            $renderingTypeOnNextLevel = $this->getCurrentRenderingType();
        }

        $renderingContext->getViewHelperVariableContainer()->add('Tx_Fluid_ViewHelpers_SectionViewHelper', 'isCurrentlyRenderingSection', 'TRUE');

        $this->startRendering($renderingTypeOnNextLevel, $parsedTemplate, $renderingContext);
        $output = $section->evaluate($renderingContext);
        $this->stopRendering();

        return $output;
    }

    /**
     * Renders a partial.
     *
     * @param string $partialName
     * @param string $sectionName
     * @param array $variables
     * @param Tx_Fluid_Core_ViewHelper_ViewHelperVariableContainer $viewHelperVariableContainer the View Helper Variable container to use.
     * @return string
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     * @author Bastian Waidelich <bastian@typo3.org>
     * @author Robert Lemke <robert@typo3.org>
     */
    public function renderPartial($partialName, $sectionName, array $variables) {
        $partial = $this->templateParser->parse($this->getPartialSource($partialName));
        $variableContainer = $this->objectManager->create('Tx_Fluid_Core_ViewHelper_TemplateVariableContainer', $variables);
        $renderingContext = clone $this->getCurrentRenderingContext();
        $renderingContext->setTemplateVariableContainer($variableContainer);

        $this->startRendering(self::RENDERING_PARTIAL, $partial, $renderingContext);
        if ($sectionName !== NULL) {
            $output = $this->renderSection($sectionName, $variables);
        } else {
            $output = $partial->render($renderingContext);
        }
        $this->stopRendering();

        return $output;
    }

    /**
     * Resolve the template path and filename for the given action. If $actionName
     * is NULL, looks into the current request.
     *
     * @param string $actionName Name of the action. If NULL, will be taken from request.
     * @return string Full path to template
     * @throws Tx_Fluid_View_Exception_InvalidTemplateResourceException in case the template was not found
     */
    abstract protected function getTemplateSource($actionName = NULL);

    /**
     * Resolve the path and file name of the layout file, based on
     * $this->layoutPathAndFilename and $this->layoutPathAndFilenamePattern.
     *
     * In case a layout has already been set with setLayoutPathAndFilename(),
     * this method returns that path, otherwise a path and filename will be
     * resolved using the layoutPathAndFilenamePattern.
     *
     * @param string $layoutName Name of the layout to use. If none given, use "default"
     * @return string Path and filename of layout file
     * @throws Tx_Fluid_View_Exception_InvalidTemplateResourceException
     */
    abstract protected function getLayoutSource($layoutName = 'default');

    /**
     * Figures out which partial to use.
     *
     * @param string $partialName The name of the partial
     * @return string the full path which should be used. The path definitely exists.
     * @throws Tx_Fluid_View_Exception_InvalidTemplateResourceException
     */
    abstract protected function getPartialSource($partialName);

    /**
     * Build parser configuration
     *
     * @return Tx_Fluid_Core_Parser_Configuration
     * @author Karsten Dambekalns <karsten@typo3.org>
     */
    protected function buildParserConfiguration() {
        $parserConfiguration = $this->objectManager->create('Tx_Fluid_Core_Parser_Configuration');
        if ($this->controllerContext->getRequest()->getFormat() === 'html') {
            $parserConfiguration->addInterceptor($this->objectManager->get('Tx_Fluid_Core_Parser_Interceptor_Escape'));

        }
        return $parserConfiguration;
    }

    /**
     * Returns TRUE if there is a layout defined in the given template via a <f:layout name="..." /> tag.
     *
     * @param Tx_Fluid_Core_Parser_ParsedTemplateInterface $parsedTemplate
     * @return boolean TRUE if a layout has been defined, FALSE otherwise.
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     */
    protected function isLayoutDefinedInTemplate(Tx_Fluid_Core_Parser_ParsedTemplateInterface $parsedTemplate) {
        $variableContainer = $parsedTemplate->getVariableContainer();
        return ($variableContainer !== NULL && $variableContainer->exists('layoutName'));
    }

    /**
     * Returns the name of the layout defined in the template, if one exists.
     *
     * @param Tx_Fluid_Core_Parser_ParsedTemplateInterface $parsedTemplate
     * @return string the Layout name
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     */
    protected function getLayoutNameInTemplate(Tx_Fluid_Core_Parser_ParsedTemplateInterface $parsedTemplate) {
        if ($this->isLayoutDefinedInTemplate($parsedTemplate)) {
            return $parsedTemplate->getVariableContainer()->get('layoutName');
        }
        return NULL;
    }

    /**
     * Start a new nested rendering. Pushes the given information onto the $renderingStack.
     *
     * @param int $type one of the RENDERING_* constants
     * @param Tx_Fluid_Core_Parser_ParsedTemplateInterface $parsedTemplate
     * @param Tx_Fluid_Core_Rendering_RenderingContextInterface $renderingContext
     * @return void
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     */
    protected function startRendering($type, Tx_Fluid_Core_Parser_ParsedTemplateInterface $parsedTemplate, Tx_Fluid_Core_Rendering_RenderingContextInterface $renderingContext) {
        array_push($this->renderingStack, array('type' => $type, 'parsedTemplate' => $parsedTemplate, 'renderingContext' => $renderingContext));
    }

    /**
     * Stops the current rendering. Removes one element from the $renderingStack. Make sure to always call this
     * method pair-wise with startRendering().
     *
     * @return void
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     */
    protected function stopRendering() {
        array_pop($this->renderingStack);
    }

    /**
     * Get the current rendering type.
     *
     * @return one of RENDERING_* constants
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     */
    protected function getCurrentRenderingType() {
        $currentRendering = end($this->renderingStack);
        return $currentRendering['type'];
    }

    /**
     * Get the parsed template which is currently being rendered.
     *
     * @return Tx_Fluid_Core_Parser_ParsedTemplateInterface
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     */
    protected function getCurrentParsedTemplate() {
        $currentRendering = end($this->renderingStack);
        return $currentRendering['parsedTemplate'];
    }

    /**
     * Get the rendering context which is currently used.
     *
     * @return Tx_Fluid_Core_Rendering_RenderingContextInterface
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     */
    protected function getCurrentRenderingContext() {
        $currentRendering = end($this->renderingStack);
        return $currentRendering['renderingContext'];
    }

    /**
     * Tells if the view implementation can render the view for the given context.
     *
     * By default we assume that the view implementation can handle all kinds of
     * contexts. Override this method if that is not the case.
     *
     * @param Tx_Extbase_MVC_Controller_ControllerContext $controllerContext
     * @return boolean TRUE if the view has something useful to display, otherwise FALSE
     * @api
     */
    public function canRender(Tx_Extbase_MVC_Controller_ControllerContext $controllerContext) {
        return TRUE;
    }

}

?>