dwoo-project / dwoo

lib/Dwoo/ICompiler.php

Doc Comments +3 added lines, -1 removed lines

@@ -27,7 +27,7 @@ 
     /**
      * compiles the provided string down to php code.
      *
-     * @param string $templateStr the template to compile
+     * @param string $template the template to compile
      *
      * @return string a compiled php code string
      */
@@ -39,6 +39,7 @@ 
      * @see Dwoo_Core::addPlugin
      *
      * @param array $customPlugins an array of custom plugins
+     * @return void
      */
     public function setCustomPlugins(array $customPlugins);
 
@@ -49,6 +50,7 @@ 
      * set it on the Dwoo object as it will be passed onto the compiler automatically
      *
      * @param Dwoo_Security_Policy $policy the security policy object
+     * @return void
      */
     public function setSecurityPolicy(Dwoo_Security_Policy $policy = null);
 }

Indentation +25 added lines, -25 removed lines

@@ -24,31 +24,31 @@
  */
 interface Dwoo_ICompiler
 {
-    /**
-     * compiles the provided string down to php code.
-     *
-     * @param string $templateStr the template to compile
-     *
-     * @return string a compiled php code string
-     */
-    public function compile(Dwoo_Core $dwoo, Dwoo_ITemplate $template);
+	/**
+	 * compiles the provided string down to php code.
+	 *
+	 * @param string $templateStr the template to compile
+	 *
+	 * @return string a compiled php code string
+	 */
+	public function compile(Dwoo_Core $dwoo, Dwoo_ITemplate $template);
 
-    /**
-     * adds the custom plugins loaded into Dwoo to the compiler so it can load them.
-     *
-     * @see Dwoo_Core::addPlugin
-     *
-     * @param array $customPlugins an array of custom plugins
-     */
-    public function setCustomPlugins(array $customPlugins);
+	/**
+	 * adds the custom plugins loaded into Dwoo to the compiler so it can load them.
+	 *
+	 * @see Dwoo_Core::addPlugin
+	 *
+	 * @param array $customPlugins an array of custom plugins
+	 */
+	public function setCustomPlugins(array $customPlugins);
 
-    /**
-     * sets the security policy object to enforce some php security settings.
-     *
-     * use this if untrusted persons can modify templates,
-     * set it on the Dwoo object as it will be passed onto the compiler automatically
-     *
-     * @param Dwoo_Security_Policy $policy the security policy object
-     */
-    public function setSecurityPolicy(Dwoo_Security_Policy $policy = null);
+	/**
+	 * sets the security policy object to enforce some php security settings.
+	 *
+	 * use this if untrusted persons can modify templates,
+	 * set it on the Dwoo object as it will be passed onto the compiler automatically
+	 *
+	 * @param Dwoo_Security_Policy $policy the security policy object
+	 */
+	public function setSecurityPolicy(Dwoo_Security_Policy $policy = null);
 }

lib/Dwoo/Loader.php

Doc Comments +3 added lines

@@ -47,6 +47,9 @@
 
     protected $corePluginDir;
 
