StandaloneView.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!                         *
 *                                                                        */

/**
 * A standalone template view.
 * Should be used as view if you want to use Fluid without Extbase extensions
 *
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
 * @api
 */
class Tx_Fluid_View_StandaloneView extends Tx_Fluid_View_AbstractTemplateView {

    /**
     * Source code of the Fluid template
     * @var string
     */
    protected $templateSource = NULL;

    /**
     * absolute path of the Fluid template
     * @var string
     */
    protected $templatePathAndFilename = NULL;

    /**
     * absolute root path of the folder that contains Fluid layouts
     * @var string
     */
    protected $layoutRootPath = NULL;

    /**
     * absolute root path of the folder that contains Fluid partials
     * @var string
     */
    protected $partialRootPath = NULL;

    /**
     * Constructor
     *
     * @param tslib_cObj $contentObject The current cObject. If NULL a new instance will be created
     */
    public function __construct(tslib_cObj $contentObject = NULL) {
        if (!t3lib_extMgm::isLoaded('extbase')) {
            return 'In the current version you still need to have Extbase installed in order to use the Fluid Standalone view!';
        }
        $this->initializeAutoloader();
        $this->objectManager = t3lib_div::makeInstance('Tx_Extbase_Object_ObjectManager');

        $configurationManager = $this->objectManager->get('Tx_Extbase_Configuration_ConfigurationManagerInterface');
        if ($contentObject === NULL) {
            $contentObject = t3lib_div::makeInstance('tslib_cObj');
        }
        $configurationManager->setContentObject($contentObject);

        $this->templateParser = $this->objectManager->get('Tx_Fluid_Core_Parser_TemplateParser');
        $this->setRenderingContext($this->objectManager->create('Tx_Fluid_Core_Rendering_RenderingContext'));

        $request = $this->objectManager->create('Tx_Extbase_MVC_Web_Request');
        $request->setRequestURI(t3lib_div::getIndpEnv('TYPO3_REQUEST_URL'));
        $request->setBaseURI(t3lib_div::getIndpEnv('TYPO3_SITE_URL'));

        $uriBuilder = $this->objectManager->create('Tx_Extbase_MVC_Web_Routing_UriBuilder');
        $uriBuilder->setRequest($request);

        $controllerContext = $this->objectManager->create('Tx_Extbase_MVC_Controller_ControllerContext');
        $controllerContext->setRequest($request);
        $controllerContext->setUriBuilder($uriBuilder);
        $flashMessageContainer = $this->objectManager->get('Tx_Extbase_MVC_Controller_FlashMessages'); // singleton
        $controllerContext->setFlashMessageContainer($flashMessageContainer);
        $this->setControllerContext($controllerContext);
    }

    /**
     * Initializes the Extbase autoloader if it wasn't registered before
     *
     * @return void
     * @see Extbase_Dispatcher::initializeClassLoader()
     */
    protected function initializeAutoloader() {
        if (!class_exists('Tx_Extbase_Utility_ClassLoader', FALSE)) {
            $classLoader = t3lib_div::makeInstance('Tx_Extbase_Utility_ClassLoader');
            spl_autoload_register(array($classLoader, 'loadClass'));
        }
    }

    /**
     * Sets the format of the current request (default format is "html")
     *
     * @param string $format
     * @return void
     * @api
     */
    public function setFormat($format) {
        $this->getRequest()->setFormat($format);
    }

    /**
     * Returns the format of the current request (defaults is "html")
     *
     * @return string $format
     * @api
     */
    public function getFormat() {
        return $this->getRequest()->getFormat();
    }

    /**
     * Returns the current request object
     *
     * @return Tx_Extbase_MVC_Web_Request
     */
    public function getRequest() {
        return $this->controllerContext->getRequest();
    }

    /**
     * Sets the absolute path to a Fluid template file
     *
     * @param string $templatePathAndFilename Fluid template path
     * @return void
     * @api
     */
    public function setTemplatePathAndFilename($templatePathAndFilename) {
        $this->templatePathAndFilename = $templatePathAndFilename;
    }

    /**
     * Returns the absolute path to a Fluid template file if it was specified with setTemplatePathAndFilename() before
     *
     * @return string Fluid template path
     * @api
     */
    public function getTemplatePathAndFilename() {
        return $this->templatePathAndFilename;
    }

    /**
     * Sets the Fluid template source
     * You can use setTemplatePathAndFilename() alternatively if you only want to specify the template path
     *
     * @param string $templateSource Fluid template source code
     * @return void
     * @api
     */
    public function setTemplateSource($templateSource) {
        $this->templateSource = $templateSource;
    }

    /**
     * Sets the absolute path to the folder that contains Fluid layout files
     *
     * @param string $layoutRootPath Fluid layout root path
     * @return void
     * @api
     */
    public function setLayoutRootPath($layoutRootPath) {
        $this->layoutRootPath = $layoutRootPath;
    }

    /**
     * Returns the absolute path to the folder that contains Fluid layout files
     *
     * @return string Fluid layout root path
     * @api
     */
    public function getLayoutRootPath() {
        if ($this->layoutRootPath === NULL && $this->templatePathAndFilename === NULL) {
            throw new Tx_Fluid_View_Exception_InvalidTemplateResourceException('No layout root path has been specified. Use setLayoutRootPath().', 1288091419);
        }
        if ($this->layoutRootPath === NULL) {
            $this->layoutRootPath = dirname($this->templatePathAndFilename) . '/Layouts';
        }
        return $this->layoutRootPath;
    }

