class Twig_Loader_Filesystem in Zircon Profile 8

Loads template from the filesystem.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Twig_Loader_Filesystem implements Twig_ExistsLoaderInterface, Twig_LoaderInterface

File

vendor/twig/twig/lib/Twig/Loader/Filesystem.php, line 17

class Twig_Loader_Filesystem implements Twig_LoaderInterface, Twig_ExistsLoaderInterface {

  /** Identifier of the main namespace. */
  const MAIN_NAMESPACE = '__main__';
  protected $paths = array();
  protected $cache = array();
  protected $errorCache = array();

  /**
   * Constructor.
   *
   * @param string|array $paths A path or an array of paths where to look for templates
   */
  public function __construct($paths = array()) {
    if ($paths) {
      $this
        ->setPaths($paths);
    }
  }

  /**
   * Returns the paths to the templates.
   *
   * @param string $namespace A path namespace
   *
   * @return array The array of paths where to look for templates
   */
  public function getPaths($namespace = self::MAIN_NAMESPACE) {
    return isset($this->paths[$namespace]) ? $this->paths[$namespace] : array();
  }

  /**
   * Returns the path namespaces.
   *
   * The main namespace is always defined.
   *
   * @return array The array of defined namespaces
   */
  public function getNamespaces() {
    return array_keys($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
   * @param string       $namespace A path namespace
   */
  public function setPaths($paths, $namespace = self::MAIN_NAMESPACE) {
    if (!is_array($paths)) {
      $paths = array(
        $paths,
      );
    }
    $this->paths[$namespace] = array();
    foreach ($paths as $path) {
      $this
        ->addPath($path, $namespace);
    }
  }

  /**
   * Adds a path where templates are stored.
   *
   * @param string $path      A path where to look for templates
   * @param string $namespace A path name
   *
   * @throws Twig_Error_Loader
   */
  public function addPath($path, $namespace = self::MAIN_NAMESPACE) {

    // invalidate the cache
    $this->cache = $this->errorCache = array();
    if (!is_dir($path)) {
      throw new Twig_Error_Loader(sprintf('The "%s" directory does not exist.', $path));
    }
    $this->paths[$namespace][] = rtrim($path, '/\\');
  }

  /**
   * Prepends a path where templates are stored.
   *
   * @param string $path      A path where to look for templates
   * @param string $namespace A path name
   *
   * @throws Twig_Error_Loader
   */
  public function prependPath($path, $namespace = self::MAIN_NAMESPACE) {

    // invalidate the cache
    $this->cache = $this->errorCache = array();
    if (!is_dir($path)) {
      throw new Twig_Error_Loader(sprintf('The "%s" directory does not exist.', $path));
    }
    $path = rtrim($path, '/\\');
    if (!isset($this->paths[$namespace])) {
      $this->paths[$namespace][] = $path;
    }
    else {
      array_unshift($this->paths[$namespace], $path);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getSource($name) {
    return file_get_contents($this
      ->findTemplate($name));
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheKey($name) {
    return $this
      ->findTemplate($name);
  }

  /**
   * {@inheritdoc}
   */
  public function exists($name) {
    $name = $this
      ->normalizeName($name);
    if (isset($this->cache[$name])) {
      return true;
    }
    try {
      return false !== $this
        ->findTemplate($name, false);
    } catch (Twig_Error_Loader $exception) {
      return false;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function isFresh($name, $time) {
    return filemtime($this
      ->findTemplate($name)) <= $time;
  }
  protected function findTemplate($name) {
    $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 (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]);
  }
  protected function parseName($name, $default = self::MAIN_NAMESPACE) {
    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,
    );
  }
  protected function normalizeName($name) {
    return preg_replace('#/{2,}#', '/', str_replace('\\', '/', (string) $name));
  }
  protected function validateName($name) {
    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));
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Twig_Loader_Filesystem::$cache	protected	property
Twig_Loader_Filesystem::$errorCache	protected	property
Twig_Loader_Filesystem::$paths	protected	property
Twig_Loader_Filesystem::addPath	public	function	Adds a path where templates are stored.
Twig_Loader_Filesystem::exists	public	function	Check if we have the source code of a template, given its name. Overrides Twig_ExistsLoaderInterface::exists
Twig_Loader_Filesystem::findTemplate	protected	function
Twig_Loader_Filesystem::getCacheKey	public	function	Gets the cache key to use for the cache for a given template name. Overrides Twig_LoaderInterface::getCacheKey
Twig_Loader_Filesystem::getNamespaces	public	function	Returns the path namespaces.
Twig_Loader_Filesystem::getPaths	public	function	Returns the paths to the templates.
Twig_Loader_Filesystem::getSource	public	function	Gets the source code of a template, given its name. Overrides Twig_LoaderInterface::getSource
Twig_Loader_Filesystem::isFresh	public	function	Returns true if the template is still fresh. Overrides Twig_LoaderInterface::isFresh
Twig_Loader_Filesystem::MAIN_NAMESPACE		constant	Identifier of the main namespace.
Twig_Loader_Filesystem::normalizeName	protected	function
Twig_Loader_Filesystem::parseName	protected	function
Twig_Loader_Filesystem::prependPath	public	function	Prepends a path where templates are stored.
Twig_Loader_Filesystem::setPaths	public	function	Sets the paths where templates are stored.
Twig_Loader_Filesystem::validateName	protected	function
Twig_Loader_Filesystem::__construct	public	function	Constructor.