class ChainLoader

Loads templates from other loaders.

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

Expanded class hierarchy of ChainLoader

1 file declares its use of ChainLoader
Environment.php in vendor/twig/twig/src/Environment.php

File

vendor/twig/twig/src/Loader/ChainLoader.php, line 22

Namespace

Twig\Loader
View source 
final class ChainLoader implements LoaderInterface {
    
    /**
     * @var array<string, bool>
     */
    private $hasSourceCache = [];
    
    /**
     * @param iterable<LoaderInterface> $loaders
     */
    public function __construct(iterable $loaders = []) {
    }
    public function addLoader(LoaderInterface $loader) : void {
        $current = $this->loaders;
        $this->loaders = (static function () use ($current, $loader) : \Generator {
            yield from $current;
            (yield $loader);
        })();
        $this->hasSourceCache = [];
    }
    
    /**
     * @return LoaderInterface[]
     */
    public function getLoaders() : array {
        if (!\is_array($this->loaders)) {
            $this->loaders = iterator_to_array($this->loaders, false);
        }
        return $this->loaders;
    }
    public function getSourceContext(string $name) : Source {
        $exceptions = [];
        foreach ($this->getLoaders() as $loader) {
            if (!$loader->exists($name)) {
                continue;
            }
            try {
                return $loader->getSourceContext($name);
            } catch (LoaderError $e) {
                $exceptions[] = $e->getMessage();
            }
        }
        throw new LoaderError(\sprintf('Template "%s" is not defined%s.', $name, $exceptions ? ' (' . implode(', ', $exceptions) . ')' : ''));
    }
    public function exists(string $name) : bool {
        if (isset($this->hasSourceCache[$name])) {
            return $this->hasSourceCache[$name];
        }
        foreach ($this->getLoaders() as $loader) {
            if ($loader->exists($name)) {
                return $this->hasSourceCache[$name] = true;
            }
        }
        return $this->hasSourceCache[$name] = false;
    }
    public function getCacheKey(string $name) : string {
        $exceptions = [];
        foreach ($this->getLoaders() as $loader) {
            if (!$loader->exists($name)) {
                continue;
            }
            try {
                return $loader->getCacheKey($name);
            } catch (LoaderError $e) {
                $exceptions[] = \get_class($loader) . ': ' . $e->getMessage();
            }
        }
        throw new LoaderError(\sprintf('Template "%s" is not defined%s.', $name, $exceptions ? ' (' . implode(', ', $exceptions) . ')' : ''));
    }
    public function isFresh(string $name, int $time) : bool {
        $exceptions = [];
        foreach ($this->getLoaders() as $loader) {
            if (!$loader->exists($name)) {
                continue;
            }
            try {
                return $loader->isFresh($name, $time);
            } catch (LoaderError $e) {
                $exceptions[] = \get_class($loader) . ': ' . $e->getMessage();
            }
        }
        throw new LoaderError(\sprintf('Template "%s" is not defined%s.', $name, $exceptions ? ' (' . implode(', ', $exceptions) . ')' : ''));
    }

}

Members

Title Modifiers Object type Summary Overriden Title
ChainLoader::$hasSourceCache private property
ChainLoader::addLoader public function
ChainLoader::exists public function Overrides LoaderInterface::exists
ChainLoader::getCacheKey public function Gets the cache key to use for the cache for a given template name. Overrides LoaderInterface::getCacheKey
ChainLoader::getLoaders public function
ChainLoader::getSourceContext public function Returns the source context for a given template logical name. Overrides LoaderInterface::getSourceContext
ChainLoader::isFresh public function Overrides LoaderInterface::isFresh
ChainLoader::__construct public function