PageTsConfigLoader.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\Core\Configuration\Loader;
 
use Psr\EventDispatcher\EventDispatcherInterface;
use ‪TYPO3\CMS\Core\Configuration\Event\ModifyLoadedPageTsConfigEvent;
use ‪TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser;
use ‪TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
 
class ‪PageTsConfigLoader
{
    protected EventDispatcherInterface ‪$eventDispatcher;
    protected string ‪$globalTsConfig = '';
 
    public function ‪__construct(EventDispatcherInterface ‪$eventDispatcher)
    {
        trigger_error('Class ' . __CLASS__ . ' will be removed with TYPO3 v13.0. Use PageTsConfigFactory instead.', E_USER_DEPRECATED);
        $this->eventDispatcher = ‪$eventDispatcher;
    }
 
    public function ‪setGlobalTsConfig(string ‪$globalTsConfig): void
    {
        $this->globalTsConfig = ‪$globalTsConfig;
    }
 
    public function ‪load(array $rootLine): string
    {
        // Verifying includes, and melt the inclusions together into one string
        $tsData = $this->‪collect($rootLine);
        return implode("\n[GLOBAL]\n", $tsData);
    }
 
    public function ‪collect(array $rootLine): array
    {
        $tsData = [
            'global' => ‪$this->globalTsConfig,
            'default' => ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig'] ?? '',
        ];
        foreach ($rootLine as $page) {
            // Can happen when the rootline is given from BE context, we skip this
            if ((int)$page['uid'] === 0) {
                continue;
            }
            if (trim($page['tsconfig_includes'] ?? '')) {
                $includeTsConfigFileList = ‪GeneralUtility::trimExplode(',', $page['tsconfig_includes'], true);
                // Traversing list
                foreach ($includeTsConfigFileList as $key => $includeTsConfigFile) {
                    if (‪PathUtility::isExtensionPath($includeTsConfigFile)) {
                        [$includeTsConfigFileExtensionKey, $includeTsConfigFilename] = explode(
                            '/',
                            substr($includeTsConfigFile, 4),
                            2
                        );
                        if ((string)$includeTsConfigFileExtensionKey !== ''
                            && ‪ExtensionManagementUtility::isLoaded($includeTsConfigFileExtensionKey)
                            && (string)$includeTsConfigFilename !== ''
                        ) {
                            $extensionPath = ‪ExtensionManagementUtility::extPath($includeTsConfigFileExtensionKey);
                            $includeTsConfigFileAndPath = ‪PathUtility::getCanonicalPath($extensionPath . $includeTsConfigFilename);
                            if (str_starts_with($includeTsConfigFileAndPath, $extensionPath) && file_exists($includeTsConfigFileAndPath)) {
                                $tsData['page_' . $page['uid'] . '_includes_' . $key] = (string)file_get_contents($includeTsConfigFileAndPath);
                            }
                        }
                    }
                }
            }
            $tsData['page_' . $page['uid']] = $page['TSconfig'] ?? '';
        }
 
        $event = $this->eventDispatcher->dispatch(new ‪ModifyLoadedPageTsConfigEvent($tsData, $rootLine));
 
        // Apply includes
        return ‪TypoScriptParser::checkIncludeLines_array($event->getTsConfig());
    }
}