ConditionVerdictAwareIncludeTreeTraverser.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\Traverser;
 
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\IncludeConditionInterface;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\IncludeInterface;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\RootInclude;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\Visitor\IncludeTreeVisitorInterface;
 
final class ‪ConditionVerdictAwareIncludeTreeTraverser implements ‪IncludeTreeTraverserInterface
{
    public function ‪traverse(‪RootInclude $rootInclude, array $visitors): void
    {
        foreach ($visitors as $visitor) {
            if (!$visitor instanceof ‪IncludeTreeVisitorInterface) {
                throw new \RuntimeException(
                    'Visitors must implement IncludeTreeVisitorInterface',
                    1689244840
                );
            }
        }
        $this->‪traverseRecursive($rootInclude, $visitors, 0);
    }
 
    private function ‪traverseRecursive(‪IncludeInterface $include, array $visitors, int $currentDepth): void
    {
        foreach ($visitors as $visitor) {
            $visitor->visitBeforeChildren($include, $currentDepth);
        }
        if ($include instanceof ‪IncludeConditionInterface && !$include->getConditionVerdict()) {
            // Don't traverse children if condition did not match.
            return;
        }
        foreach ($include->‪getNextChild() as $child) {
            $this->‪traverseRecursive($child, $visitors, $currentDepth + 1);
            foreach ($visitors as $visitor) {
                $visitor->visit($child, $currentDepth);
            }
        }
    }
}