LoaderInterface.php

<?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.
 */

/**
 * Interface all loaders must implement.
 *
 * @package    twig
 * @author     Fabien Potencier <fabien@symfony.com>
 */
interface 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
   *
   * @throws Twig_Error_Loader When $name is not found
   */
  function getSource($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
   *
   * @throws Twig_Error_Loader When $name is not found
   */
  function getCacheKey($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
   *
   * @return Boolean true if the template is fresh, false otherwise
   *
   * @throws Twig_Error_Loader When $name is not found
   */
  function isFresh($name, $time);

}