Twig_Loader_Array Class Reference

Loads a template from an array. More...

Inheritance diagram for Twig_Loader_Array:

Collaboration diagram for Twig_Loader_Array:

Public Member Functions
	__construct (array $templates=array())
	setTemplate ($name, $template)
	Adds or overrides a template. More...
	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...

Protected Attributes
	$templates = array()

Detailed Description

Loads a template from an array.

When using this loader with a cache mechanism, you should know that a new cache key is generated each time a template content "changes" (the cache key being the source code of the template). If you don't want to see your cache grows out of control, you need to take care of clearing the old cache file by yourself.

This loader should only be used for unit testing.

Author

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

Definition at line 26 of file Array.php.

Constructor & Destructor Documentation

__construct()

Twig_Loader_Array::__construct

(

array

$templates = array()

)

Parameters

array

$templates

An array of templates (keys are the names, and values are the source code)

Definition at line 33 of file Array.php.

References $templates.

    {
        $this->templates = $templates;
    }

Member Function Documentation

exists()

Twig_Loader_Array::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 71 of file Array.php.

References $name.

    {
        return isset($this->templates[(string) $name]);
    }

getCacheKey()

Twig_Loader_Array::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 76 of file Array.php.

References $name, and string.

    {
        $name = (string) $name;
        if (!isset($this->templates[$name])) {
            throw new Twig_Error_Loader(sprintf('Template "%s" is not defined.', $name));
        }

        return $name.':'.$this->templates[$name];
    }

getSource()

Twig_Loader_Array::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 49 of file Array.php.

References $name, and string.

    {
        @trigger_error(sprintf('Calling "getSource" on "%s" is deprecated since 1.27. Use getSourceContext() instead.', get_class($this)), E_USER_DEPRECATED);

        $name = (string) $name;
        if (!isset($this->templates[$name])) {
            throw new Twig_Error_Loader(sprintf('Template "%s" is not defined.', $name));
        }

        return $this->templates[$name];
    }

getSourceContext()

Twig_Loader_Array::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 61 of file Array.php.

References $name, and string.

    {
        $name = (string) $name;
        if (!isset($this->templates[$name])) {
            throw new Twig_Error_Loader(sprintf('Template "%s" is not defined.', $name));
        }

        return new Twig_Source($this->templates[$name], $name);
    }

isFresh()

Twig_Loader_Array::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 86 of file Array.php.

References $name, and string.

    {
        $name = (string) $name;
        if (!isset($this->templates[$name])) {
            throw new Twig_Error_Loader(sprintf('Template "%s" is not defined.', $name));
        }

        return true;
    }

setTemplate()

Twig_Loader_Array::setTemplate	(		$name,
			$template
	)

Adds or overrides a template.

Parameters

string	$name	The template name
string	$template	The template source

Definition at line 44 of file Array.php.

References $name, $template, and string.

    {
        $this->templates[(string) $name] = $template;
    }

Field Documentation

$templates

Twig_Loader_Array::$templates = array()

protected

Definition at line 28 of file Array.php.

Referenced by __construct().

---

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

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