Twig_Loader_Filesystem Class Reference

Loads template from the filesystem. More...

Inheritance diagram for Twig_Loader_Filesystem:

Collaboration diagram for Twig_Loader_Filesystem:

Public Member Functions
	__construct ($paths=array(), $rootPath=null)
	getPaths ($namespace=self::MAIN_NAMESPACE)
	Returns the paths to the templates. More...
	getNamespaces ()
	Returns the path namespaces. More...
	setPaths ($paths, $namespace=self::MAIN_NAMESPACE)
	Sets the paths where templates are stored. More...
	addPath ($path, $namespace=self::MAIN_NAMESPACE)
	Adds a path where templates are stored. More...
	prependPath ($path, $namespace=self::MAIN_NAMESPACE)
	Prepends a path where templates are stored. 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...
	getCacheKey ($name)
	Gets the cache key to use for the cache for a given template name. More...
	exists ($name)
	Check if we have the source code of a template, given its name. More...
	isFresh ($name, $time)
	Returns true if the template is still fresh. More...

Data Fields
const	MAIN_NAMESPACE = '__main__'
	Identifier of the main namespace. More...

Protected Member Functions
	findTemplate ($name)
	parseName ($name, $default=self::MAIN_NAMESPACE)
	normalizeName ($name)
	validateName ($name)

Protected Attributes
	$paths = array()
	$cache = array()
	$errorCache = array()

Private Member Functions
	isAbsolutePath ($file)

Private Attributes
	$rootPath

Detailed Description

Loads template from the filesystem.

Author

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

Definition at line 17 of file Filesystem.php.

Constructor & Destructor Documentation

__construct()

Twig_Loader_Filesystem::__construct	(		$paths = array(),
			$rootPath = null
	)

Parameters

string | array	$paths	A path or an array of paths where to look for templates
string | null	$rootPath	The root path common to all relative paths (null for getcwd())

Definition at line 32 of file Filesystem.php.

References $paths, $rootPath, and setPaths().

    {
        $this->rootPath = (null === $rootPath ? getcwd() : $rootPath).DIRECTORY_SEPARATOR;
        if (false !== $realPath = realpath($rootPath)) {
            $this->rootPath = $realPath.DIRECTORY_SEPARATOR;
        }

        if ($paths) {
            $this->setPaths($paths);
        }
    }

Here is the call graph for this function:

Member Function Documentation

addPath()

Twig_Loader_Filesystem::addPath	(		$path,
			$namespace = self::MAIN_NAMESPACE
	)

Adds a path where templates are stored.

Parameters

string	$path	A path where to look for templates
string	$namespace	A path namespace

Exceptions

Twig_Error_Loader

Definition at line 94 of file Filesystem.php.

References $namespace, $path, and isAbsolutePath().

