Twig_Loader_Chain Class Reference

Loads templates from other loaders. More...

Inheritance diagram for Twig_Loader_Chain:

Collaboration diagram for Twig_Loader_Chain:

Public Member Functions
	__construct (array $loaders=array())
	addLoader (Twig_LoaderInterface $loader)
	getSource ($name)
	Gets the source code of a template, given its name. More...
	getSourceContext ($name)
	Returns the source context for a given template logical name. More...
	exists ($name)
	Check if we have the source code of a template, given its name. More...
	getCacheKey ($name)
	Gets the cache key to use for the cache for a given template name. More...
	isFresh ($name, $time)
	Returns true if the template is still fresh. More...
	getSource ($name)
	Gets the source code of a template, given its name. More...
	getCacheKey ($name)
	Gets the cache key to use for the cache for a given template name. More...
	isFresh ($name, $time)
	Returns true if the template is still fresh. More...
	exists ($name)
	Check if we have the source code of a template, given its name. More...
	getSourceContext ($name)
	Returns the source context for a given template logical name. More...

Protected Attributes
	$loaders = array()

Private Attributes
	$hasSourceCache = array()

Detailed Description

Loads templates from other loaders.

@final

Author

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 19 of file Chain.php.

Constructor & Destructor Documentation

__construct()

Twig_Loader_Chain::__construct

(

array

$loaders = array()

)

Parameters

Twig_LoaderInterface[]

$loaders

Definition at line 27 of file Chain.php.

    {
        foreach ($loaders as $loader) {
            $this->addLoader($loader);
        }
    }

References $loader, $loaders, and addLoader().

Here is the call graph for this function:

Member Function Documentation

addLoader()

Twig_Loader_Chain::addLoader

(

Twig_LoaderInterface

$loader

)

Definition at line 34 of file Chain.php.

    {
        $this->loaders[] = $loader;
        $this->hasSourceCache = array();
    }

References $loader.

Referenced by __construct().

Here is the caller graph for this function:

exists()

Twig_Loader_Chain::exists

(

$name

)

Check if we have the source code of a template, given its name.

Parameters

string

$name

The name of the template to check if we can load

Returns

bool If the template source code is handled by this loader or not

Implements Twig_ExistsLoaderInterface.

Definition at line 82 of file Chain.php.

    {
        $name = (string) $name;
 
        if (isset($this->hasSourceCache[$name])) {
            return $this->hasSourceCache[$name];
        }
 
        foreach ($this->loaders as $loader) {
            if ($loader instanceof Twig_ExistsLoaderInterface) {
                if ($loader->exists($name)) {
                    return $this->hasSourceCache[$name] = true;
                }
 
                continue;
            }
 
            try {
                if ($loader instanceof Twig_SourceContextLoaderInterface) {
                    $loader->getSourceContext($name);
                } else {
                    $loader->getSource($name);
                }
 
                return $this->hasSourceCache[$name] = true;
            } catch (Twig_Error_Loader $e) {
            }
        }
 
        return $this->hasSourceCache[$name] = false;
    }

References $loader, and $name.

getCacheKey()

Twig_Loader_Chain::getCacheKey

(

$name

)

Gets the cache key to use for the cache for a given template name.

Parameters

string

$name

The name of the template to load

Returns

string The cache key

Exceptions

Twig_Error_Loader

When $name is not found

Implements Twig_LoaderInterface.

Definition at line 114 of file Chain.php.

    {
        $exceptions = array();
        foreach ($this->loaders as $loader) {
            if ($loader instanceof Twig_ExistsLoaderInterface && !$loader->exists($name)) {
                continue;
            }
 
            try {
                return $loader->getCacheKey($name);
            } catch (Twig_Error_Loader $e) {
                $exceptions[] = get_class($loader).': '.$e->getMessage();
            }
        }
 
        throw new Twig_Error_Loader(sprintf('Template "%s" is not defined%s.', $name, $exceptions ? ' ('.implode(', ', $exceptions).')' : ''));
    }

References $exceptions, $loader, $name, and sprintf.

getSource()

Twig_Loader_Chain::getSource

(

$name

)

Gets the source code of a template, given its name.

Parameters

string

$name

The name of the template to load

Returns

string The template source code

Exceptions

Twig_Error_Loader

When $name is not found

Deprecated:

since 1.27 (to be removed in 2.0), implement Twig_SourceContextLoaderInterface

Implements Twig_LoaderInterface.

Definition at line 40 of file Chain.php.

    {
        @trigger_error(sprintf('Calling "getSource" on "%s" is deprecated since 1.27. Use getSourceContext() instead.', get_class($this)), E_USER_DEPRECATED);
 
        $exceptions = array();
        foreach ($this->loaders as $loader) {
            if ($loader instanceof Twig_ExistsLoaderInterface && !$loader->exists($name)) {
                continue;
            }
 
            try {
                return $loader->getSource($name);
            } catch (Twig_Error_Loader $e) {
                $exceptions[] = $e->getMessage();
            }
        }
 
        throw new Twig_Error_Loader(sprintf('Template "%s" is not defined%s.', $name, $exceptions ? ' ('.implode(', ', $exceptions).')' : ''));
    }

References $exceptions, $loader, $name, and sprintf.

getSourceContext()

Twig_Loader_Chain::getSourceContext

(

$name

)

Returns the source context for a given template logical name.

Parameters

string

$name

The template logical name

Returns

Twig_Source

Exceptions

Twig_Error_Loader

When $name is not found

Implements Twig_SourceContextLoaderInterface.

Definition at line 60 of file Chain.php.

    {
        $exceptions = array();
        foreach ($this->loaders as $loader) {
            if ($loader instanceof Twig_ExistsLoaderInterface && !$loader->exists($name)) {
                continue;
            }
 
            try {
                if ($loader instanceof Twig_SourceContextLoaderInterface) {
                    return $loader->getSourceContext($name);
                }
 
                return new Twig_Source($loader->getSource($name), $name);
            } catch (Twig_Error_Loader $e) {
                $exceptions[] = $e->getMessage();
            }
        }
 
        throw new Twig_Error_Loader(sprintf('Template "%s" is not defined%s.', $name, $exceptions ? ' ('.implode(', ', $exceptions).')' : ''));
    }

References $exceptions, $loader, $name, and sprintf.

isFresh()

Twig_Loader_Chain::isFresh	(		$name,
			$time
	)

Returns true if the template is still fresh.

Parameters

string	$name	The template name
int	$time	Timestamp of the last modification time of the cached template

Returns

bool true if the template is fresh, false otherwise

Exceptions

Twig_Error_Loader

When $name is not found

Implements Twig_LoaderInterface.

Definition at line 132 of file Chain.php.

    {
        $exceptions = array();
        foreach ($this->loaders as $loader) {
            if ($loader instanceof Twig_ExistsLoaderInterface && !$loader->exists($name)) {
                continue;
            }
 
            try {
                return $loader->isFresh($name, $time);
            } catch (Twig_Error_Loader $e) {
                $exceptions[] = get_class($loader).': '.$e->getMessage();
            }
        }
 
        throw new Twig_Error_Loader(sprintf('Template "%s" is not defined%s.', $name, $exceptions ? ' ('.implode(', ', $exceptions).')' : ''));
    }

References $exceptions, $loader, $name, $time, and sprintf.

Field Documentation

$hasSourceCache

Twig_Loader_Chain::$hasSourceCache = array()

private

Definition at line 21 of file Chain.php.

$loaders

Twig_Loader_Chain::$loaders = array()

protected

Definition at line 22 of file Chain.php.

Referenced by __construct().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/twig/twig/lib/Twig/Loader/Chain.php