diff options
| author | Michael Save <savetheinternet@tinyboard.org> | 2012-04-09 20:52:26 +1000 |
|---|---|---|
| committer | Michael Save <savetheinternet@tinyboard.org> | 2012-04-09 20:52:26 +1000 |
| commit | 874b8cbf002e9d8bf0ff39671e1501165016320a (patch) | |
| tree | 1428acec23fef6c607e10fd355d88af31c2029ed /inc/lib/Twig/Loader | |
| parent | 69c9a9dd452299e0e8f7335966a1d0b4036df583 (diff) | |
inc/contrib -> inc/lib
Diffstat (limited to 'inc/lib/Twig/Loader')
| -rw-r--r-- | inc/lib/Twig/Loader/Array.php | 95 | ||||
| -rw-r--r-- | inc/lib/Twig/Loader/Chain.php | 100 | ||||
| -rw-r--r-- | inc/lib/Twig/Loader/Filesystem.php | 152 | ||||
| -rw-r--r-- | inc/lib/Twig/Loader/String.php | 59 |
4 files changed, 406 insertions, 0 deletions
diff --git a/inc/lib/Twig/Loader/Array.php b/inc/lib/Twig/Loader/Array.php new file mode 100644 index 00000000..e8dc1605 --- /dev/null +++ b/inc/lib/Twig/Loader/Array.php @@ -0,0 +1,95 @@ +<?php + +/* + * This file is part of Twig. + * + * (c) 2009 Fabien Potencier + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/** + * 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. + * + * @package twig + * @author Fabien Potencier <fabien@symfony.com> + */ +class Twig_Loader_Array implements Twig_LoaderInterface +{ + protected $templates; + + /** + * Constructor. + * + * @param array $templates An array of templates (keys are the names, and values are the source code) + * + * @see Twig_Loader + */ + public function __construct(array $templates) + { + $this->templates = array(); + foreach ($templates as $name => $template) { + $this->templates[$name] = $template; + } + } + + /** + * Adds or overrides a template. + * + * @param string $name The template name + * @param string $template The template source + */ + public function setTemplate($name, $template) + { + $this->templates[$name] = $template; + } + + /** + * Gets the source code of a template, given its name. + * + * @param string $name The name of the template to load + * + * @return string The template source code + */ + public function getSource($name) + { + if (!isset($this->templates[$name])) { + throw new Twig_Error_Loader(sprintf('Template "%s" is not defined.', $name)); + } + + return $this->templates[$name]; + } + + /** + * Gets the cache key to use for the cache for a given template name. + * + * @param string $name The name of the template to load + * + * @return string The cache key + */ + public function getCacheKey($name) + { + if (!isset($this->templates[$name])) { + throw new Twig_Error_Loader(sprintf('Template "%s" is not defined.', $name)); + } + + return $this->templates[$name]; + } + + /** + * Returns true if the template is still fresh. + * + * @param string $name The template name + * @param timestamp $time The last modification time of the cached template + */ + public function isFresh($name, $time) + { + return true; + } +} diff --git a/inc/lib/Twig/Loader/Chain.php b/inc/lib/Twig/Loader/Chain.php new file mode 100644 index 00000000..48dd8b84 --- /dev/null +++ b/inc/lib/Twig/Loader/Chain.php @@ -0,0 +1,100 @@ +<?php + +/* + * This file is part of Twig. + * + * (c) 2011 Fabien Potencier + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/** + * Loads templates from other loaders. + * + * @package twig + * @author Fabien Potencier <fabien@symfony.com> + */ +class Twig_Loader_Chain implements Twig_LoaderInterface +{ + protected $loaders; + + /** + * Constructor. + * + * @param Twig_LoaderInterface[] $loaders An array of loader instances + */ + public function __construct(array $loaders = array()) + { + $this->loaders = array(); + foreach ($loaders as $loader) { + $this->addLoader($loader); + } + } + + /** + * Adds a loader instance. + * + * @param Twig_LoaderInterface $loader A Loader instance + */ + public function addLoader(Twig_LoaderInterface $loader) + { + $this->loaders[] = $loader; + } + + /** + * Gets the source code of a template, given its name. + * + * @param string $name The name of the template to load + * + * @return string The template source code + */ + public function getSource($name) + { + foreach ($this->loaders as $loader) { + try { + return $loader->getSource($name); + } catch (Twig_Error_Loader $e) { + } + } + + throw new Twig_Error_Loader(sprintf('Template "%s" is not defined.', $name)); + } + + /** + * Gets the cache key to use for the cache for a given template name. + * + * @param string $name The name of the template to load + * + * @return string The cache key + */ + public function getCacheKey($name) + { + foreach ($this->loaders as $loader) { + try { + return $loader->getCacheKey($name); + } catch (Twig_Error_Loader $e) { + } + } + + throw new Twig_Error_Loader(sprintf('Template "%s" is not defined.', $name)); + } + + /** + * Returns true if the template is still fresh. + * + * @param string $name The template name + * @param timestamp $time The last modification time of the cached template + */ + public function isFresh($name, $time) + { + foreach ($this->loaders as $loader) { + try { + return $loader->isFresh($name, $time); + } catch (Twig_Error_Loader $e) { + } + } + + throw new Twig_Error_Loader(sprintf('Template "%s" is not defined.', $name)); + } +} diff --git a/inc/lib/Twig/Loader/Filesystem.php b/inc/lib/Twig/Loader/Filesystem.php new file mode 100644 index 00000000..be348aa3 --- /dev/null +++ b/inc/lib/Twig/Loader/Filesystem.php @@ -0,0 +1,152 @@ +<?php + +/* + * This file is part of Twig. + * + * (c) 2009 Fabien Potencier + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/** + * Loads template from the filesystem. + * + * @package twig + * @author Fabien Potencier <fabien@symfony.com> + */ +class Twig_Loader_Filesystem implements Twig_LoaderInterface +{ + protected $paths; + protected $cache; + + /** + * Constructor. + * + * @param string|array $paths A path or an array of paths where to look for templates + */ + public function __construct($paths) + { + $this->setPaths($paths); + } + + /** + * Returns the paths to the templates. + * + * @return array The array of paths where to look for templates + */ + public function getPaths() + { + return $this->paths; + } + + /** + * Sets the paths where templates are stored. + * + * @param string|array $paths A path or an array of paths where to look for templates + */ + public function setPaths($paths) + { + if (!is_array($paths)) { + $paths = array($paths); + } + + $this->paths = array(); + foreach ($paths as $path) { + $this->addPath($path); + } + } + + /** + * Adds a path where templates are stored. + * + * @param string $path A path where to look for templates + */ + public function addPath($path) + { + // invalidate the cache + $this->cache = array(); + + if (!is_dir($path)) { + throw new Twig_Error_Loader(sprintf('The "%s" directory does not exist.', $path)); + } + + $this->paths[] = $path; + } + + /** + * Gets the source code of a template, given its name. + * + * @param string $name The name of the template to load + * + * @return string The template source code + */ + public function getSource($name) + { + return file_get_contents($this->findTemplate($name)); + } + + /** + * Gets the cache key to use for the cache for a given template name. + * + * @param string $name The name of the template to load + * + * @return string The cache key + */ + public function getCacheKey($name) + { + return $this->findTemplate($name); + } + + /** + * Returns true if the template is still fresh. + * + * @param string $name The template name + * @param timestamp $time The last modification time of the cached template + */ + public function isFresh($name, $time) + { + return filemtime($this->findTemplate($name)) < $time; + } + + protected function findTemplate($name) + { + // normalize name + $name = preg_replace('#/{2,}#', '/', strtr($name, '\\', '/')); + + if (isset($this->cache[$name])) { + return $this->cache[$name]; + } + + $this->validateName($name); + + foreach ($this->paths as $path) { + if (is_file($path.'/'.$name)) { + return $this->cache[$name] = $path.'/'.$name; + } + } + + throw new Twig_Error_Loader(sprintf('Unable to find template "%s" (looked into: %s).', $name, implode(', ', $this->paths))); + } + + protected function validateName($name) + { + if (false !== strpos($name, "\0")) { + throw new Twig_Error_Loader('A template name cannot contain NUL bytes.'); + } + + $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)); + } + } + } +} diff --git a/inc/lib/Twig/Loader/String.php b/inc/lib/Twig/Loader/String.php new file mode 100644 index 00000000..26eb0096 --- /dev/null +++ b/inc/lib/Twig/Loader/String.php @@ -0,0 +1,59 @@ +<?php + +/* + * This file is part of Twig. + * + * (c) 2009 Fabien Potencier + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/** + * Loads a template from a string. + * + * 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. + * + * @package twig + * @author Fabien Potencier <fabien@symfony.com> + */ +class Twig_Loader_String implements Twig_LoaderInterface +{ + /** + * Gets the source code of a template, given its name. + * + * @param string $name The name of the template to load + * + * @return string The template source code + */ + public function getSource($name) + { + return $name; + } + + /** + * Gets the cache key to use for the cache for a given template name. + * + * @param string $name The name of the template to load + * + * @return string The cache key + */ + public function getCacheKey($name) + { + return $name; + } + + /** + * Returns true if the template is still fresh. + * + * @param string $name The template name + * @param timestamp $time The last modification time of the cached template + */ + public function isFresh($name, $time) + { + return true; + } +} |
