StandaloneView.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Fluid\View;

use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Utility\ArrayUtility;
use TYPO3\CMS\Fluid\View\Exception\InvalidTemplateResourceException;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;

class StandaloneView extends AbstractTemplateView {

    protected $templateSource = NULL;

    protected $templatePathAndFilename = NULL;


    protected $layoutRootPath = NULL;

    protected $partialRootPath = NULL;

    protected $partialRootPaths = NULL;

    protected $layoutRootPaths = NULL;

    protected $templateCompiler;

    public function __construct(ContentObjectRenderer $contentObject = NULL) {
        $this->objectManager = GeneralUtility::makeInstance('TYPO3\\CMS\\Extbase\\Object\\ObjectManager');
        $configurationManager = $this->objectManager->get('TYPO3\\CMS\\Extbase\\Configuration\\ConfigurationManagerInterface');
        if ($contentObject === NULL) {
            $contentObject = GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectRenderer');
        }
        $configurationManager->setContentObject($contentObject);
        $this->templateParser = $this->objectManager->get('TYPO3\\CMS\\Fluid\\Core\\Parser\\TemplateParser');
        $this->setRenderingContext($this->objectManager->get('TYPO3\\CMS\\Fluid\\Core\\Rendering\\RenderingContext'));
        $request = $this->objectManager->get('TYPO3\\CMS\\Extbase\\Mvc\\Web\\Request');
        $request->setRequestURI(GeneralUtility::getIndpEnv('TYPO3_REQUEST_URL'));
        $request->setBaseURI(GeneralUtility::getIndpEnv('TYPO3_SITE_URL'));
        $uriBuilder = $this->objectManager->get('TYPO3\\CMS\\Extbase\\Mvc\\Web\\Routing\\UriBuilder');
        $uriBuilder->setRequest($request);
        $controllerContext = $this->objectManager->get('TYPO3\\CMS\\Extbase\\Mvc\\Controller\\ControllerContext');
        $controllerContext->setRequest($request);
        $controllerContext->setUriBuilder($uriBuilder);
        $this->setControllerContext($controllerContext);
        $this->templateCompiler = $this->objectManager->get('TYPO3\\CMS\\Fluid\\Core\\Compiler\\TemplateCompiler');
        // singleton
        $this->templateCompiler->setTemplateCache(GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Cache\\CacheManager')->getCache('fluid_template'));
    }

    public function setFormat($format) {
        $this->getRequest()->setFormat($format);
    }

    public function getFormat() {
        return $this->getRequest()->getFormat();
    }

    public function getRequest() {
        return $this->controllerContext->getRequest();
    }

    public function setTemplatePathAndFilename($templatePathAndFilename) {
        $this->templatePathAndFilename = $templatePathAndFilename;
    }

    public function getTemplatePathAndFilename() {
        return $this->templatePathAndFilename;
    }

    public function setTemplateSource($templateSource) {
        $this->templateSource = $templateSource;
    }

    public function setLayoutRootPath($layoutRootPath) {
        $this->layoutRootPath = $layoutRootPath;
        $this->setLayoutRootPaths(array($layoutRootPath));
    }

    public function setLayoutRootPaths(array $layoutRootPaths) {
        $this->layoutRootPaths = $layoutRootPaths;
    }

    public function getLayoutRootPath() {
        $layoutRootPaths = $this->getLayoutRootPaths();
        return array_shift($layoutRootPaths);
    }

    public function getLayoutRootPaths() {
        if ($this->layoutRootPaths === NULL && $this->templatePathAndFilename === NULL) {
            throw new InvalidTemplateResourceException('No layout root path has been specified. Use setLayoutRootPaths().', 1288091419);
        }
        if ($this->layoutRootPaths === NULL) {
            $this->layoutRootPaths = array(dirname($this->templatePathAndFilename) . '/Layouts');
        }
        return $this->layoutRootPaths;
    }

    public function setPartialRootPath($partialRootPath) {
        $this->partialRootPath = $partialRootPath;
        $this->setPartialRootPaths(array($partialRootPath));
    }

    public function getPartialRootPath() {
        $partialRootPaths = $this->getPartialRootPaths();
        return array_shift($partialRootPaths);
    }

    public function setPartialRootPaths(array $partialRootPaths) {
        $this->partialRootPaths = $partialRootPaths;
    }

    public function getPartialRootPaths() {
        if ($this->partialRootPaths === NULL && $this->templatePathAndFilename === NULL) {
            throw new InvalidTemplateResourceException('No partial root path has been specified. Use setPartialRootPaths().', 1288094511);
        }
        if ($this->partialRootPaths === NULL) {
            $this->partialRootPaths = array(dirname($this->templatePathAndFilename) . '/Partials');
        }
        return $this->partialRootPaths;
    }

    public function hasTemplate() {
        try {
            $this->getTemplateSource();
            return TRUE;
        } catch (InvalidTemplateResourceException $e) {
            return FALSE;
        }
    }

    protected function getTemplateIdentifier($actionName = NULL) {
        if ($this->templateSource === NULL) {
            $templatePathAndFilename = $this->getTemplatePathAndFilename();
            $templatePathAndFilenameInfo = pathinfo($templatePathAndFilename);
            $templateFilenameWithoutExtension = basename($templatePathAndFilename, '.' . $templatePathAndFilenameInfo['extension']);
            $prefix = sprintf('template_file_%s', $templateFilenameWithoutExtension);
            return $this->createIdentifierForFile($templatePathAndFilename, $prefix);
        } else {
            $templateSource = $this->getTemplateSource();
            $prefix = 'template_source';
            $templateIdentifier = sprintf('Standalone_%s_%s', $prefix, sha1($templateSource));
            return $templateIdentifier;
        }
    }

    protected function getTemplateSource($actionName = NULL) {
        if ($this->templateSource === NULL && $this->templatePathAndFilename === NULL) {
            throw new InvalidTemplateResourceException('No template has been specified. Use either setTemplateSource() or setTemplatePathAndFilename().', 1288085266);
        }
        if ($this->templateSource === NULL) {
            if (!is_file($this->templatePathAndFilename)) {
                throw new InvalidTemplateResourceException('Template could not be found at "' . $this->templatePathAndFilename . '".', 1288087061);
            }
            $this->templateSource = file_get_contents($this->templatePathAndFilename);
        }
        return $this->templateSource;
    }

    protected function getLayoutIdentifier($layoutName = 'Default') {
        $layoutPathAndFilename = $this->getLayoutPathAndFilename($layoutName);
        $prefix = 'layout_' . $layoutName;
        return $this->createIdentifierForFile($layoutPathAndFilename, $prefix);
    }

    protected function getLayoutSource($layoutName = 'Default') {
        $layoutPathAndFilename = $this->getLayoutPathAndFilename($layoutName);
        $layoutSource = file_get_contents($layoutPathAndFilename);
        if ($layoutSource === FALSE) {
            throw new InvalidTemplateResourceException('"' . $layoutPathAndFilename . '" is not a valid template resource URI.', 1312215888);
        }
        return $layoutSource;
    }

    protected function getLayoutPathAndFilename($layoutName = 'Default') {
        $upperCasedLayoutName = ucfirst($layoutName);
        $possibleLayoutPaths = array();
        $paths = ArrayUtility::sortArrayWithIntegerKeys($this->getLayoutRootPaths());
        $paths = array_reverse($paths, TRUE);
        foreach ($paths as $layoutRootPath) {
            $possibleLayoutPaths[] = GeneralUtility::fixWindowsFilePath($layoutRootPath . '/' . $upperCasedLayoutName . '.' . $this->getRequest()->getFormat());
            $possibleLayoutPaths[] = GeneralUtility::fixWindowsFilePath($layoutRootPath . '/' . $upperCasedLayoutName);
            if ($upperCasedLayoutName !== $layoutName) {
                $possibleLayoutPaths[] = GeneralUtility::fixWindowsFilePath($layoutRootPath . '/' . $layoutName . '.' . $this->getRequest()->getFormat());
                $possibleLayoutPaths[] = GeneralUtility::fixWindowsFilePath($layoutRootPath . '/' . $layoutName);
            }
        }
        foreach ($possibleLayoutPaths as $layoutPathAndFilename) {
            if ($this->testFileExistence($layoutPathAndFilename)) {
                return $layoutPathAndFilename;
            }
        }

        throw new InvalidTemplateResourceException('Could not load layout file. Tried following paths: "' . implode('", "', $possibleLayoutPaths) . '".', 1288092555);
    }

    protected function testFileExistence($filePath) {
        return is_file($filePath);
    }

    protected function getPartialIdentifier($partialName) {
        $partialPathAndFilename = $this->getPartialPathAndFilename($partialName);
        $prefix = 'partial_' . $partialName;
        return $this->createIdentifierForFile($partialPathAndFilename, $prefix);
    }

    protected function getPartialSource($partialName) {
        $partialPathAndFilename = $this->getPartialPathAndFilename($partialName);
        $partialSource = file_get_contents($partialPathAndFilename);
        if ($partialSource === FALSE) {
            throw new InvalidTemplateResourceException('"' . $partialPathAndFilename . '" is not a valid template resource URI.', 1257246932);
        }
        return $partialSource;
    }

    protected function getPartialPathAndFilename($partialName) {
        $upperCasedPartialName = ucfirst($partialName);
        $paths = ArrayUtility::sortArrayWithIntegerKeys($this->getPartialRootPaths());
        $paths = array_reverse($paths, TRUE);
        $possiblePartialPaths = array();
        foreach ($paths as $partialRootPath) {
            $possiblePartialPaths[] = GeneralUtility::fixWindowsFilePath($partialRootPath . '/' . $upperCasedPartialName . '.' . $this->getRequest()->getFormat());
            $possiblePartialPaths[] = GeneralUtility::fixWindowsFilePath($partialRootPath . '/' . $upperCasedPartialName);
            if ($upperCasedPartialName !== $partialName) {
                $possiblePartialPaths[] = GeneralUtility::fixWindowsFilePath($partialRootPath . '/' . $partialName . '.' . $this->getRequest()->getFormat());
                $possiblePartialPaths[] = GeneralUtility::fixWindowsFilePath($partialRootPath . '/' . $partialName);
            }
        }
        foreach ($possiblePartialPaths as $partialPathAndFilename) {
            if ($this->testFileExistence($partialPathAndFilename)) {
                return $partialPathAndFilename;
            }
        }
        throw new InvalidTemplateResourceException('Could not load partial file. Tried following paths: "' . implode('", "', $possiblePartialPaths) . '".', 1288092556);
    }

    protected function createIdentifierForFile($pathAndFilename, $prefix) {
        $templateModifiedTimestamp = filemtime($pathAndFilename);
        $templateIdentifier = sprintf('Standalone_%s_%s', $prefix, sha1($pathAndFilename . '|' . $templateModifiedTimestamp));
        $templateIdentifier = str_replace('/', '_', str_replace('.', '_', $templateIdentifier));
        return $templateIdentifier;
    }
}