FrontendTypoScript.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\TypoScript;
 
use ‪TYPO3\CMS\Core\TypoScript\AST\Node\RootNode;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\RootInclude;
 
final class ‪FrontendTypoScript
{
    private ?‪RootInclude ‪$setupIncludeTree = null;
    private ?‪RootNode ‪$setupTree = null;
    private ?array ‪$setupArray = null;
    private ?‪RootNode ‪$configTree = null;
    private ?array ‪$configArray = null;
    private ?‪RootNode ‪$pageTree = null;
    private ?array ‪$pageArray = null;
 
    public function ‪__construct(
        private readonly ‪RootNode $settingsTree,
        private readonly array $settingsConditionList,
        private readonly array $flatSettings,
        private readonly array $setupConditionList,
    ) {}
 
    public function ‪getSettingsTree(): ‪RootNode
    {
        return $this->settingsTree;
    }
 
    public function ‪getSettingsConditionList(): array
    {
        return $this->settingsConditionList;
    }
 
    public function ‪getFlatSettings(): array
    {
        return $this->flatSettings;
    }
 
    public function ‪getSetupConditionList(): array
    {
        return $this->setupConditionList;
    }
 
    public function ‪setSetupIncludeTree(‪RootInclude ‪$setupIncludeTree): void
    {
        $this->setupIncludeTree = ‪$setupIncludeTree;
    }
 
    public function ‪getSetupIncludeTree(): ?‪RootInclude
    {
        return ‪$this->setupIncludeTree;
    }
 
    public function ‪setSetupTree(‪RootNode ‪$setupTree): void
    {
        $this->setupTree = ‪$setupTree;
    }
 
    public function ‪hasSetup(): bool
    {
        return $this->setupTree !== null;
    }
 
    public function ‪getSetupTree(): ‪RootNode
    {
        if ($this->setupTree === null) {
            throw new \RuntimeException(
                'Setup tree has not been initialized. This happens in cached Frontend scope where full TypoScript' .
                ' is not needed by the system.',
                1666513644
            );
        }
        return ‪$this->setupTree;
    }
 
    public function ‪setSetupArray(array ‪$setupArray): void
    {
        $this->setupArray = ‪$setupArray;
    }
 
    public function ‪getSetupArray(): array
    {
        if ($this->setupArray === null) {
            throw new \RuntimeException(
                'Setup array has not been initialized. This happens in cached Frontend scope where full TypoScript' .
                ' is not needed by the system.',
                1666513645
            );
        }
        return ‪$this->setupArray;
    }
 
    public function ‪setConfigTree(‪RootNode $setupConfig): void
    {
        $this->configTree = $setupConfig;
    }
 
    public function ‪getConfigTree(): ‪RootNode
    {
        if ($this->configTree === null) {
            throw new \RuntimeException(
                'Setup "config." not initialized. FrontendTypoScriptFactory->createSetupConfigOrFullSetup() not called?',
                1710666154
            );
        }
        return ‪$this->configTree;
    }
 
    public function ‪setConfigArray(array ‪$configArray): void
    {
        $this->configArray = ‪$configArray;
    }
 
    public function ‪getConfigArray(): array
    {
        if ($this->configArray === null) {
            throw new \RuntimeException(
                'Setup "config." not initialized. FrontendTypoScriptFactory->createSetupConfigOrFullSetup() not called?',
                1710666123
            );
        }
        return ‪$this->configArray;
    }
 
    public function ‪setPageTree(‪RootNode ‪$pageTree): void
    {
        $this->pageTree = ‪$pageTree;
    }
 
    public function ‪getPageTree(): ‪RootNode
    {
        if ($this->pageTree === null) {
            throw new \RuntimeException(
                'PAGE node has not been initialized. This happens in cached Frontend scope where full TypoScript' .
                ' is not needed by the system, and if a PAGE object for given type could not be determined.' .
                ' Test with hasPage().',
                1710399966
            );
        }
        return ‪$this->pageTree;
    }
 
    public function ‪hasPage(): bool
    {
        return $this->pageTree !== null;
    }
 
    public function ‪setPageArray(array ‪$pageArray): void
    {
        $this->pageArray = ‪$pageArray;
    }
 
    public function ‪getPageArray(): array
    {
        if ($this->pageArray === null) {
            throw new \RuntimeException(
                'PAGE array has not been initialized. This happens in cached Frontend scope where full TypoScript' .
                ' is not needed by the system, and if a PAGE object for given type could not be determined.' .
                ' Test with hasPage().',
                1710399967
            );
        }
        return ‪$this->pageArray;
    }
}