Source for file File.php

Documentation is available at File.php

  1. <?php
  2.  
  3. /**
  4.  * represents a Dwoo template contained in a file
  5.  *
  6.  * This software is provided 'as-is', without any express or implied warranty.
  7.  * In no event will the authors be held liable for any damages arising from the use of this software.
  8.  *
  9.  * This file is released under the LGPL
  10.  * "GNU Lesser General Public License"
  11.  * More information can be found here:
  12.  * {@link http://www.gnu.org/copyleft/lesser.html}
  13.  *
  14.  * @author     Jordi Boggiano <j.boggiano@seld.be>
  15.  * @copyright  Copyright (c) 2008, Jordi Boggiano
  16.  * @license    http://www.gnu.org/copyleft/lesser.html  GNU Lesser General Public License
  17.  * @link       http://dwoo.org/
  18.  * @version    0.9.1
  19.  * @date       2008-05-30
  20.  * @package    Dwoo
  21.  */
  22. class Dwoo_Template_File extends Dwoo_Template_String
  23. {
  24.     /**
  25.      * template filename
  26.      *
  27.      * @var string 
  28.      */
  29.     protected $file;
  30.  
  31.     /**
  32.      * creates a template from a file
  33.      *
  34.      * @param string $file the path to the template file, make sure it exists
  35.      * @param int $cacheTime duration of the cache validity for this template,
  36.      *                           if null it defaults to the Dwoo instance that will
  37.      *                           render this template
  38.      * @param string $cacheId the unique cache identifier of this page or anything else that
  39.      *                            makes this template's content unique, if null it defaults
  40.      *                            to the current url
  41.      * @param string $compileId the unique compiled identifier, which is used to distinguish this
  42.      *                              template from others, if null it defaults to the filename+bits of the path
  43.      */
  44.     public function __construct($file, $cacheTime = null, $cacheId = null, $compileId = null)
  45.     {
  46.         $this->file = $file;
  47.         $this->name = basename($file);
  48.         $this->cacheTime = $cacheTime;
  49.  
  50.         if ($compileId !== null) {
  51.             $this->compileId = strtr($compileId, '\\%?=!:;'.PATH_SEPARATOR, '/-------');
  52.         }
  53.  
  54.         if ($cacheId !== null) {
  55.             $this->cacheId = strtr($cacheId, '\\%?=!:;'.PATH_SEPARATOR, '/-------');
  56.         }
  57.     }
  58.  
  59.     /**
  60.      * returns the compiled template file name
  61.      *
  62.      * @param Dwoo $dwoo the dwoo instance that requests it
  63.      * @param Dwoo_ICompiler $compiler the compiler that must be used
  64.      * @return string 
  65.      */
  66.     public function getCompiledTemplate(Dwoo $dwoo, Dwoo_ICompiler $compiler = null)
  67.     {
  68.         $compiledFile = $this->getCompiledFilename($dwoo);
  69.  
  70.         if ($this->compilationEnforced !== true && isset(self::$cache['compiled'][$this->compileId]) === true) {
  71.             // already checked, return compiled file
  72.         } elseif ($this->compilationEnforced !== true && file_exists($compiledFile)===true && (int)$this->getUid() <= filemtime($compiledFile)) {
  73.             // template is compiled and has not been modified since the compilation
  74.             self::$cache['compiled'][$this->compileId] = true;
  75.         } else {
  76.             // compiles the template
  77.             $this->compilationEnforced = false;
  78.  
  79.             if ($compiler === null) {
  80.                 $compiler = $dwoo->getDefaultCompilerFactory('string');
  81.  
  82.                 if ($compiler === null || $compiler === array('Dwoo_Compiler', 'compilerFactory')) {
  83.                     if (class_exists('Dwoo_Compiler', false) === false) {
  84.                         include 'Dwoo/Compiler.php';
  85.                     }
  86.                     $compiler = Dwoo_Compiler::compilerFactory();
  87.                 } else {
  88.                     $compiler = call_user_func($compiler);
  89.                 }
  90.             }
  91.  
  92.             $this->compiler = $compiler;
  93.  
  94.             $compiler->setCustomPlugins($dwoo->getCustomPlugins());
  95.             $compiler->setSecurityPolicy($dwoo->getSecurityPolicy());
  96.             $this->makeDirectory(dirname($compiledFile));
  97.             file_put_contents($compiledFile, $compiler->compile($dwoo, $this));
  98.             chmod($compiledFile, DWOO_CHMOD);
  99.  
  100.             self::$cache['compiled'][$this->compileId] = true;
  101.         }
  102.  
  103.         return $compiledFile;
  104.     }
  105.  
  106.     /**
  107.      * returns the template source of this template
  108.      *
  109.      * @return string 
  110.      */
  111.     public function getSource()
  112.     {
  113.         return file_get_contents($this->file);
  114.     }
  115.  
  116.     /**
  117.      * returns the resource name for this template class
  118.      *
  119.      * @return string 
  120.      */
  121.     public function getResourceName()
  122.     {
  123.         return 'file';
  124.     }
  125.  
  126.     /**
  127.      * returns this template's source filename
  128.      *
  129.      * @return string 
  130.      */
  131.     public function getResourceIdentifier()
  132.     {
  133.         return $this->file;
  134.     }
  135.  
  136.     /**
  137.      * returns an unique value identifying the current version of this template,
  138.      * in this case it's the unix timestamp of the last modification
  139.      *
  140.      * @return string 
  141.      */
  142.     public function getUid()
  143.     {
  144.         return (string) filemtime($this->file);
  145.     }
  146.  
  147.     /**
  148.      * returns a new template object from the given include name, null if no include is
  149.      * possible (resource not found), or false if include is not permitted by this resource type
  150.      *
  151.      * @param Dwoo $dwoo the dwoo instance requiring it
  152.      * @param mixed $resourceId the filename (relative to this template's dir) of the template to include
  153.      * @param int $cacheTime duration of the cache validity for this template,
  154.      *                           if null it defaults to the Dwoo instance that will
  155.      *                           render this template
  156.      * @param string $cacheId the unique cache identifier of this page or anything else that
  157.      *                            makes this template's content unique, if null it defaults
  158.      *                            to the current url
  159.      * @param string $compileId the unique compiled identifier, which is used to distinguish this
  160.      *                              template from others, if null it defaults to the filename+bits of the path
  161.      * @return Dwoo_Template_File|null
  162.      */
  163.     public static function templateFactory(Dwoo $dwoo, $resourceId, $cacheTime = null, $cacheId = null, $compileId = null)
  164.     {
  165.         $resourceId = str_replace(array("\t", "\n", "\r"), array('\\t', '\\n', '\\r'), $resourceId);
  166.         if (file_exists($resourceId) === false) {
  167.             $tpl = $dwoo->getTemplate();
  168.             if ($tpl instanceof Dwoo_Template_File) {
  169.                 $resourceId = dirname($tpl->getResourceIdentifier()).DIRECTORY_SEPARATOR.$resourceId;
  170.                 if (file_exists($resourceId) === false) {
  171.                     return null;
  172.                 }
  173.             } else {
  174.                 return null;
  175.             }
  176.         }
  177.  
  178.         // prevent template recursion if security is in effect
  179.         if ($policy = $dwoo->getSecurityPolicy()) {
  180.             $tpl = $dwoo->getTemplate();
  181.             if ($tpl instanceof Dwoo_Template_File && $resourceId === $tpl->getResourceIdentifier()) {
  182.                 return $dwoo->triggerError('You can not include a template into itself', E_USER_WARNING);
  183.             }
  184.         }
  185.  
  186.         return new Dwoo_Template_File($resourceId, $cacheTime, $cacheId, $compileId);
  187.     }
  188.  
  189.     /**
  190.      * returns the full compiled file name and assigns a default value to it if
  191.      * required
  192.      *
  193.      * @param Dwoo $dwoo the dwoo instance that requests the file name
  194.      * @return string the full path to the compiled file
  195.      */
  196.     protected function getCompiledFilename(Dwoo $dwoo)
  197.     {
  198.         // no compile id was provided, set default
  199.         if ($this->compileId===null) {
  200.             $this->compileId = implode('/', array_slice(explode('/', strtr($this->file, '\\', '/')), -3));
  201.         }
  202.         return $dwoo->getCompileDir() . $this->compileId.'.d'.Dwoo::RELEASE_TAG.'.php';
  203.     }
  204. }

Documentation generated on Sat, 28 Jun 2008 01:38:23 +0200 by phpDocumentor 1.4.0