+    /**
+     * @param string $cacheDir
+     */
     public function __construct($cacheDir)
     {
         $this->corePluginDir = DWOO_DIRECTORY.'plugins';

Indentation +129 added lines, -129 removed lines

@@ -19,143 +19,143 @@
  */
 class Dwoo_Loader implements Dwoo_ILoader
 {
-    /**
-     * stores the plugin directories.
-     *
-     * @see addDirectory
-     *
-     * @var array
-     */
-    protected $paths = array();
+	/**
+	 * stores the plugin directories.
+	 *
+	 * @see addDirectory
+	 *
+	 * @var array
+	 */
+	protected $paths = array();
 
-    /**
-     * stores the plugins names/paths relationships
-     * don't edit this on your own, use addDirectory.
-     *
-     * @see addDirectory
-     *
-     * @var array
-     */
-    protected $classPath = array();
+	/**
+	 * stores the plugins names/paths relationships
+	 * don't edit this on your own, use addDirectory.
+	 *
+	 * @see addDirectory
+	 *
+	 * @var array
+	 */
+	protected $classPath = array();
 
-    /**
-     * path where class paths cache files are written.
-     *
-     * @var string
-     */
-    protected $cacheDir;
+	/**
+	 * path where class paths cache files are written.
+	 *
+	 * @var string
+	 */
+	protected $cacheDir;
 
-    protected $corePluginDir;
+	protected $corePluginDir;
 
-    public function __construct($cacheDir)
-    {
-        $this->corePluginDir = DWOO_DIRECTORY.'plugins';
-        $this->cacheDir = rtrim($cacheDir, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
+	public function __construct($cacheDir)
+	{
+		$this->corePluginDir = DWOO_DIRECTORY.'plugins';
+		$this->cacheDir = rtrim($cacheDir, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
 
-        // include class paths or rebuild paths if the cache file isn't there
-        $cacheFile = $this->cacheDir.'classpath.cache.d'.Dwoo_Core::RELEASE_TAG.'.php';
-        if (file_exists($cacheFile)) {
-            $classpath = file_get_contents($cacheFile);
-            $this->classPath = unserialize($classpath) + $this->classPath;
-        } else {
-            $this->rebuildClassPathCache($this->corePluginDir, $cacheFile);
-        }
-    }
+		// include class paths or rebuild paths if the cache file isn't there
+		$cacheFile = $this->cacheDir.'classpath.cache.d'.Dwoo_Core::RELEASE_TAG.'.php';
+		if (file_exists($cacheFile)) {
+			$classpath = file_get_contents($cacheFile);
+			$this->classPath = unserialize($classpath) + $this->classPath;
+		} else {
+			$this->rebuildClassPathCache($this->corePluginDir, $cacheFile);
+		}
+	}
 
-    /**
-     * rebuilds class paths, scans the given directory recursively and saves all paths in the given file.
-     *
-     * @param string $path      the plugin path to scan
-     * @param string $cacheFile the file where to store the plugin paths cache, it will be overwritten
-     *
-     * @throws Dwoo_Exception
-     */
-    protected function rebuildClassPathCache($path, $cacheFile)
-    {
-        if ($cacheFile !== false) {
-            $tmp = $this->classPath;
-            $this->classPath = array();
-        }
+	/**
+	 * rebuilds class paths, scans the given directory recursively and saves all paths in the given file.
+	 *
+	 * @param string $path      the plugin path to scan
+	 * @param string $cacheFile the file where to store the plugin paths cache, it will be overwritten
+	 *
+	 * @throws Dwoo_Exception
+	 */
+	protected function rebuildClassPathCache($path, $cacheFile)
+	{
+		if ($cacheFile !== false) {
+			$tmp = $this->classPath;
+			$this->classPath = array();
+		}
 
-        // iterates over all files/folders
-        $list = glob(rtrim($path, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.'*');
-        if (is_array($list)) {
-            foreach ($list as $f) {
-                if (is_dir($f)) {
-                    $this->rebuildClassPathCache($f, false);
-                } else {
-                    $this->classPath[str_replace(array('function.', 'block.', 'modifier.', 'outputfilter.', 'filter.', 'prefilter.', 'postfilter.', 'pre.', 'post.', 'output.', 'shared.', 'helper.'), '', basename($f, '.php'))] = $f;
-                }
-            }
-        }
+		// iterates over all files/folders
+		$list = glob(rtrim($path, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.'*');
+		if (is_array($list)) {
+			foreach ($list as $f) {
+				if (is_dir($f)) {
+					$this->rebuildClassPathCache($f, false);
+				} else {
+					$this->classPath[str_replace(array('function.', 'block.', 'modifier.', 'outputfilter.', 'filter.', 'prefilter.', 'postfilter.', 'pre.', 'post.', 'output.', 'shared.', 'helper.'), '', basename($f, '.php'))] = $f;
+				}
+			}
+		}
 
-        // save in file if it's the first call (not recursed)
-        if ($cacheFile !== false) {
-            if (!file_put_contents($cacheFile, serialize($this->classPath))) {
-                throw new Dwoo_Exception('Could not write into '.$cacheFile.', either because the folder is not there (create it) or because of the chmod configuration (please ensure this directory is writable by php), alternatively you can change the directory used with $dwoo->setCompileDir() or provide a custom loader object with $dwoo->setLoader()');
-            }
-            $this->classPath += $tmp;
-        }
-    }
+		// save in file if it's the first call (not recursed)
+		if ($cacheFile !== false) {
+			if (!file_put_contents($cacheFile, serialize($this->classPath))) {
+				throw new Dwoo_Exception('Could not write into '.$cacheFile.', either because the folder is not there (create it) or because of the chmod configuration (please ensure this directory is writable by php), alternatively you can change the directory used with $dwoo->setCompileDir() or provide a custom loader object with $dwoo->setLoader()');
+			}
+			$this->classPath += $tmp;
+		}
+	}
 
-    /**
-     * loads a plugin file.
-     *
-     * @param string $class       the plugin name, without the Dwoo_Plugin_ prefix
-     * @param bool   $forceRehash if true, the class path caches will be rebuilt if the plugin is not found, in case it has just been added, defaults to true
-     *
-     * @throws Dwoo_Exception
-     */
-    public function loadPlugin($class, $forceRehash = true)
-    {
-        // An unknown class was requested (maybe newly added) or the
-        // include failed so we rebuild the cache. include() will fail
-        // with an uncatchable error if the file doesn't exist, which
-        // usually means that the cache is stale and must be rebuilt,
-        // so we check for that before trying to include() the plugin.
-        if (!isset($this->classPath[$class]) ||
-            !is_readable($this->classPath[$class]) ||
-            !(include $this->classPath[$class])) {
-            if ($forceRehash) {
-                $this->rebuildClassPathCache($this->corePluginDir, $this->cacheDir.'classpath.cache.d'.Dwoo_Core::RELEASE_TAG.'.php');
-                foreach ($this->paths as $path => $file) {
-                    $this->rebuildClassPathCache($path, $file);
-                }
-                if (isset($this->classPath[$class])) {
-                    include $this->classPath[$class];
-                }
-                throw new Dwoo_Exception('Plugin <em>'.$class.'</em> can not be found, maybe you forgot to bind it if it\'s a custom plugin ?', E_USER_NOTICE);
-            }
-            throw new Dwoo_Exception('Plugin <em>'.$class.'</em> can not be found, maybe you forgot to bind it if it\'s a custom plugin ?', E_USER_NOTICE);
-        }
-    }
+	/**
+	 * loads a plugin file.
+	 *
+	 * @param string $class       the plugin name, without the Dwoo_Plugin_ prefix
+	 * @param bool   $forceRehash if true, the class path caches will be rebuilt if the plugin is not found, in case it has just been added, defaults to true
+	 *
+	 * @throws Dwoo_Exception
+	 */
+	public function loadPlugin($class, $forceRehash = true)
+	{
+		// An unknown class was requested (maybe newly added) or the
+		// include failed so we rebuild the cache. include() will fail
+		// with an uncatchable error if the file doesn't exist, which
+		// usually means that the cache is stale and must be rebuilt,
+		// so we check for that before trying to include() the plugin.
+		if (!isset($this->classPath[$class]) ||
+			!is_readable($this->classPath[$class]) ||
+			!(include $this->classPath[$class])) {
+			if ($forceRehash) {
+				$this->rebuildClassPathCache($this->corePluginDir, $this->cacheDir.'classpath.cache.d'.Dwoo_Core::RELEASE_TAG.'.php');
+				foreach ($this->paths as $path => $file) {
+					$this->rebuildClassPathCache($path, $file);
+				}
+				if (isset($this->classPath[$class])) {
+					include $this->classPath[$class];
+				}
+				throw new Dwoo_Exception('Plugin <em>'.$class.'</em> can not be found, maybe you forgot to bind it if it\'s a custom plugin ?', E_USER_NOTICE);
+			}
+			throw new Dwoo_Exception('Plugin <em>'.$class.'</em> can not be found, maybe you forgot to bind it if it\'s a custom plugin ?', E_USER_NOTICE);
+		}
+	}
 
-    /**
-     * adds a plugin directory, the plugins found in the new plugin directory
-     * will take precedence over the other directories (including the default
-     * dwoo plugin directory), you can use this for example to override plugins
-     * in a specific directory for a specific application while keeping all your
-     * usual plugins in the same place for all applications.
-     * TOCOM don't forget that php functions overrides are not rehashed so you
-     * need to clear the classpath caches by hand when adding those.
-     *
-     * @param string $pluginDirectory the plugin path to scan
-     *
-     * @throws Dwoo_Exception
-     */
-    public function addDirectory($pluginDirectory)
-    {
-        $pluginDir = realpath($pluginDirectory);
-        if (!$pluginDir) {
-            throw new Dwoo_Exception('Plugin directory does not exist or can not be read : '.$pluginDirectory);
-        }
-        $cacheFile = $this->cacheDir.'classpath-'.substr(strtr($pluginDir, '/\\:'.PATH_SEPARATOR, '----'), strlen($pluginDir) > 80 ? -80 : 0).'.d'.Dwoo_Core::RELEASE_TAG.'.php';
-        $this->paths[$pluginDir] = $cacheFile;
-        if (file_exists($cacheFile)) {
-            $classpath = file_get_contents($cacheFile);
-            $this->classPath = unserialize($classpath) + $this->classPath;
-        } else {
-            $this->rebuildClassPathCache($pluginDir, $cacheFile);
-        }
-    }
+	/**
+	 * adds a plugin directory, the plugins found in the new plugin directory
+	 * will take precedence over the other directories (including the default
+	 * dwoo plugin directory), you can use this for example to override plugins
+	 * in a specific directory for a specific application while keeping all your
+	 * usual plugins in the same place for all applications.
+	 * TOCOM don't forget that php functions overrides are not rehashed so you
+	 * need to clear the classpath caches by hand when adding those.
+	 *
+	 * @param string $pluginDirectory the plugin path to scan
+	 *
+	 * @throws Dwoo_Exception
+	 */
+	public function addDirectory($pluginDirectory)
+	{
+		$pluginDir = realpath($pluginDirectory);
+		if (!$pluginDir) {
+			throw new Dwoo_Exception('Plugin directory does not exist or can not be read : '.$pluginDirectory);
+		}
+		$cacheFile = $this->cacheDir.'classpath-'.substr(strtr($pluginDir, '/\\:'.PATH_SEPARATOR, '----'), strlen($pluginDir) > 80 ? -80 : 0).'.d'.Dwoo_Core::RELEASE_TAG.'.php';
+		$this->paths[$pluginDir] = $cacheFile;
+		if (file_exists($cacheFile)) {
+			$classpath = file_get_contents($cacheFile);
+			$this->classPath = unserialize($classpath) + $this->classPath;
+		} else {
+			$this->rebuildClassPathCache($pluginDir, $cacheFile);
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -56,7 +56,7 @@ 
         $cacheFile = $this->cacheDir.'classpath.cache.d'.Dwoo_Core::RELEASE_TAG.'.php';
         if (file_exists($cacheFile)) {
             $classpath = file_get_contents($cacheFile);
-            $this->classPath = unserialize($classpath) + $this->classPath;
+            $this->classPath = unserialize($classpath)+$this->classPath;
         } else {
             $this->rebuildClassPathCache($this->corePluginDir, $cacheFile);
         }
@@ -153,7 +153,7 @@ 
         $this->paths[$pluginDir] = $cacheFile;
         if (file_exists($cacheFile)) {
             $classpath = file_get_contents($cacheFile);
-            $this->classPath = unserialize($classpath) + $this->classPath;
+            $this->classPath = unserialize($classpath)+$this->classPath;
         } else {
             $this->rebuildClassPathCache($pluginDir, $cacheFile);
         }

lib/Dwoo/Template/String.php

Doc Comments +1 added lines, -1 removed lines

@@ -286,7 +286,7 @@
      * @param Dwoo_Core $dwoo   the dwoo instance that requests it
      * @param string    $output the template output
      *
-     * @return mixed full path of the cached file or false upon failure
+     * @return false|string full path of the cached file or false upon failure
      */
     public function cache(Dwoo_Core $dwoo, $output)
     {

Indentation +510 added lines, -510 removed lines

@@ -19,514 +19,514 @@
  */
 class Dwoo_Template_String implements Dwoo_ITemplate
 {
-    /**
-     * template name.
-     *
-     * @var string
-     */
-    protected $name;
-
-    /**
-     * template compilation id.
-     *
-     * @var string
-     */
-    protected $compileId;
-
-    /**
-     * template cache id, if not provided in the constructor, it is set to
-     * the md4 hash of the request_uri. it is however highly recommended to
-     * provide one that will fit your needs.
-     *
-     * in all cases, the compilation id is prepended to the cache id to separate
-     * templates with similar cache ids from one another
-     *
-     * @var string
-     */
-    protected $cacheId;
-
-    /**
-     * validity duration of the generated cache file (in seconds).
-     *
-     * set to -1 for infinite cache, 0 to disable and null to inherit the Dwoo instance's cache time
-     *
-     * @var int
-     */
-    protected $cacheTime;
-
-    /**
-     * boolean flag that defines whether the compilation should be enforced (once) or
-     * not use this if you have issues with the compiled templates not being updated
-     * but if you do need this it's most likely that you should file a bug report.
-     *
-     * @var bool
-     */
-    protected $compilationEnforced;
-
-    /**
-     * caches the results of the file checks to save some time when the same
-     * templates is rendered several times.
-     *
-     * @var array
-     */
-    protected static $cache = array('cached' => array(), 'compiled' => array());
-
-    /**
-     * holds the compiler that built this template.
-     *
-     * @var Dwoo_ICompiler
-     */
-    protected $compiler;
-
-    /**
-     * chmod value for all files written (cached or compiled ones).
-     *
-     * set to null if you don't want any chmod operation to happen
-     *
-     * @var int
-     */
-    protected $chmod = 0777;
-
-    protected $template;
-
-    /**
-     * creates a template from a string.
-     *
-     * @param string $templateString the template to use
-     * @param int    $cacheTime      duration of the cache validity for this template,
-     *                               if null it defaults to the Dwoo instance that will
-     *                               render this template, set to -1 for infinite cache or 0 to disable
-     * @param string $cacheId        the unique cache identifier of this page or anything else that
-     *                               makes this template's content unique, if null it defaults
-     *                               to the current url
-     * @param string $compileId      the unique compiled identifier, which is used to distinguish this
-     *                               template from others, if null it defaults to the md4 hash of the template
-     */
-    public function __construct($templateString, $cacheTime = null, $cacheId = null, $compileId = null)
-    {
-        $this->template = $templateString;
-        if (function_exists('hash')) {
-            $this->name = hash('md4', $templateString);
-        } else {
-            $this->name = md5($templateString);
-        }
-        $this->cacheTime = $cacheTime;
-
-        if ($compileId !== null) {
-            $this->compileId = str_replace('../', '__', strtr($compileId, '\\%?=!:;'.PATH_SEPARATOR, '/-------'));
-        }
-
-        if ($cacheId !== null) {
-            $this->cacheId = str_replace('../', '__', strtr($cacheId, '\\%?=!:;'.PATH_SEPARATOR, '/-------'));
-        }
-    }
-
-    /**
-     * returns the cache duration for this template.
-     *
-     * defaults to null if it was not provided
-     *
-     * @return int|null
-     */
-    public function getCacheTime()
-    {
-        return $this->cacheTime;
-    }
-
-    /**
-     * sets the cache duration for this template.
-     *
-     * can be used to set it after the object is created if you did not provide
-     * it in the constructor
-     *
-     * @param int $seconds duration of the cache validity for this template, if
-     *                     null it defaults to the Dwoo instance's cache time. 0 = disable and
-     *                     -1 = infinite cache
-     */
-    public function setCacheTime($seconds = null)
-    {
-        $this->cacheTime = $seconds;
-    }
-
-    /**
-     * returns the chmod value for all files written (cached or compiled ones).
-     *
-     * defaults to 0777
-     *
-     * @return int|null
-     */
-    public function getChmod()
-    {
-        return $this->chmod;
-    }
-
-    /**
-     * set the chmod value for all files written (cached or compiled ones).
-     *
-     * set to null if you don't want to do any chmod() operation
-     *
-     * @param int $mask new bitmask to use for all files
-     */
-    public function setChmod($mask = null)
-    {
-        $this->chmod = $mask;
-    }
-
-    /**
-     * returns the template name.
-     *
-     * @return string
-     */
-    public function getName()
-    {
-        return $this->name;
-    }
-
-    /**
-     * returns the resource name for this template class.
-     *
-     * @return string
-     */
-    public function getResourceName()
-    {
-        return 'string';
-    }
-
-    /**
-     * returns the resource identifier for this template, false here as strings don't have identifiers.
-     *
-     * @return false
-     */
-    public function getResourceIdentifier()
-    {
-        return false;
-    }
-
-    /**
-     * returns the template source of this template.
-     *
-     * @return string
-     */
-    public function getSource()
-    {
-        return $this->template;
-    }
-
-    /**
-     * returns an unique value identifying the current version of this template,
-     * in this case it's the md4 hash of the content.
-     *
-     * @return string
-     */
-    public function getUid()
-    {
-        return $this->name;
-    }
-
-    /**
-     * returns the compiler used by this template, if it was just compiled, or null.
-     *
-     * @return Dwoo_ICompiler
-     */
-    public function getCompiler()
-    {
-        return $this->compiler;
-    }
-
-    /**
-     * marks this template as compile-forced, which means it will be recompiled even if it
-     * was already saved and wasn't modified since the last compilation. do not use this in production,
-     * it's only meant to be used in development (and the development of dwoo particularly).
-     */
-    public function forceCompilation()
-    {
-        $this->compilationEnforced = true;
-    }
-
-    /**
-     * returns the cached template output file name, true if it's cache-able but not cached
-     * or false if it's not cached.
-     *
-     * @param Dwoo_Core $dwoo the dwoo instance that requests it
-     *
-     * @return string|bool
-     */
-    public function getCachedTemplate(Dwoo_Core $dwoo)
-    {
-        if ($this->cacheTime !== null) {
-            $cacheLength = $this->cacheTime;
-        } else {
-            $cacheLength = $dwoo->getCacheTime();
-        }
-
-        // file is not cacheable
-        if ($cacheLength == 0) {
-            return false;
-        }
-
-        $cachedFile = $this->getCacheFilename($dwoo);
-
-        if (isset(self::$cache['cached'][$this->cacheId]) === true && file_exists($cachedFile)) {
-            // already checked, return cache file
-            return $cachedFile;
-        } elseif ($this->compilationEnforced !== true && file_exists($cachedFile) && ($cacheLength === -1 || filemtime($cachedFile) > ($_SERVER['REQUEST_TIME'] - $cacheLength)) && $this->isValidCompiledFile($this->getCompiledFilename($dwoo))) {
-            // cache is still valid and can be loaded
-            self::$cache['cached'][$this->cacheId] = true;
-
-            return $cachedFile;
-        } else {
-            // file is cacheable
-            return true;
-        }
-    }
-
-    /**
-     * caches the provided output into the cache file.
-     *
-     * @param Dwoo_Core $dwoo   the dwoo instance that requests it
-     * @param string    $output the template output
-     *
-     * @return mixed full path of the cached file or false upon failure
-     */
-    public function cache(Dwoo_Core $dwoo, $output)
-    {
-        $cacheDir = $dwoo->getCacheDir();
-        $cachedFile = $this->getCacheFilename($dwoo);
-
-        // the code below is courtesy of Rasmus Schultz,
-        // thanks for his help on avoiding concurency issues
-        $temp = tempnam($cacheDir, 'temp');
-        if (!($file = @fopen($temp, 'wb'))) {
-            $temp = $cacheDir.uniqid('temp');
-            if (!($file = @fopen($temp, 'wb'))) {
-                trigger_error('Error writing temporary file \''.$temp.'\'', E_USER_WARNING);
-
-                return false;
-            }
-        }
-
-        fwrite($file, $output);
-        fclose($file);
-
-        $this->makeDirectory(dirname($cachedFile), $cacheDir);
-        if (!@rename($temp, $cachedFile)) {
-            @unlink($cachedFile);
-            @rename($temp, $cachedFile);
-        }
-
-        if ($this->chmod !== null) {
-            chmod($cachedFile, $this->chmod);
-        }
-
-        self::$cache['cached'][$this->cacheId] = true;
-
-        return $cachedFile;
-    }
-
-    /**
-     * clears the cached template if it's older than the given time.
-     *
-     * @param Dwoo_Core $dwoo      the dwoo instance that was used to cache that template
-     * @param int       $olderThan minimum time (in seconds) required for the cache to be cleared
-     *
-     * @return bool true if the cache was not present or if it was deleted, false if it remains there
-     */
-    public function clearCache(Dwoo_Core $dwoo, $olderThan = -1)
-    {
-        $cachedFile = $this->getCacheFilename($dwoo);
-
-        return !file_exists($cachedFile) || (filectime($cachedFile) < (time() - $olderThan) && unlink($cachedFile));
-    }
-
-    /**
-     * returns the compiled template file name.
-     *
-     * @param Dwoo_Core      $dwoo     the dwoo instance that requests it
-     * @param Dwoo_ICompiler $compiler the compiler that must be used
-     *
-     * @return string
-     */
-    public function getCompiledTemplate(Dwoo_Core $dwoo, Dwoo_ICompiler $compiler = null)
-    {
-        $compiledFile = $this->getCompiledFilename($dwoo);
-
-        if ($this->compilationEnforced !== true && isset(self::$cache['compiled'][$this->compileId]) === true) {
-            // already checked, return compiled file
-        } elseif ($this->compilationEnforced !== true && $this->isValidCompiledFile($compiledFile)) {
-            // template is compiled
-            self::$cache['compiled'][$this->compileId] = true;
-        } else {
-            // compiles the template
-            $this->compilationEnforced = false;
-
-            if ($compiler === null) {
-                $compiler = $dwoo->getDefaultCompilerFactory($this->getResourceName());
-
-                if ($compiler === null || $compiler === array('Dwoo_Compiler', 'compilerFactory')) {
-                    $compiler = Dwoo_Compiler::compilerFactory();
-                } else {
-                    $compiler = call_user_func($compiler);
-                }
-            }
-
-            $this->compiler = $compiler;
-
-            $compiler->setCustomPlugins($dwoo->getCustomPlugins());
-            $compiler->setSecurityPolicy($dwoo->getSecurityPolicy());
-            $this->makeDirectory(dirname($compiledFile), $dwoo->getCompileDir());
-            file_put_contents($compiledFile, $compiler->compile($dwoo, $this));
-            if ($this->chmod !== null) {
-                chmod($compiledFile, $this->chmod);
-            }
-
-            if (extension_loaded('Zend OPcache')) {
-                opcache_invalidate($compiledFile);
-            } elseif (extension_loaded('apc') && ini_get('apc.enabled')) {
-                apc_delete_file($compiledFile);
-            }
-
-            self::$cache['compiled'][$this->compileId] = true;
-        }
-
-        return $compiledFile;
-    }
-
-    /**
-     * Checks if compiled file is valid (it exists).
-     *
-     * @param string $file
-     *
-     * @return bool True cache file existance
-     */
-    protected function isValidCompiledFile($file)
-    {
-        return file_exists($file);
-    }
-
-    /**
-     * returns a new template string object with the resource id being the template source code.
-     *
-     * @param Dwoo_Core      $dwoo           the dwoo instance requiring it
-     * @param mixed          $resourceId     the filename (relative to this template's dir) of the template to include
-     * @param int            $cacheTime      duration of the cache validity for this template,
-     *                                       if null it defaults to the Dwoo instance that will
-     *                                       render this template
-     * @param string         $cacheId        the unique cache identifier of this page or anything else that
-     *                                       makes this template's content unique, if null it defaults
-     *                                       to the current url
-     * @param string         $compileId      the unique compiled identifier, which is used to distinguish this
-     *                                       template from others, if null it defaults to the filename+bits of the path
-     * @param Dwoo_ITemplate $parentTemplate the template that is requesting a new template object (through
-     *                                       an include, extends or any other plugin)
-     *
-     * @return Dwoo_Template_String
-     */
-    public static function templateFactory(Dwoo_Core $dwoo, $resourceId, $cacheTime = null, $cacheId = null, $compileId = null, Dwoo_ITemplate $parentTemplate = null)
-    {
-        return new self($resourceId, $cacheTime, $cacheId, $compileId);
-    }
-
-    /**
-     * returns the full compiled file name and assigns a default value to it if
-     * required.
-     *
-     * @param Dwoo_Core $dwoo the dwoo instance that requests the file name
-     *
-     * @return string the full path to the compiled file
-     */
-    protected function getCompiledFilename(Dwoo_Core $dwoo)
-    {
-        // no compile id was provided, set default
-        if ($this->compileId === null) {
-            $this->compileId = $this->name;
-        }
-
-        return $dwoo->getCompileDir().$this->compileId.'.d'.Dwoo_Core::RELEASE_TAG.'.php';
-    }
-
-    /**
-     * returns the full cached file name and assigns a default value to it if
-     * required.
-     *
-     * @param Dwoo_Core $dwoo the dwoo instance that requests the file name
-     *
-     * @return string the full path to the cached file
-     */
-    protected function getCacheFilename(Dwoo_Core $dwoo)
-    {
-        // no cache id provided, use request_uri as default
-        if ($this->cacheId === null) {
-            if (isset($_SERVER['REQUEST_URI']) === true) {
-                $cacheId = $_SERVER['REQUEST_URI'];
-            } elseif (isset($_SERVER['SCRIPT_FILENAME']) && isset($_SERVER['argv'])) {
-                $cacheId = $_SERVER['SCRIPT_FILENAME'].'-'.implode('-', $_SERVER['argv']);
-            } else {
-                $cacheId = '';
-            }
-            // force compiled id generation
-            $this->getCompiledFilename($dwoo);
-
-            $this->cacheId = str_replace('../', '__', $this->compileId.strtr($cacheId, '\\%?=!:;'.PATH_SEPARATOR, '/-------'));
-        }
-
-        return $dwoo->getCacheDir().$this->cacheId.'.html';
-    }
-
-    /**
-     * returns some php code that will check if this template has been modified or not.
-     *
-     * if the function returns null, the template will be instanciated and then the Uid checked
-     *
-     * @return string
-     */
-    public function getIsModifiedCode()
-    {
-        return null;
-    }
-
-    /**
-     * ensures the given path exists.
-     *
-     * @param string $path    any path
-     * @param string $baseDir the base directory where the directory is created
-     *                        ($path must still contain the full path, $baseDir
-     *                        is only used for unix permissions)
-     *
-     * @throws Exception
-     */
-    protected function makeDirectory($path, $baseDir = null)
-    {
-        if (is_dir($path) === true) {
-            return;
-        }
-
-        if ($this->chmod === null) {
-            $chmod = 0777;
-        } else {
-            $chmod = $this->chmod;
-        }
-
-        $retries = 3;
-        while ($retries--) {
-            @mkdir($path, $chmod, true);
-            if (is_dir($path)) {
-                break;
-            }
-            usleep(20);
-        }
-
-        // enforce the correct mode for all directories created
-        if (strpos(PHP_OS, 'WIN') !== 0 && $baseDir !== null) {
-            $path = strtr(str_replace($baseDir, '', $path), '\\', '/');
-            $folders = explode('/', trim($path, '/'));
-            foreach ($folders as $folder) {
-                $baseDir .= $folder.DIRECTORY_SEPARATOR;
-                if (!chmod($baseDir, $chmod)) {
-                    throw new Exception('Unable to chmod '.
-                        "$baseDir to $chmod: ".
-                        print_r(error_get_last(), true));
-                }
-            }
-        }
-    }
+	/**
+	 * template name.
+	 *
+	 * @var string
+	 */
+	protected $name;
+
+	/**
+	 * template compilation id.
+	 *
+	 * @var string
+	 */
+	protected $compileId;
+
+	/**
+	 * template cache id, if not provided in the constructor, it is set to
+	 * the md4 hash of the request_uri. it is however highly recommended to
+	 * provide one that will fit your needs.
+	 *
+	 * in all cases, the compilation id is prepended to the cache id to separate
+	 * templates with similar cache ids from one another
+	 *
+	 * @var string
+	 */
+	protected $cacheId;
+
+	/**
+	 * validity duration of the generated cache file (in seconds).
+	 *
+	 * set to -1 for infinite cache, 0 to disable and null to inherit the Dwoo instance's cache time
+	 *
+	 * @var int
+	 */
+	protected $cacheTime;
+
+	/**
+	 * boolean flag that defines whether the compilation should be enforced (once) or
+	 * not use this if you have issues with the compiled templates not being updated
+	 * but if you do need this it's most likely that you should file a bug report.
+	 *
+	 * @var bool
+	 */
+	protected $compilationEnforced;
+
+	/**
+	 * caches the results of the file checks to save some time when the same
+	 * templates is rendered several times.
+	 *
+	 * @var array
+	 */
+	protected static $cache = array('cached' => array(), 'compiled' => array());
+
+	/**
+	 * holds the compiler that built this template.
+	 *
+	 * @var Dwoo_ICompiler
+	 */
+	protected $compiler;
+
+	/**
+	 * chmod value for all files written (cached or compiled ones).
+	 *
+	 * set to null if you don't want any chmod operation to happen
+	 *
+	 * @var int
+	 */
+	protected $chmod = 0777;
+
+	protected $template;
+
+	/**
+	 * creates a template from a string.
+	 *
+	 * @param string $templateString the template to use
+	 * @param int    $cacheTime      duration of the cache validity for this template,
+	 *                               if null it defaults to the Dwoo instance that will
+	 *                               render this template, set to -1 for infinite cache or 0 to disable
+	 * @param string $cacheId        the unique cache identifier of this page or anything else that
+	 *                               makes this template's content unique, if null it defaults
+	 *                               to the current url
+	 * @param string $compileId      the unique compiled identifier, which is used to distinguish this
+	 *                               template from others, if null it defaults to the md4 hash of the template
+	 */
+	public function __construct($templateString, $cacheTime = null, $cacheId = null, $compileId = null)
+	{
+		$this->template = $templateString;
+		if (function_exists('hash')) {
+			$this->name = hash('md4', $templateString);
+		} else {
+			$this->name = md5($templateString);
+		}
+		$this->cacheTime = $cacheTime;
+
+		if ($compileId !== null) {
+			$this->compileId = str_replace('../', '__', strtr($compileId, '\\%?=!:;'.PATH_SEPARATOR, '/-------'));
+		}
+
+		if ($cacheId !== null) {
+			$this->cacheId = str_replace('../', '__', strtr($cacheId, '\\%?=!:;'.PATH_SEPARATOR, '/-------'));
+		}
+	}
+
+	/**
+	 * returns the cache duration for this template.
+	 *
+	 * defaults to null if it was not provided
+	 *
+	 * @return int|null
+	 */
+	public function getCacheTime()
+	{
+		return $this->cacheTime;
+	}
+
+	/**
+	 * sets the cache duration for this template.
+	 *
+	 * can be used to set it after the object is created if you did not provide
+	 * it in the constructor
+	 *
+	 * @param int $seconds duration of the cache validity for this template, if
+	 *                     null it defaults to the Dwoo instance's cache time. 0 = disable and
+	 *                     -1 = infinite cache
+	 */
+	public function setCacheTime($seconds = null)
+	{
+		$this->cacheTime = $seconds;
+	}
+
+	/**
+	 * returns the chmod value for all files written (cached or compiled ones).
+	 *
+	 * defaults to 0777
+	 *
+	 * @return int|null
+	 */
+	public function getChmod()
+	{
+		return $this->chmod;
+	}
+
+	/**
+	 * set the chmod value for all files written (cached or compiled ones).
+	 *
+	 * set to null if you don't want to do any chmod() operation
+	 *
+	 * @param int $mask new bitmask to use for all files
+	 */
+	public function setChmod($mask = null)
+	{
+		$this->chmod = $mask;
+	}
+
+	/**
+	 * returns the template name.
+	 *
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->name;
+	}
+
+	/**
+	 * returns the resource name for this template class.
+	 *
+	 * @return string
+	 */
+	public function getResourceName()
+	{
+		return 'string';
+	}
+
+	/**
+	 * returns the resource identifier for this template, false here as strings don't have identifiers.
+	 *
+	 * @return false
+	 */
+	public function getResourceIdentifier()
+	{
+		return false;
+	}
+
+	/**
+	 * returns the template source of this template.
+	 *
+	 * @return string
+	 */
+	public function getSource()
+	{
+		return $this->template;
+	}
+
+	/**
+	 * returns an unique value identifying the current version of this template,
+	 * in this case it's the md4 hash of the content.
+	 *
+	 * @return string
+	 */
+	public function getUid()
+	{
+		return $this->name;
+	}
+
+	/**
+	 * returns the compiler used by this template, if it was just compiled, or null.
+	 *
+	 * @return Dwoo_ICompiler
+	 */
+	public function getCompiler()
+	{
+		return $this->compiler;
+	}
+
+	/**
+	 * marks this template as compile-forced, which means it will be recompiled even if it
+	 * was already saved and wasn't modified since the last compilation. do not use this in production,
+	 * it's only meant to be used in development (and the development of dwoo particularly).
+	 */
+	public function forceCompilation()
+	{
+		$this->compilationEnforced = true;
+	}
+
+	/**
+	 * returns the cached template output file name, true if it's cache-able but not cached
+	 * or false if it's not cached.
+	 *
+	 * @param Dwoo_Core $dwoo the dwoo instance that requests it
+	 *
+	 * @return string|bool
+	 */
+	public function getCachedTemplate(Dwoo_Core $dwoo)
+	{
+		if ($this->cacheTime !== null) {
+			$cacheLength = $this->cacheTime;
+		} else {
+			$cacheLength = $dwoo->getCacheTime();
+		}
+
+		// file is not cacheable
+		if ($cacheLength == 0) {
+			return false;
+		}
+
+		$cachedFile = $this->getCacheFilename($dwoo);
+
+		if (isset(self::$cache['cached'][$this->cacheId]) === true && file_exists($cachedFile)) {
+			// already checked, return cache file
+			return $cachedFile;
+		} elseif ($this->compilationEnforced !== true && file_exists($cachedFile) && ($cacheLength === -1 || filemtime($cachedFile) > ($_SERVER['REQUEST_TIME'] - $cacheLength)) && $this->isValidCompiledFile($this->getCompiledFilename($dwoo))) {
+			// cache is still valid and can be loaded
+			self::$cache['cached'][$this->cacheId] = true;
+
+			return $cachedFile;
+		} else {
+			// file is cacheable
+			return true;
+		}
+	}
+
+	/**
+	 * caches the provided output into the cache file.
+	 *
+	 * @param Dwoo_Core $dwoo   the dwoo instance that requests it
+	 * @param string    $output the template output
+	 *
+	 * @return mixed full path of the cached file or false upon failure
+	 */
+	public function cache(Dwoo_Core $dwoo, $output)
+	{
+		$cacheDir = $dwoo->getCacheDir();
+		$cachedFile = $this->getCacheFilename($dwoo);
+
+		// the code below is courtesy of Rasmus Schultz,
+		// thanks for his help on avoiding concurency issues
+		$temp = tempnam($cacheDir, 'temp');
+		if (!($file = @fopen($temp, 'wb'))) {
+			$temp = $cacheDir.uniqid('temp');
+			if (!($file = @fopen($temp, 'wb'))) {
+				trigger_error('Error writing temporary file \''.$temp.'\'', E_USER_WARNING);
+
+				return false;
+			}
+		}
+
+		fwrite($file, $output);
+		fclose($file);
+
+		$this->makeDirectory(dirname($cachedFile), $cacheDir);
+		if (!@rename($temp, $cachedFile)) {
+			@unlink($cachedFile);
+			@rename($temp, $cachedFile);
+		}
+
+		if ($this->chmod !== null) {
+			chmod($cachedFile, $this->chmod);
+		}
+
+		self::$cache['cached'][$this->cacheId] = true;
+
+		return $cachedFile;
+	}
+
+	/**
+	 * clears the cached template if it's older than the given time.
+	 *
+	 * @param Dwoo_Core $dwoo      the dwoo instance that was used to cache that template
+	 * @param int       $olderThan minimum time (in seconds) required for the cache to be cleared
+	 *
+	 * @return bool true if the cache was not present or if it was deleted, false if it remains there
+	 */
+	public function clearCache(Dwoo_Core $dwoo, $olderThan = -1)
+	{
+		$cachedFile = $this->getCacheFilename($dwoo);
+
+		return !file_exists($cachedFile) || (filectime($cachedFile) < (time() - $olderThan) && unlink($cachedFile));
+	}
+
+	/**
+	 * returns the compiled template file name.
+	 *
+	 * @param Dwoo_Core      $dwoo     the dwoo instance that requests it
+	 * @param Dwoo_ICompiler $compiler the compiler that must be used
+	 *
+	 * @return string
+	 */
+	public function getCompiledTemplate(Dwoo_Core $dwoo, Dwoo_ICompiler $compiler = null)
+	{
+		$compiledFile = $this->getCompiledFilename($dwoo);
+
+		if ($this->compilationEnforced !== true && isset(self::$cache['compiled'][$this->compileId]) === true) {
+			// already checked, return compiled file
+		} elseif ($this->compilationEnforced !== true && $this->isValidCompiledFile($compiledFile)) {
+			// template is compiled
+			self::$cache['compiled'][$this->compileId] = true;
+		} else {
+			// compiles the template
+			$this->compilationEnforced = false;
+
+			if ($compiler === null) {
+				$compiler = $dwoo->getDefaultCompilerFactory($this->getResourceName());
+
+				if ($compiler === null || $compiler === array('Dwoo_Compiler', 'compilerFactory')) {
+					$compiler = Dwoo_Compiler::compilerFactory();
+				} else {
+					$compiler = call_user_func($compiler);
+				}
+			}
+
+			$this->compiler = $compiler;
+
+			$compiler->setCustomPlugins($dwoo->getCustomPlugins());
+			$compiler->setSecurityPolicy($dwoo->getSecurityPolicy());
+			$this->makeDirectory(dirname($compiledFile), $dwoo->getCompileDir());
+			file_put_contents($compiledFile, $compiler->compile($dwoo, $this));
+			if ($this->chmod !== null) {
+				chmod($compiledFile, $this->chmod);
+			}
+
+			if (extension_loaded('Zend OPcache')) {
+				opcache_invalidate($compiledFile);
+			} elseif (extension_loaded('apc') && ini_get('apc.enabled')) {
+				apc_delete_file($compiledFile);
+			}
+
+			self::$cache['compiled'][$this->compileId] = true;
+		}
+
+		return $compiledFile;
+	}
+
+	/**
+	 * Checks if compiled file is valid (it exists).
+	 *
+	 * @param string $file
+	 *
+	 * @return bool True cache file existance
+	 */
+	protected function isValidCompiledFile($file)
+	{
+		return file_exists($file);
+	}
+
+	/**
+	 * returns a new template string object with the resource id being the template source code.
+	 *
+	 * @param Dwoo_Core      $dwoo           the dwoo instance requiring it
+	 * @param mixed          $resourceId     the filename (relative to this template's dir) of the template to include
+	 * @param int            $cacheTime      duration of the cache validity for this template,
+	 *                                       if null it defaults to the Dwoo instance that will
+	 *                                       render this template
+	 * @param string         $cacheId        the unique cache identifier of this page or anything else that
+	 *                                       makes this template's content unique, if null it defaults
+	 *                                       to the current url
+	 * @param string         $compileId      the unique compiled identifier, which is used to distinguish this
+	 *                                       template from others, if null it defaults to the filename+bits of the path
+	 * @param Dwoo_ITemplate $parentTemplate the template that is requesting a new template object (through
+	 *                                       an include, extends or any other plugin)
+	 *
+	 * @return Dwoo_Template_String
+	 */
+	public static function templateFactory(Dwoo_Core $dwoo, $resourceId, $cacheTime = null, $cacheId = null, $compileId = null, Dwoo_ITemplate $parentTemplate = null)
+	{
+		return new self($resourceId, $cacheTime, $cacheId, $compileId);
+	}
+
+	/**
+	 * returns the full compiled file name and assigns a default value to it if
+	 * required.
+	 *
+	 * @param Dwoo_Core $dwoo the dwoo instance that requests the file name
+	 *
+	 * @return string the full path to the compiled file
+	 */
+	protected function getCompiledFilename(Dwoo_Core $dwoo)
+	{
+		// no compile id was provided, set default
+		if ($this->compileId === null) {
+			$this->compileId = $this->name;
+		}
+
+		return $dwoo->getCompileDir().$this->compileId.'.d'.Dwoo_Core::RELEASE_TAG.'.php';
+	}
+
+	/**
+	 * returns the full cached file name and assigns a default value to it if
+	 * required.
+	 *
+	 * @param Dwoo_Core $dwoo the dwoo instance that requests the file name
+	 *
+	 * @return string the full path to the cached file
+	 */
+	protected function getCacheFilename(Dwoo_Core $dwoo)
+	{
+		// no cache id provided, use request_uri as default
+		if ($this->cacheId === null) {
+			if (isset($_SERVER['REQUEST_URI']) === true) {
+				$cacheId = $_SERVER['REQUEST_URI'];
+			} elseif (isset($_SERVER['SCRIPT_FILENAME']) && isset($_SERVER['argv'])) {
+				$cacheId = $_SERVER['SCRIPT_FILENAME'].'-'.implode('-', $_SERVER['argv']);
+			} else {
+				$cacheId = '';
+			}
+			// force compiled id generation
+			$this->getCompiledFilename($dwoo);
+
+			$this->cacheId = str_replace('../', '__', $this->compileId.strtr($cacheId, '\\%?=!:;'.PATH_SEPARATOR, '/-------'));
+		}
+
+		return $dwoo->getCacheDir().$this->cacheId.'.html';
+	}
+
+	/**
+	 * returns some php code that will check if this template has been modified or not.
+	 *
+	 * if the function returns null, the template will be instanciated and then the Uid checked
+	 *
+	 * @return string
+	 */
+	public function getIsModifiedCode()
+	{
+		return null;
+	}
+
+	/**
+	 * ensures the given path exists.
+	 *
+	 * @param string $path    any path
+	 * @param string $baseDir the base directory where the directory is created
+	 *                        ($path must still contain the full path, $baseDir
+	 *                        is only used for unix permissions)
+	 *
+	 * @throws Exception
+	 */
+	protected function makeDirectory($path, $baseDir = null)
+	{
+		if (is_dir($path) === true) {
+			return;
+		}
+
+		if ($this->chmod === null) {
+			$chmod = 0777;
+		} else {
+			$chmod = $this->chmod;
+		}
+
+		$retries = 3;
+		while ($retries--) {
+			@mkdir($path, $chmod, true);
+			if (is_dir($path)) {
+				break;
+			}
+			usleep(20);
+		}
+
+		// enforce the correct mode for all directories created
+		if (strpos(PHP_OS, 'WIN') !== 0 && $baseDir !== null) {
+			$path = strtr(str_replace($baseDir, '', $path), '\\', '/');
+			$folders = explode('/', trim($path, '/'));
+			foreach ($folders as $folder) {
+				$baseDir .= $folder.DIRECTORY_SEPARATOR;
+				if (!chmod($baseDir, $chmod)) {
+					throw new Exception('Unable to chmod '.
+						"$baseDir to $chmod: ".
+						print_r(error_get_last(), true));
+				}
+			}
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -269,7 +269,7 @@ 
         if (isset(self::$cache['cached'][$this->cacheId]) === true && file_exists($cachedFile)) {
             // already checked, return cache file
             return $cachedFile;
-        } elseif ($this->compilationEnforced !== true && file_exists($cachedFile) && ($cacheLength === -1 || filemtime($cachedFile) > ($_SERVER['REQUEST_TIME'] - $cacheLength)) && $this->isValidCompiledFile($this->getCompiledFilename($dwoo))) {
+        } elseif ($this->compilationEnforced !== true && file_exists($cachedFile) && ($cacheLength === -1 || filemtime($cachedFile) > ($_SERVER['REQUEST_TIME']-$cacheLength)) && $this->isValidCompiledFile($this->getCompiledFilename($dwoo))) {
             // cache is still valid and can be loaded
             self::$cache['cached'][$this->cacheId] = true;
 
@@ -335,7 +335,7 @@ 
     {
         $cachedFile = $this->getCacheFilename($dwoo);
 
-        return !file_exists($cachedFile) || (filectime($cachedFile) < (time() - $olderThan) && unlink($cachedFile));
+        return !file_exists($cachedFile) || (filectime($cachedFile) < (time()-$olderThan) && unlink($cachedFile));
     }
 
     /**

lib/plugins/builtin/blocks/dynamic.php

Doc Comments +4 added lines

@@ -57,6 +57,10 @@
         return $output;
     }
 
+    /**
+     * @param string $dynamicId
+     * @param string $compiledFile
+     */
     public static function unescape($output, $dynamicId, $compiledFile)
     {
         $output = preg_replace_callback('/<dwoo:dynamic_('.$dynamicId.')>(.+?)<\/dwoo:dynamic_'.$dynamicId.'>/s', array('self', 'unescapePhp'), $output, -1, $count);

Indentation +46 added lines, -46 removed lines

@@ -19,57 +19,57 @@
  */
 class Dwoo_Plugin_dynamic extends Dwoo_Block_Plugin implements Dwoo_ICompilable_Block
 {
-    public function init()
-    {
-    }
+	public function init()
+	{
+	}
 
-    public static function preProcessing(Dwoo_Compiler $compiler, array $params, $prepend, $append, $type)
-    {
-        return '';
-    }
+	public static function preProcessing(Dwoo_Compiler $compiler, array $params, $prepend, $append, $type)
+	{
+		return '';
+	}
 
-    public static function postProcessing(Dwoo_Compiler $compiler, array $params, $prepend, $append, $content)
-    {
-        try {
-            $compiler->findBlock('dynamic');
+	public static function postProcessing(Dwoo_Compiler $compiler, array $params, $prepend, $append, $content)
+	{
+		try {
+			$compiler->findBlock('dynamic');
 
-            return $content;
-        } catch (Dwoo_Compilation_Exception $e) {
-        }
-        $output = Dwoo_Compiler::PHP_OPEN.
-            'if($doCache) {'."\n\t".
-                'echo \'<dwoo:dynamic_\'.$dynamicId.\'>'.
-                str_replace('\'', '\\\'', $content).
-                '</dwoo:dynamic_\'.$dynamicId.\'>\';'.
-            "\n} else {\n\t";
-        if (substr($content, 0, strlen(Dwoo_Compiler::PHP_OPEN)) == Dwoo_Compiler::PHP_OPEN) {
-            $output .= substr($content, strlen(Dwoo_Compiler::PHP_OPEN));
-        } else {
-            $output .= Dwoo_Compiler::PHP_CLOSE.$content;
-        }
-        if (substr($output, -strlen(Dwoo_Compiler::PHP_CLOSE)) == Dwoo_Compiler::PHP_CLOSE) {
-            $output = substr($output, 0, -strlen(Dwoo_Compiler::PHP_CLOSE));
-        } else {
-            $output .= Dwoo_Compiler::PHP_OPEN;
-        }
-        $output .= "\n}".Dwoo_Compiler::PHP_CLOSE;
+			return $content;
+		} catch (Dwoo_Compilation_Exception $e) {
+		}
+		$output = Dwoo_Compiler::PHP_OPEN.
+			'if($doCache) {'."\n\t".
+				'echo \'<dwoo:dynamic_\'.$dynamicId.\'>'.
+				str_replace('\'', '\\\'', $content).
+				'</dwoo:dynamic_\'.$dynamicId.\'>\';'.
+			"\n} else {\n\t";
+		if (substr($content, 0, strlen(Dwoo_Compiler::PHP_OPEN)) == Dwoo_Compiler::PHP_OPEN) {
+			$output .= substr($content, strlen(Dwoo_Compiler::PHP_OPEN));
+		} else {
+			$output .= Dwoo_Compiler::PHP_CLOSE.$content;
+		}
+		if (substr($output, -strlen(Dwoo_Compiler::PHP_CLOSE)) == Dwoo_Compiler::PHP_CLOSE) {
+			$output = substr($output, 0, -strlen(Dwoo_Compiler::PHP_CLOSE));
+		} else {
+			$output .= Dwoo_Compiler::PHP_OPEN;
+		}
+		$output .= "\n}".Dwoo_Compiler::PHP_CLOSE;
 
-        return $output;
-    }
+		return $output;
+	}
 
-    public static function unescape($output, $dynamicId, $compiledFile)
-    {
-        $output = preg_replace_callback('/<dwoo:dynamic_('.$dynamicId.')>(.+?)<\/dwoo:dynamic_'.$dynamicId.'>/s', array('self', 'unescapePhp'), $output, -1, $count);
-        // re-add the includes on top of the file
-        if ($count && preg_match('#/\* template head \*/(.+?)/\* end template head \*/#s', file_get_contents($compiledFile), $m)) {
-            $output = '<?php '.$m[1].' ?>'.$output;
-        }
+	public static function unescape($output, $dynamicId, $compiledFile)
+	{
+		$output = preg_replace_callback('/<dwoo:dynamic_('.$dynamicId.')>(.+?)<\/dwoo:dynamic_'.$dynamicId.'>/s', array('self', 'unescapePhp'), $output, -1, $count);
+		// re-add the includes on top of the file
+		if ($count && preg_match('#/\* template head \*/(.+?)/\* end template head \*/#s', file_get_contents($compiledFile), $m)) {
+			$output = '<?php '.$m[1].' ?>'.$output;
+		}
 
-        return $output;
-    }
+		return $output;
+	}
 
-    public static function unescapePhp($match)
-    {
-        return preg_replace('{<\?php /\*'.$match[1].'\*/ echo \'(.+?)\'; \?>}s', '$1', $match[2]);
-    }
+	public static function unescapePhp($match)
+	{
+		return preg_replace('{<\?php /\*'.$match[1].'\*/ echo \'(.+?)\'; \?>}s', '$1', $match[2]);
+	}
 }

lib/Dwoo/IDataProvider.php

Indentation +6 added lines, -6 removed lines

@@ -19,10 +19,10 @@
  */
 interface Dwoo_IDataProvider
 {
-    /**
-     * returns the data as an associative array that will be used in the template.
-     *
-     * @return array
-     */
-    public function getData();
+	/**
+	 * returns the data as an associative array that will be used in the template.
+	 *
+	 * @return array
+	 */
+	public function getData();
 }

lib/Dwoo/Filter.php

Indentation +24 added lines, -24 removed lines

@@ -18,30 +18,30 @@
  */
 abstract class Dwoo_Filter
 {
-    /**
-     * The dwoo instance that runs this filter.
-     *
-     * @var Dwoo
-     */
-    protected $dwoo;
+	/**
+	 * The dwoo instance that runs this filter.
+	 *
+	 * @var Dwoo
+	 */
+	protected $dwoo;
 
-    /**
-     * Constructor, if you override it, call parent::__construct($dwoo); or assign
-     * the dwoo instance yourself if you need it.
-     *
-     * @param Dwoo_Core $dwoo the dwoo instance that runs this plugin
-     */
-    public function __construct(Dwoo_Core $dwoo)
-    {
-        $this->dwoo = $dwoo;
-    }
+	/**
+	 * Constructor, if you override it, call parent::__construct($dwoo); or assign
+	 * the dwoo instance yourself if you need it.
+	 *
+	 * @param Dwoo_Core $dwoo the dwoo instance that runs this plugin
+	 */
+	public function __construct(Dwoo_Core $dwoo)
+	{
+		$this->dwoo = $dwoo;
+	}
 
-    /**
-     * Processes the input and returns it filtered.
-     *
-     * @param string $input the template to process
-     *
-     * @return string
-     */
-    abstract public function process($input);
+	/**
+	 * Processes the input and returns it filtered.
+	 *
+	 * @param string $input the template to process
+	 *
+	 * @return string
+	 */
+	abstract public function process($input);
 }

lib/Dwoo/Adapters/ZendFramework/Dwoo.php

Indentation +19 added lines, -19 removed lines

@@ -19,24 +19,24 @@
  */
 class Dwoo_Adapters_ZendFramework_Dwoo extends Dwoo_Core
 {
-    /**
-     * Redirects all unknown properties to plugin proxy
-     * to support $this->viewVariable from within templates.
-     *
-     * @param string $name Property name
-     *
-     * @return mixed
-     */
-    public function __get($name)
-    {
-        if (isset($this->getPluginProxy()->view->$name)) {
-            return $this->getPluginProxy()->view->$name;
-        }
-        $trace = debug_backtrace();
-        trigger_error('Undefined property via __get(): '.$name.
-                      ' in '.$trace[0]['file'].
-                      ' on line '.$trace[0]['line'], E_USER_NOTICE);
+	/**
+	 * Redirects all unknown properties to plugin proxy
+	 * to support $this->viewVariable from within templates.
+	 *
+	 * @param string $name Property name
+	 *
+	 * @return mixed
+	 */
+	public function __get($name)
+	{
+		if (isset($this->getPluginProxy()->view->$name)) {
+			return $this->getPluginProxy()->view->$name;
+		}
+		$trace = debug_backtrace();
+		trigger_error('Undefined property via __get(): '.$name.
+					  ' in '.$trace[0]['file'].
+					  ' on line '.$trace[0]['line'], E_USER_NOTICE);
 
-        return null;
-    }
+		return null;
+	}
 }

lib/Dwoo/Adapters/Agavi/DwooRenderer.php

Indentation +153 added lines, -153 removed lines

@@ -48,157 +48,157 @@
  */
 class DwooRenderer extends AgaviRenderer implements AgaviIReusableRenderer
 {
-    /**
-     * @constant   string The directory inside the cache dir where templates will
-     *                    be stored in compiled form.
-     */
-    const COMPILE_DIR = 'templates';
-
-    /**
-     * @constant   string The subdirectory inside the compile dir where templates
-     *                    will be stored in compiled form.
-     */
-    const COMPILE_SUBDIR = 'dwoo';
-
-    /**
-     * @constant   string The directory inside the cache dir where cached content
-     *                    will be stored.
-     */
-    const CACHE_DIR = 'dwoo';
-
-    /**
-     * @var Dwoo Dwoo template engine
-     */
-    protected $dwoo = null;
-
-    /**
-     * @var string A string with the default template file extension,
-     *             including the dot
-     */
-    protected $defaultExtension = '.html';
-
-    /**
-     * stores the (optional) plugin directories to add to the Dwoo_Loader.
-     */
-    protected $plugin_dir = null;
-
-    /**
-     * Pre-serialization callback.
-     *
-     * Excludes the Dwoo instance to prevent excessive serialization load.
-     */
-    public function __sleep()
-    {
-        $keys = parent::__sleep();
-        unset($keys[array_search('dwoo', $keys)]);
-
-        return $keys;
-    }
-
-    /**
-     * Initialize this Renderer.
-     *
-     * @param      AgaviContext The current application context
-     * @param      array        An associative array of initialization parameters
-     */
-    public function initialize(AgaviContext $context, array $parameters = array())
-    {
-        parent::initialize($context, $parameters);
-
-        $this->plugin_dir = $this->getParameter('plugin_dir', $this->plugin_dir);
-    }
-
-    /**
-     * provides a custom compiler to the dwoo renderer with optional settings
-     * you can set in the agavi output_types.xml config file.
-     *
-     * @return Dwoo_Compiler
-     */
-    public function compilerFactory()
-    {
-        $compiler = Dwoo_Compiler::compilerFactory();
-        $compiler->setAutoEscape((bool) $this->getParameter('auto_escape', false));
-
-        return $compiler;
-    }
-
-    /**
-     * Grab a cleaned up dwoo instance.
-     *
-     * @return Dwoo A Dwoo instance
-     */
-    protected function getEngine()
-    {
-        if ($this->dwoo) {
-            return $this->dwoo;
-        }
-
-        // this triggers Agavi autoload
-        if (!class_exists('Dwoo')) {
-            if (file_exists(dirname(__FILE__).'/../../../dwooAutoload.php')) {
-                // file was dropped with the entire dwoo package
-                require dirname(__FILE__).'/../../../dwooAutoload.php';
-            } else {
-                // assume the dwoo package is in the include path
-                require 'dwooAutoload.php';
-            }
-        }
-
-        $parentMode = fileperms(AgaviConfig::get('core.cache_dir'));
-
-        $compileDir = AgaviConfig::get('core.cache_dir').DIRECTORY_SEPARATOR.self::COMPILE_DIR.DIRECTORY_SEPARATOR.self::COMPILE_SUBDIR;
-        AgaviToolkit::mkdir($compileDir, $parentMode, true);
-
-        $cacheDir = AgaviConfig::get('core.cache_dir').DIRECTORY_SEPARATOR.self::CACHE_DIR;
-        AgaviToolkit::mkdir($cacheDir, $parentMode, true);
-
-        $this->dwoo = new Dwoo_Core($compileDir, $cacheDir);
-
-        if (!empty($this->plugin_dir)) {
-            foreach ((array) $this->plugin_dir as $dir) {
-                $this->dwoo->getLoader()->addDirectory($dir);
-            }
-        }
-
-        $this->dwoo->setDefaultCompilerFactory('file', array($this, 'compilerFactory'));
-
-        return $this->dwoo;
-    }
-
-    /**
-     * Render the presentation and return the result.
-     *
-     * @param      AgaviTemplateLayer The template layer to render
-     * @param      array              The template variables
-     * @param      array              The slots
-     * @param      array              Associative array of additional assigns
-     *
-     * @return string A rendered result
-     */
-    public function render(AgaviTemplateLayer $layer, array &$attributes = array(), array &$slots = array(), array &$moreAssigns = array())
-    {
-        $engine = $this->getEngine();
-
-        $data = array();
-        if ($this->extractVars) {
-            $data = $attributes;
-        } else {
-            $data[$this->varName] = &$attributes;
-        }
-
-        $data[$this->slotsVarName] = &$slots;
-
-        foreach ($this->assigns as $key => $getter) {
-            $data[$key] = $this->getContext()->$getter();
-        }
-
-        foreach ($moreAssigns as $key => &$value) {
-            if (isset($this->moreAssignNames[$key])) {
-                $key = $this->moreAssignNames[$key];
-            }
-            $data[$key] = &$value;
-        }
-
-        return $engine->get($layer->getResourceStreamIdentifier(), $data);
-    }
+	/**
+	 * @constant   string The directory inside the cache dir where templates will
+	 *                    be stored in compiled form.
+	 */
+	const COMPILE_DIR = 'templates';
+
+	/**
+	 * @constant   string The subdirectory inside the compile dir where templates
+	 *                    will be stored in compiled form.
+	 */
+	const COMPILE_SUBDIR = 'dwoo';
+
+	/**
+	 * @constant   string The directory inside the cache dir where cached content
+	 *                    will be stored.
+	 */
+	const CACHE_DIR = 'dwoo';
+
+	/**
+	 * @var Dwoo Dwoo template engine
+	 */
+	protected $dwoo = null;
+
+	/**
+	 * @var string A string with the default template file extension,
+	 *             including the dot
+	 */
+	protected $defaultExtension = '.html';
+
+	/**
+	 * stores the (optional) plugin directories to add to the Dwoo_Loader.
+	 */
+	protected $plugin_dir = null;
+
+	/**
+	 * Pre-serialization callback.
+	 *
+	 * Excludes the Dwoo instance to prevent excessive serialization load.
+	 */
+	public function __sleep()
+	{
+		$keys = parent::__sleep();
+		unset($keys[array_search('dwoo', $keys)]);
+
+		return $keys;
+	}
+
+	/**
+	 * Initialize this Renderer.
+	 *
+	 * @param      AgaviContext The current application context
+	 * @param      array        An associative array of initialization parameters
+	 */
+	public function initialize(AgaviContext $context, array $parameters = array())
+	{
+		parent::initialize($context, $parameters);
+
+		$this->plugin_dir = $this->getParameter('plugin_dir', $this->plugin_dir);
+	}
+
+	/**
+	 * provides a custom compiler to the dwoo renderer with optional settings
+	 * you can set in the agavi output_types.xml config file.
+	 *
+	 * @return Dwoo_Compiler
+	 */
+	public function compilerFactory()
+	{
+		$compiler = Dwoo_Compiler::compilerFactory();
+		$compiler->setAutoEscape((bool) $this->getParameter('auto_escape', false));
+
+		return $compiler;
+	}
+
+	/**
+	 * Grab a cleaned up dwoo instance.
+	 *
+	 * @return Dwoo A Dwoo instance
+	 */
+	protected function getEngine()
+	{
+		if ($this->dwoo) {
+			return $this->dwoo;
+		}
+
+		// this triggers Agavi autoload
+		if (!class_exists('Dwoo')) {
+			if (file_exists(dirname(__FILE__).'/../../../dwooAutoload.php')) {
+				// file was dropped with the entire dwoo package
+				require dirname(__FILE__).'/../../../dwooAutoload.php';
+			} else {
+				// assume the dwoo package is in the include path
+				require 'dwooAutoload.php';
+			}
+		}
+
+		$parentMode = fileperms(AgaviConfig::get('core.cache_dir'));
+
+		$compileDir = AgaviConfig::get('core.cache_dir').DIRECTORY_SEPARATOR.self::COMPILE_DIR.DIRECTORY_SEPARATOR.self::COMPILE_SUBDIR;
+		AgaviToolkit::mkdir($compileDir, $parentMode, true);
+
+		$cacheDir = AgaviConfig::get('core.cache_dir').DIRECTORY_SEPARATOR.self::CACHE_DIR;
+		AgaviToolkit::mkdir($cacheDir, $parentMode, true);
+
+		$this->dwoo = new Dwoo_Core($compileDir, $cacheDir);
+
+		if (!empty($this->plugin_dir)) {
+			foreach ((array) $this->plugin_dir as $dir) {
+				$this->dwoo->getLoader()->addDirectory($dir);
+			}
+		}
+
+		$this->dwoo->setDefaultCompilerFactory('file', array($this, 'compilerFactory'));
+
+		return $this->dwoo;
+	}
+
+	/**
+	 * Render the presentation and return the result.
+	 *
+	 * @param      AgaviTemplateLayer The template layer to render
+	 * @param      array              The template variables
+	 * @param      array              The slots
+	 * @param      array              Associative array of additional assigns
+	 *
+	 * @return string A rendered result
+	 */
+	public function render(AgaviTemplateLayer $layer, array &$attributes = array(), array &$slots = array(), array &$moreAssigns = array())
+	{
+		$engine = $this->getEngine();
+
+		$data = array();
+		if ($this->extractVars) {
+			$data = $attributes;
+		} else {
+			$data[$this->varName] = &$attributes;
+		}
+
+		$data[$this->slotsVarName] = &$slots;
+
+		foreach ($this->assigns as $key => $getter) {
+			$data[$key] = $this->getContext()->$getter();
+		}
+
+		foreach ($moreAssigns as $key => &$value) {
+			if (isset($this->moreAssignNames[$key])) {
+				$key = $this->moreAssignNames[$key];
+			}
+			$data[$key] = &$value;
+		}
+
+		return $engine->get($layer->getResourceStreamIdentifier(), $data);
+	}
 }

lib/Dwoo/Adapters/CodeIgniter/config/dwootemplate.php

Indentation +1 added lines, -1 removed lines

@@ -1,6 +1,6 @@
 <?php
  if (!defined('BASEPATH')) {
-     exit('No direct script access allowed');
+	 exit('No direct script access allowed');
  }
 
 // The name of the directory where templates are located.