Referenced by setPaths().

    {
        // invalidate the cache
        $this->cache = $this->errorCache = array();

        $checkPath = $this->isAbsolutePath($path) ? $path : $this->rootPath.$path;
        if (!is_dir($checkPath)) {
            throw new Twig_Error_Loader(sprintf('The "%s" directory does not exist ("%s").', $path, $checkPath));
        }

        $this->paths[$namespace][] = rtrim($path, '/\\');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exists()

Twig_Loader_Filesystem::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 159 of file Filesystem.php.

References $name, findTemplate(), and normalizeName().

    {
        $name = $this->normalizeName($name);

        if (isset($this->cache[$name])) {
            return true;
        }

        try {
            return false !== $this->findTemplate($name, false);
        } catch (Twig_Error_Loader $exception) {
            @trigger_error(sprintf('In %s::findTemplate(), you must accept a second argument that when set to "false" returns "false" instead of throwing an exception. Not supporting this argument is deprecated since version 1.27.', get_class($this)), E_USER_DEPRECATED);

            return false;
        }
    }

Here is the call graph for this function:

findTemplate()

Twig_Loader_Filesystem::findTemplate (   $name )

protected

Definition at line 181 of file Filesystem.php.

References $name, $namespace, $path, isAbsolutePath(), normalizeName(), parseName(), and validateName().

Referenced by exists(), getCacheKey(), getSource(), getSourceContext(), and isFresh().

    {
        $throw = func_num_args() > 1 ? func_get_arg(1) : true;
        $name = $this->normalizeName($name);

        if (isset($this->cache[$name])) {
            return $this->cache[$name];
        }

        if (isset($this->errorCache[$name])) {
            if (!$throw) {
                return false;
            }

            throw new Twig_Error_Loader($this->errorCache[$name]);
        }

        $this->validateName($name);

        list($namespace, $shortname) = $this->parseName($name);

        if (!isset($this->paths[$namespace])) {
            $this->errorCache[$name] = sprintf('There are no registered paths for namespace "%s".', $namespace);

            if (!$throw) {
                return false;
            }

            throw new Twig_Error_Loader($this->errorCache[$name]);
        }

        foreach ($this->paths[$namespace] as $path) {
            if (!$this->isAbsolutePath($path)) {
                $path = $this->rootPath.'/'.$path;
            }

            if (is_file($path.'/'.$shortname)) {
                if (false !== $realpath = realpath($path.'/'.$shortname)) {
                    return $this->cache[$name] = $realpath;
                }

                return $this->cache[$name] = $path.'/'.$shortname;
            }
        }

        $this->errorCache[$name] = sprintf('Unable to find template "%s" (looked into: %s).', $name, implode(', ', $this->paths[$namespace]));

        if (!$throw) {
            return false;
        }

        throw new Twig_Error_Loader($this->errorCache[$name]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCacheKey()

Twig_Loader_Filesystem::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 148 of file Filesystem.php.

References $name, $path, and findTemplate().

    {
        $path = $this->findTemplate($name);
        $len = strlen($this->rootPath);
        if (0 === strncmp($this->rootPath, $path, $len)) {
            return substr($path, $len);
        }

        return $path;
    }

Here is the call graph for this function:

getNamespaces()

Twig_Loader_Filesystem::getNamespaces

(

)

Returns the path namespaces.

The main namespace is always defined.

Returns

array The array of defined namespaces

Definition at line 63 of file Filesystem.php.

    {
        return array_keys($this->paths);
    }

getPaths()

Twig_Loader_Filesystem::getPaths

(

$namespace = self::MAIN_NAMESPACE

)

Returns the paths to the templates.

Parameters

string

$namespace

A path namespace

Returns

array The array of paths where to look for templates

Definition at line 51 of file Filesystem.php.

References $namespace.

    {
        return isset($this->paths[$namespace]) ? $this->paths[$namespace] : array();
    }

getSource()

Twig_Loader_Filesystem::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 134 of file Filesystem.php.

References $name, and findTemplate().

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

        return file_get_contents($this->findTemplate($name));
    }

Here is the call graph for this function:

getSourceContext()

Twig_Loader_Filesystem::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 141 of file Filesystem.php.

References $name, $path, and findTemplate().

    {
        $path = $this->findTemplate($name);

        return new Twig_Source(file_get_contents($path), $name, $path);
    }

Here is the call graph for this function:

isAbsolutePath()

Twig_Loader_Filesystem::isAbsolutePath (   $file )

private

Definition at line 278 of file Filesystem.php.

Referenced by addPath(), findTemplate(), and prependPath().

    {
        return strspn($file, '/\\', 0, 1)
            || (strlen($file) > 3 && ctype_alpha($file[0])
                && ':' === substr($file, 1, 1)
                && strspn($file, '/\\', 2, 1)
            )
            || null !== parse_url($file, PHP_URL_SCHEME)
        ;
    }

Here is the caller graph for this function:

isFresh()

Twig_Loader_Filesystem::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 176 of file Filesystem.php.

References $name, $time, and findTemplate().

    {
        return filemtime($this->findTemplate($name)) <= $time;
    }

Here is the call graph for this function:

normalizeName()

Twig_Loader_Filesystem::normalizeName (   $name )

protected

Definition at line 251 of file Filesystem.php.

References $name.

Referenced by exists(), and findTemplate().

    {
        return preg_replace('#/{2,}#', '/', str_replace('\\', '/', (string) $name));
    }

Here is the caller graph for this function:

parseName()

Twig_Loader_Filesystem::parseName (   $name,   $default = self::MAIN_NAMESPACE  )

protected

Definition at line 235 of file Filesystem.php.

References $default, $name, and $namespace.

Referenced by findTemplate().

    {
        if (isset($name[0]) && '@' == $name[0]) {
            if (false === $pos = strpos($name, '/')) {
                throw new Twig_Error_Loader(sprintf('Malformed namespaced template name "%s" (expecting "@namespace/template_name").', $name));
            }

            $namespace = substr($name, 1, $pos - 1);
            $shortname = substr($name, $pos + 1);

            return array($namespace, $shortname);
        }

        return array($default, $name);
    }

Here is the caller graph for this function:

prependPath()

Twig_Loader_Filesystem::prependPath	(		$path,
			$namespace = self::MAIN_NAMESPACE
	)

Prepends a path where templates are stored.

Parameters

string	$path	A path where to look for templates
string	$namespace	A path namespace

Exceptions

Twig_Error_Loader

Definition at line 115 of file Filesystem.php.

References $namespace, $path, and isAbsolutePath().

    {
        // invalidate the cache
        $this->cache = $this->errorCache = array();

        $checkPath = $this->isAbsolutePath($path) ? $path : $this->rootPath.$path;
        if (!is_dir($checkPath)) {
            throw new Twig_Error_Loader(sprintf('The "%s" directory does not exist ("%s").', $path, $checkPath));
        }

        $path = rtrim($path, '/\\');

        if (!isset($this->paths[$namespace])) {
            $this->paths[$namespace][] = $path;
        } else {
            array_unshift($this->paths[$namespace], $path);
        }
    }

Here is the call graph for this function:

setPaths()

Twig_Loader_Filesystem::setPaths	(		$paths,
			$namespace = self::MAIN_NAMESPACE
	)

Sets the paths where templates are stored.

Parameters

string | array	$paths	A path or an array of paths where to look for templates
string	$namespace	A path namespace

Definition at line 74 of file Filesystem.php.

References $namespace, $path, $paths, and addPath().

Referenced by __construct().

    {
        if (!is_array($paths)) {
            $paths = array($paths);
        }

        $this->paths[$namespace] = array();
        foreach ($paths as $path) {
            $this->addPath($path, $namespace);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validateName()

Twig_Loader_Filesystem::validateName (   $name )

protected

Definition at line 256 of file Filesystem.php.

References $name.

Referenced by findTemplate().

    {
        if (false !== strpos($name, "\0")) {
            throw new Twig_Error_Loader('A template name cannot contain NUL bytes.');
        }

        $name = ltrim($name, '/');
        $parts = explode('/', $name);
        $level = 0;
        foreach ($parts as $part) {
            if ('..' === $part) {
                --$level;
            } elseif ('.' !== $part) {
                ++$level;
            }

            if ($level < 0) {
                throw new Twig_Error_Loader(sprintf('Looks like you try to load a template outside configured directories (%s).', $name));
            }
        }
    }

Here is the caller graph for this function:

Field Documentation

$cache

Twig_Loader_Filesystem::$cache = array()

protected

Definition at line 23 of file Filesystem.php.

$errorCache

Twig_Loader_Filesystem::$errorCache = array()

protected

Definition at line 24 of file Filesystem.php.

$paths

Twig_Loader_Filesystem::$paths = array()

protected

Definition at line 22 of file Filesystem.php.

Referenced by __construct(), and setPaths().

$rootPath

Twig_Loader_Filesystem::$rootPath

private

Definition at line 26 of file Filesystem.php.

Referenced by __construct().

MAIN_NAMESPACE

const Twig_Loader_Filesystem::MAIN_NAMESPACE = '__main__'

Identifier of the main namespace.

Definition at line 20 of file Filesystem.php.

Referenced by SimpleSAML_XHTML_Template\findThemeTemplateDirs(), SimpleSAML_XHTML_Template\setupTwigTemplatepaths(), and Twig_Tests_Loader_FilesystemTest\testGetNamespaces().

---

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

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