    /**
     * Sets the absolute path to the folder that contains Fluid partial files.
     *
     * @param string $partialRootPath Fluid partial root path
     * @return void
     * @api
     */
    public function setPartialRootPath($partialRootPath) {
        $this->partialRootPath = $partialRootPath;
    }

    /**
     * Returns the absolute path to the folder that contains Fluid partial files
     *
     * @return string Fluid partial root path
     * @api
     */
    public function getPartialRootPath() {
        if ($this->partialRootPath === NULL && $this->templatePathAndFilename === NULL) {
            throw new Tx_Fluid_View_Exception_InvalidTemplateResourceException('No partial root path has been specified. Use setPartialRootPath().', 1288094511);
        }
        if ($this->partialRootPath === NULL) {
            $this->partialRootPath = dirname($this->templatePathAndFilename) . '/Partials';
        }
        return $this->partialRootPath;
    }

    /**
     * Checks whether a template can be resolved for the current request
     *
     * @return boolean
     * @api
     */
    public function hasTemplate() {
        try {
            $this->getTemplateSource();
            return TRUE;
        } catch (Tx_Fluid_View_Exception_InvalidTemplateResourceException $e) {
            return FALSE;
        }
    }

    /**
     * Returns the Fluid template source code
     *
     * @param string $actionName Name of the action. This argument is not used in this view!
     * @return string Fluid template source
     * @throws Tx_Fluid_View_Exception_InvalidTemplateResourceException
     */
    protected function getTemplateSource($actionName = NULL) {
        if ($this->templateSource === NULL && $this->templatePathAndFilename === NULL) {
            throw new Tx_Fluid_View_Exception_InvalidTemplateResourceException('No template has been specified. Use either setTemplateSource() or setTemplatePathAndFilename().', 1288085266);
        }
        if ($this->templateSource === NULL) {
            if (!file_exists($this->templatePathAndFilename)) {
                throw new Tx_Fluid_View_Exception_InvalidTemplateResourceException('Template could not be found at "' . $this->templatePathAndFilename . '".', 1288087061);
            }
            $this->templateSource = file_get_contents($this->templatePathAndFilename);
        }
        return $this->templateSource;
    }

    /**
     * Resolves the path and file name of the layout file, based on
     * $this->getLayoutRootPath() and request format and returns the file contents
     *
     * @param string $layoutName Name of the layout to use. If none given, use "default"
     * @return string contents of the layout file if it was found
     * @throws Tx_Fluid_View_Exception_InvalidTemplateResourceException
     */
    protected function getLayoutSource($layoutName = 'default') {
        $layoutRootPath = $this->getLayoutRootPath();
        if (!is_dir($layoutRootPath)) {
            throw new Tx_Fluid_View_Exception_InvalidTemplateResourceException('Layout root path "' . $layoutRootPath . '" does not exist.', 1288092521);
        }
        $possibleLayoutPaths = array();
        $possibleLayoutPaths[] = t3lib_div::fixWindowsFilePath($layoutRootPath . '/' . $layoutName . '.' . $this->getRequest()->getFormat());
        $possibleLayoutPaths[] = t3lib_div::fixWindowsFilePath($layoutRootPath . '/' . $layoutName);
        $found = FALSE;
        foreach($possibleLayoutPaths as $layoutPathAndFilename) {
            if (file_exists($layoutPathAndFilename)) {
                $found = TRUE;
                break;
            }
        }
        if ($found !== TRUE) {
            throw new Tx_Fluid_View_Exception_InvalidTemplateResourceException('Could not load layout file. Tried following paths: "' . implode('", "', $possibleLayoutPaths) . '".', 1288092555);
        }
        return file_get_contents($layoutPathAndFilename);
    }

    /**
     * Resolves the path and file name of the partial file, based on
     * $this->getPartialRootPath() and request format and returns the file contents
     *
     * @param string $partialName The name of the partial
     * @return string contents of the layout file if it was found
     * @throws Tx_Fluid_View_Exception_InvalidTemplateResourceException
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    protected function getPartialSource($partialName) {
        $partialRootPath = $this->getPartialRootPath();
        if (!is_dir($partialRootPath)) {
            throw new Tx_Fluid_View_Exception_InvalidTemplateResourceException('Partial root path "' . $partialRootPath . '" does not exist.', 1288094648);
        }
        $possiblePartialPaths = array();
        $possiblePartialPaths[] = t3lib_div::fixWindowsFilePath($partialRootPath . '/' . $partialName . '.' . $this->getRequest()->getFormat());
        $possiblePartialPaths[] = t3lib_div::fixWindowsFilePath($partialRootPath . '/' . $partialName);
        $found = FALSE;
        foreach($possiblePartialPaths as $partialPathAndFilename) {
            if (file_exists($partialPathAndFilename)) {
                $found = TRUE;
                break;
            }
        }
        if ($found !== TRUE) {
            throw new Tx_Fluid_View_Exception_InvalidTemplateResourceException('Could not load partial file. Tried following paths: "' . implode('", "', $possiblePartialPaths) . '".', 1288092555);
        }
        return file_get_contents($partialPathAndFilename);
    }

}

?>