TemplatePaths.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Fluid\View;
 
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Core\Http\ApplicationType;
use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
use ‪TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
use ‪TYPO3\CMS\Extbase\Configuration\ConfigurationManager;
use ‪TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
 
class ‪TemplatePaths extends \TYPO3Fluid\Fluid\View\TemplatePaths
{
    protected ‪$templateSource;
 
    protected ‪$templatePathAndFilename;
 
    protected function ‪getExtensionPrivateResourcesPath(string $extensionKey): ?string
    {
        $extensionKey = trim($extensionKey);
        if ($extensionKey && ‪ExtensionManagementUtility::isLoaded($extensionKey)) {
            return ‪ExtensionManagementUtility::extPath($extensionKey) . 'Resources/Private/';
        }
        return null;
    }
 
    protected function ‪getConfigurationManager(): ‪ConfigurationManagerInterface
    {
        return GeneralUtility::makeInstance(ConfigurationManager::class);
    }
 
    protected function ‪getContextSpecificViewConfiguration(string $extensionKey): array
    {
        if (empty($extensionKey)) {
            return [];
        }
 
        $resources = $this->‪getExtensionPrivateResourcesPath($extensionKey);
        $paths = [
            self::CONFIG_TEMPLATEROOTPATHS => [$resources . 'Templates/'],
            self::CONFIG_PARTIALROOTPATHS => [$resources . 'Partials/'],
            self::CONFIG_LAYOUTROOTPATHS => [$resources . 'Layouts/'],
        ];
 
        $configuredPaths = [];
        if (!empty($this->templateRootPaths) || !empty($this->partialRootPaths) || !empty($this->layoutRootPaths)) {
            // The view was configured already
            $configuredPaths = [
                self::CONFIG_TEMPLATEROOTPATHS => $this->templateRootPaths,
                self::CONFIG_PARTIALROOTPATHS => $this->partialRootPaths,
                self::CONFIG_LAYOUTROOTPATHS => $this->layoutRootPaths,
            ];
        } else {
            $typoScript = (array)$this->‪getConfigurationManager()->getConfiguration(‪ConfigurationManagerInterface::CONFIGURATION_TYPE_FULL_TYPOSCRIPT);
            $signature = str_replace('_', '', $extensionKey);
            if ($this->‪isBackendMode() && isset($typoScript['module.']['tx_' . $signature . '.']['view.'])) {
                $configuredPaths = (array)$typoScript['module.']['tx_' . $signature . '.']['view.'];
                $configuredPaths = GeneralUtility::removeDotsFromTS($configuredPaths);
            } elseif ($this->‪isFrontendMode() && isset($typoScript['plugin.']['tx_' . $signature . '.']['view.'])) {
                $configuredPaths = (array)$typoScript['plugin.']['tx_' . $signature . '.']['view.'];
                $configuredPaths = GeneralUtility::removeDotsFromTS($configuredPaths);
            }
        }
 
        if (empty($configuredPaths)) {
            return $paths;
        }
 
        foreach ($paths as $name => $defaultPaths) {
            if (!empty($configuredPaths[$name])) {
                $configured = ArrayUtility::sortArrayWithIntegerKeys((array)$configuredPaths[$name]);
                // calculate implicit default paths which have not been explicitly configured
                $implicitDefaultPaths = array_diff($defaultPaths, $configured);
                // prepend implicit default paths (which have not been found in configured paths), as fallbacks
                $paths[$name] = array_merge($implicitDefaultPaths, $configured);
            }
        }
 
        return $paths;
    }
 
    public function ‪fillDefaultsByPackageName($packageName): void
    {
        $this->fillFromConfigurationArray($this->‪getContextSpecificViewConfiguration($packageName));
    }
 
    public function ‪setTemplateRootPaths(array $templateRootPaths): void
    {
        parent::setTemplateRootPaths(
            ArrayUtility::sortArrayWithIntegerKeys($templateRootPaths)
        );
    }
 
    public function ‪setLayoutRootPaths(array $layoutRootPaths): void
    {
        parent::setLayoutRootPaths(
            ArrayUtility::sortArrayWithIntegerKeys($layoutRootPaths)
        );
    }
 
    public function ‪setPartialRootPaths(array $partialRootPaths): void
    {
        parent::setPartialRootPaths(
            ArrayUtility::sortArrayWithIntegerKeys($partialRootPaths)
        );
    }
 
    public function ‪getTemplatePathAndFilename(): string
    {
        return ‪$this->templatePathAndFilename;
    }
 
    protected function ‪ensureAbsolutePath($reference): array|string
    {
        if (!is_array($reference)) {
            return ‪PathUtility::isAbsolutePath($reference) ? $reference : GeneralUtility::getFileAbsFileName($reference);
        }
        foreach ($reference as &$subValue) {
            $subValue = $this->‪ensureAbsolutePath($subValue);
        }
        return $reference;
    }
 
    protected function ‪isBackendMode(): bool
    {
        return (‪$GLOBALS['TYPO3_REQUEST'] ?? null) instanceof ServerRequestInterface
            && ‪ApplicationType::fromRequest(‪$GLOBALS['TYPO3_REQUEST'])->isBackend();
    }
 
    protected function ‪isFrontendMode(): bool
    {
        return (‪$GLOBALS['TYPO3_REQUEST'] ?? null) instanceof ServerRequestInterface
            && ‪ApplicationType::fromRequest(‪$GLOBALS['TYPO3_REQUEST'])->isFrontend();
    }
}