IncludeTreeAstBuilderVisitor.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\IncludeTree\Visitor;
 
use ‪TYPO3\CMS\Core\TypoScript\AST\AstBuilderInterface;
use ‪TYPO3\CMS\Core\TypoScript\AST\Node\RootNode;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\IncludeInterface;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\SysTemplateInclude;
 
final class ‪IncludeTreeAstBuilderVisitor implements ‪IncludeTreeVisitorInterface
{
    private ‪RootNode ‪$ast;
 
    private array ‪$flatConstants = [];
 
    public function ‪__construct(private readonly ‪AstBuilderInterface $astBuilder)
    {
        $this->ast = new ‪RootNode();
    }
 
    public function ‪setFlatConstants(array ‪$flatConstants)
    {
        $this->flatConstants = ‪$flatConstants;
    }
 
    public function ‪getAst(): ‪RootNode
    {
        return ‪$this->ast;
    }
 
    public function ‪visitBeforeChildren(‪IncludeInterface $include, int $currentDepth): void
    {
        if ($include instanceof ‪SysTemplateInclude && $include->‪isClear()) {
            // Reset any given AST if this sys_template row has clear flag (constants or setup clear) set.
            $this->ast = new ‪RootNode();
        }
    }
 
    public function ‪visit(‪IncludeInterface $include, int $currentDepth): void
    {
        $lineStream = $include->‪getLineStream();
        if ($lineStream && !$include->‪isSplit()) {
            // A "split" include means that the entire TypoScript is split into child includes. The
            // TokenStream of the split include itself must not be parsed, so it's excluded here.
            $this->ast = $this->astBuilder->build($lineStream, $this->ast, $this->flatConstants);
        }
    }
}