dwoo-project / dwoo

lib/Dwoo/Template/String.php

Doc Comments +1 added lines, -1 removed lines

@@ -293,7 +293,7 @@
      * @param Core   $core   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(Core $core, $output)
     {

Indentation +505 added lines, -505 removed lines

@@ -29,509 +29,509 @@
  */
 class String implements 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 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;
-
-    /**
-     * Containing template string.
-     *
-     * @var string
-     */
-    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;
-        $this->name      = hash('md4', $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 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 Core $core the dwoo instance that requests it
-     *
-     * @return string|bool
-     */
-    public function getCachedTemplate(Core $core)
-    {
-        if ($this->cacheTime !== null) {
-            $cacheLength = $this->cacheTime;
-        } else {
-            $cacheLength = $core->getCacheTime();
-        }
-
-        // file is not cacheable
-        if ($cacheLength == 0) {
-            return false;
-        }
-
-        $cachedFile = $this->getCacheFilename($core);
-
-        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($core))) {
-            // 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 Core   $core   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(Core $core, $output)
-    {
-        $cacheDir   = $core->getCacheDir();
-        $cachedFile = $this->getCacheFilename($core);
-
-        // 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 Core $core      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(Core $core, $olderThan = - 1)
-    {
-        $cachedFile = $this->getCacheFilename($core);
-
-        return !file_exists($cachedFile) || (filectime($cachedFile) < (time() - $olderThan) && unlink($cachedFile));
-    }
-
-    /**
-     * Returns the compiled template file name.
-     *
-     * @param Core      $core     the dwoo instance that requests it
-     * @param ICompiler $compiler the compiler that must be used
-     *
-     * @return string
-     */
-    public function getCompiledTemplate(Core $core, ICompiler $compiler = null)
-    {
-        $compiledFile = $this->getCompiledFilename($core);
-
-        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 = $core->getDefaultCompilerFactory($this->getResourceName());
-
-                if ($compiler === null || $compiler === array('Dwoo\Compiler', 'compilerFactory')) {
-                    $compiler = Compiler::compilerFactory();
-                } else {
-                    $compiler = call_user_func($compiler);
-                }
-            }
-
-            $this->compiler = $compiler;
-
-            $compiler->setCustomPlugins($core->getCustomPlugins());
-            $compiler->setSecurityPolicy($core->getSecurityPolicy());
-            $this->makeDirectory(dirname($compiledFile), $core->getCompileDir());
-            file_put_contents($compiledFile, $compiler->compile($core, $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 Core      $core           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 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 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 template from
-     *                                  others, if null it defaults to the filename+bits of the path
-     * @param ITemplate $parentTemplate the template that is requesting a new template object (through an include,
-     *                                  extends or any other plugin) an include, extends or any other plugin)
-     *
-     * @return $this
-     */
-    public static function templateFactory(Core $core, $resourceId, $cacheTime = null, $cacheId = null, $compileId = null, 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 Core $core the dwoo instance that requests the file name
-     *
-     * @return string the full path to the compiled file
-     */
-    protected function getCompiledFilename(Core $core)
-    {
-        // no compile id was provided, set default
-        if ($this->compileId === null) {
-            $this->compileId = $this->name;
-        }
-
-        return $core->getCompileDir() . $this->compileId . '.d' . Core::RELEASE_TAG . '.php';
-    }
-
-    /**
-     * Returns the full cached file name and assigns a default value to it if
-     * required.
-     *
-     * @param Core $core the dwoo instance that requests the file name
-     *
-     * @return string the full path to the cached file
-     */
-    protected function getCacheFilename(Core $core)
-    {
-        // 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($core);
-
-            $this->cacheId = str_replace('../', '__', $this->compileId . strtr($cacheId, '\\%?=!:;' . PATH_SEPARATOR, '/-------'));
-        }
-
-        return $core->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 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;
+
+	/**
+	 * Containing template string.
+	 *
+	 * @var string
+	 */
+	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;
+		$this->name      = hash('md4', $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 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 Core $core the dwoo instance that requests it
+	 *
+	 * @return string|bool
+	 */
+	public function getCachedTemplate(Core $core)
+	{
+		if ($this->cacheTime !== null) {
+			$cacheLength = $this->cacheTime;
+		} else {
+			$cacheLength = $core->getCacheTime();
+		}
+
+		// file is not cacheable
+		if ($cacheLength == 0) {
+			return false;
+		}
+
+		$cachedFile = $this->getCacheFilename($core);
+
+		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($core))) {
+			// 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 Core   $core   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(Core $core, $output)
+	{
+		$cacheDir   = $core->getCacheDir();
+		$cachedFile = $this->getCacheFilename($core);
+
+		// 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 Core $core      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(Core $core, $olderThan = - 1)
+	{
+		$cachedFile = $this->getCacheFilename($core);
+
+		return !file_exists($cachedFile) || (filectime($cachedFile) < (time() - $olderThan) && unlink($cachedFile));
+	}
+
+	/**
+	 * Returns the compiled template file name.
+	 *
+	 * @param Core      $core     the dwoo instance that requests it
+	 * @param ICompiler $compiler the compiler that must be used
+	 *
+	 * @return string
+	 */
+	public function getCompiledTemplate(Core $core, ICompiler $compiler = null)
+	{
+		$compiledFile = $this->getCompiledFilename($core);
+
+		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 = $core->getDefaultCompilerFactory($this->getResourceName());
+
+				if ($compiler === null || $compiler === array('Dwoo\Compiler', 'compilerFactory')) {
+					$compiler = Compiler::compilerFactory();
+				} else {
+					$compiler = call_user_func($compiler);
+				}
+			}
+
+			$this->compiler = $compiler;
+
+			$compiler->setCustomPlugins($core->getCustomPlugins());
+			$compiler->setSecurityPolicy($core->getSecurityPolicy());
+			$this->makeDirectory(dirname($compiledFile), $core->getCompileDir());
+			file_put_contents($compiledFile, $compiler->compile($core, $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 Core      $core           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 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 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 template from
+	 *                                  others, if null it defaults to the filename+bits of the path
+	 * @param ITemplate $parentTemplate the template that is requesting a new template object (through an include,
+	 *                                  extends or any other plugin) an include, extends or any other plugin)
+	 *
+	 * @return $this
+	 */
+	public static function templateFactory(Core $core, $resourceId, $cacheTime = null, $cacheId = null, $compileId = null, 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 Core $core the dwoo instance that requests the file name
+	 *
+	 * @return string the full path to the compiled file
+	 */
+	protected function getCompiledFilename(Core $core)
+	{
+		// no compile id was provided, set default
+		if ($this->compileId === null) {
+			$this->compileId = $this->name;
+		}
+
+		return $core->getCompileDir() . $this->compileId . '.d' . Core::RELEASE_TAG . '.php';
+	}
+
+	/**
+	 * Returns the full cached file name and assigns a default value to it if
+	 * required.
+	 *
+	 * @param Core $core the dwoo instance that requests the file name
+	 *
+	 * @return string the full path to the cached file
+	 */
+	protected function getCacheFilename(Core $core)
+	{
+		// 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($core);
+
+			$this->cacheId = str_replace('../', '__', $this->compileId . strtr($cacheId, '\\%?=!:;' . PATH_SEPARATOR, '/-------'));
+		}
+
+		return $core->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 +13 added lines, -13 removed lines

@@ -124,11 +124,11 @@ 
         $this->cacheTime = $cacheTime;
 
         if ($compileId !== null) {
-            $this->compileId = str_replace('../', '__', strtr($compileId, '\\%?=!:;' . PATH_SEPARATOR, '/-------'));
+            $this->compileId = str_replace('../', '__', strtr($compileId, '\\%?=!:;'.PATH_SEPARATOR, '/-------'));
         }
 
         if ($cacheId !== null) {
-            $this->cacheId = str_replace('../', '__', strtr($cacheId, '\\%?=!:;' . PATH_SEPARATOR, '/-------'));
+            $this->cacheId = str_replace('../', '__', strtr($cacheId, '\\%?=!:;'.PATH_SEPARATOR, '/-------'));
         }
     }
 
@@ -276,7 +276,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($core))) {
+        } elseif ($this->compilationEnforced !== true && file_exists($cachedFile) && ($cacheLength === - 1 || filemtime($cachedFile) > ($_SERVER['REQUEST_TIME']-$cacheLength)) && $this->isValidCompiledFile($this->getCompiledFilename($core))) {
             // cache is still valid and can be loaded
             self::$cache['cached'][$this->cacheId] = true;
 
@@ -304,9 +304,9 @@ 
         // thanks for his help on avoiding concurency issues
         $temp = tempnam($cacheDir, 'temp');
         if (!($file = @fopen($temp, 'wb'))) {
-            $temp = $cacheDir . uniqid('temp');
+            $temp = $cacheDir.uniqid('temp');
             if (!($file = @fopen($temp, 'wb'))) {
-                trigger_error('Error writing temporary file \'' . $temp . '\'', E_USER_WARNING);
+                trigger_error('Error writing temporary file \''.$temp.'\'', E_USER_WARNING);
 
                 return false;
             }
@@ -342,7 +342,7 @@ 
     {
         $cachedFile = $this->getCacheFilename($core);
 
-        return !file_exists($cachedFile) || (filectime($cachedFile) < (time() - $olderThan) && unlink($cachedFile));
+        return !file_exists($cachedFile) || (filectime($cachedFile) < (time()-$olderThan) && unlink($cachedFile));
     }
 
     /**
@@ -449,7 +449,7 @@ 
             $this->compileId = $this->name;
         }
 
-        return $core->getCompileDir() . $this->compileId . '.d' . Core::RELEASE_TAG . '.php';
+        return $core->getCompileDir().$this->compileId.'.d'.Core::RELEASE_TAG.'.php';
     }
 
     /**
@@ -467,17 +467,17 @@ 
             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']);
+                $cacheId = $_SERVER['SCRIPT_FILENAME'].'-'.implode('-', $_SERVER['argv']);
             } else {
                 $cacheId = '';
             }
             // force compiled id generation
             $this->getCompiledFilename($core);
 
-            $this->cacheId = str_replace('../', '__', $this->compileId . strtr($cacheId, '\\%?=!:;' . PATH_SEPARATOR, '/-------'));
+            $this->cacheId = str_replace('../', '__', $this->compileId.strtr($cacheId, '\\%?=!:;'.PATH_SEPARATOR, '/-------'));
         }
 
-        return $core->getCacheDir() . $this->cacheId . '.html';
+        return $core->getCacheDir().$this->cacheId.'.html';
     }
 
     /**
@@ -514,7 +514,7 @@ 
         }
 
         $retries = 3;
-        while ($retries --) {
+        while ($retries--) {
             @mkdir($path, $chmod, true);
             if (is_dir($path)) {
                 break;
@@ -527,9 +527,9 @@ 
             $path    = strtr(str_replace($baseDir, '', $path), '\\', '/');
             $folders = explode('/', trim($path, '/'));
             foreach ($folders as $folder) {
-                $baseDir .= $folder . DIRECTORY_SEPARATOR;
+                $baseDir .= $folder.DIRECTORY_SEPARATOR;
                 if (!chmod($baseDir, $chmod)) {
-                    throw new Exception('Unable to chmod ' . "$baseDir to $chmod: " . print_r(error_get_last(), true));
+                    throw new Exception('Unable to chmod '."$baseDir to $chmod: ".print_r(error_get_last(), true));
                 }
             }
         }

lib/Dwoo/Smarty/Processor/Adapter.php

Indentation +17 added lines, -17 removed lines

@@ -23,23 +23,23 @@
  */
 class Adapter extends Processor
 {
-    public $callback;
+	public $callback;
 
-    /**
-     * @param string $input
-     *
-     * @return mixed
-     */
-    public function process($input)
-    {
-        return call_user_func($this->callback, $input);
-    }
+	/**
+	 * @param string $input
+	 *
+	 * @return mixed
+	 */
+	public function process($input)
+	{
+		return call_user_func($this->callback, $input);
+	}
 
-    /**
-     * @param $callback
-     */
-    public function registerCallback($callback)
-    {
-        $this->callback = $callback;
-    }
+	/**
+	 * @param $callback
+	 */
+	public function registerCallback($callback)
+	{
+		$this->callback = $callback;
+	}
 }
\ No newline at end of file

lib/Dwoo/Compilation/Exception.php

Indentation +28 added lines, -28 removed lines

@@ -26,35 +26,35 @@
  */
 class Exception extends DwooException
 {
-    protected $compiler;
-    protected $template;
+	protected $compiler;
+	protected $template;
 
-    /**
-     * Exception constructor.
-     *
-     * @param DwooCompiler $compiler
-     * @param int          $message
-     */
-    public function __construct(DwooCompiler $compiler, $message)
-    {
-        $this->compiler = $compiler;
-        $this->template = $compiler->getDwoo()->getTemplate();
-        parent::__construct('Compilation error at line ' . $compiler->getLine() . ' in "' . $this->template->getResourceName() . ':' . $this->template->getResourceIdentifier() . '" : ' . $message);
-    }
+	/**
+	 * Exception constructor.
+	 *
+	 * @param DwooCompiler $compiler
+	 * @param int          $message
+	 */
+	public function __construct(DwooCompiler $compiler, $message)
+	{
+		$this->compiler = $compiler;
+		$this->template = $compiler->getDwoo()->getTemplate();
+		parent::__construct('Compilation error at line ' . $compiler->getLine() . ' in "' . $this->template->getResourceName() . ':' . $this->template->getResourceIdentifier() . '" : ' . $message);
+	}
 
-    /**
-     * @return DwooCompiler
-     */
-    public function getCompiler()
-    {
-        return $this->compiler;
-    }
+	/**
+	 * @return DwooCompiler
+	 */
+	public function getCompiler()
+	{
+		return $this->compiler;
+	}
 
-    /**
-     * @return \Dwoo\ITemplate|null
-     */
-    public function getTemplate()
-    {
-        return $this->template;
-    }
+	/**
+	 * @return \Dwoo\ITemplate|null
+	 */
+	public function getTemplate()
+	{
+		return $this->template;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
     {
         $this->compiler = $compiler;
         $this->template = $compiler->getDwoo()->getTemplate();
-        parent::__construct('Compilation error at line ' . $compiler->getLine() . ' in "' . $this->template->getResourceName() . ':' . $this->template->getResourceIdentifier() . '" : ' . $message);
+        parent::__construct('Compilation error at line '.$compiler->getLine().' in "'.$this->template->getResourceName().':'.$this->template->getResourceIdentifier().'" : '.$message);
     }
 
     /**

lib/Dwoo/IPluginProxy.php

Indentation +45 added lines, -45 removed lines

@@ -23,52 +23,52 @@
  */
 interface IPluginProxy
 {
-    /**
-     * Returns true or false to say whether the given plugin is handled by this proxy or not.
-     *
-     * @param string $name the plugin name
-     *
-     * @return bool true if the plugin is known and usable, otherwise false
-     */
-    public function handles($name);
+	/**
+	 * Returns true or false to say whether the given plugin is handled by this proxy or not.
+	 *
+	 * @param string $name the plugin name
+	 *
+	 * @return bool true if the plugin is known and usable, otherwise false
+	 */
+	public function handles($name);
 
-    /**
-     * Returns the code (as a string) to call the plugin
-     * (this will be executed at runtime inside the Dwoo class).
-     *
-     * @param string $name   the plugin name
-     * @param array  $params a parameter array, array key "*" is the rest array
-     *
-     * @return string
-     */
-    public function getCode($name, $params);
+	/**
+	 * Returns the code (as a string) to call the plugin
+	 * (this will be executed at runtime inside the Dwoo class).
+	 *
+	 * @param string $name   the plugin name
+	 * @param array  $params a parameter array, array key "*" is the rest array
+	 *
+	 * @return string
+	 */
+	public function getCode($name, $params);
 
-    /**
-     * Returns a callback to the plugin, this is used with the reflection API to
-     * find out about the plugin's parameter names etc.
-     * should you need a rest array without the possibility to edit the
-     * plugin's code, you can provide a callback to some
-     * other function with the correct parameter signature, i.e. :
-     * <code>
-     * return array($this, "callbackHelper");
-     * // and callbackHelper would be as such:
-     * public function callbackHelper(array $rest=array()){}
-     * </code>
-     *
-     * @param string $name the plugin name
-     *
-     * @return callback
-     */
-    public function getCallback($name);
+	/**
+	 * Returns a callback to the plugin, this is used with the reflection API to
+	 * find out about the plugin's parameter names etc.
+	 * should you need a rest array without the possibility to edit the
+	 * plugin's code, you can provide a callback to some
+	 * other function with the correct parameter signature, i.e. :
+	 * <code>
+	 * return array($this, "callbackHelper");
+	 * // and callbackHelper would be as such:
+	 * public function callbackHelper(array $rest=array()){}
+	 * </code>
+	 *
+	 * @param string $name the plugin name
+	 *
+	 * @return callback
+	 */
+	public function getCallback($name);
 
-    /**
-     * Returns some code that will check if the plugin is loaded and if not load it
-     * this is optional, if your plugins are autoloaded or whatever, just return an
-     * empty string.
-     *
-     * @param string $name the plugin name
-     *
-     * @return string
-     */
-    public function getLoader($name);
+	/**
+	 * Returns some code that will check if the plugin is loaded and if not load it
+	 * this is optional, if your plugins are autoloaded or whatever, just return an
+	 * empty string.
+	 *
+	 * @param string $name the plugin name
+	 *
+	 * @return string
+	 */
+	public function getLoader($name);
 }

lib/Dwoo/ITemplate.php

Indentation +120 added lines, -120 removed lines

@@ -23,137 +23,137 @@
  */
 interface ITemplate
 {
-    /**
-     * Returns the cache duration for this template.
-     * defaults to null if it was not provided
-     *
-     * @return int|null
-     */
-    public function getCacheTime();
+	/**
+	 * Returns the cache duration for this template.
+	 * defaults to null if it was not provided
+	 *
+	 * @return int|null
+	 */
+	public function getCacheTime();
 
-    /**
-     * 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);
+	/**
+	 * 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);
 
-    /**
-     * Returns the cached template output file name, true if it's cache-able but not cached
-     * or false if it's not cached.
-     *
-     * @param Core $dwoo the dwoo instance that requests it
-     *
-     * @return string|bool
-     */
-    public function getCachedTemplate(Core $dwoo);
+	/**
+	 * Returns the cached template output file name, true if it's cache-able but not cached
+	 * or false if it's not cached.
+	 *
+	 * @param Core $dwoo the dwoo instance that requests it
+	 *
+	 * @return string|bool
+	 */
+	public function getCachedTemplate(Core $dwoo);
 
-    /**
-     * Caches the provided output into the cache file.
-     *
-     * @param 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(Core $dwoo, $output);
+	/**
+	 * Caches the provided output into the cache file.
+	 *
+	 * @param 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(Core $dwoo, $output);
 
-    /**
-     * Clears the cached template if it's older than the given time.
-     *
-     * @param 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(Core $dwoo, $olderThan = - 1);
+	/**
+	 * Clears the cached template if it's older than the given time.
+	 *
+	 * @param 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(Core $dwoo, $olderThan = - 1);
 
-    /**
-     * Returns the compiled template file name.
-     *
-     * @param Core      $dwoo     the dwoo instance that requests it
-     * @param ICompiler $compiler the compiler that must be used
-     *
-     * @return string
-     */
-    public function getCompiledTemplate(Core $dwoo, ICompiler $compiler = null);
+	/**
+	 * Returns the compiled template file name.
+	 *
+	 * @param Core      $dwoo     the dwoo instance that requests it
+	 * @param ICompiler $compiler the compiler that must be used
+	 *
+	 * @return string
+	 */
+	public function getCompiledTemplate(Core $dwoo, ICompiler $compiler = null);
 
-    /**
-     * Returns the template name.
-     *
-     * @return string
-     */
-    public function getName();
+	/**
+	 * Returns the template name.
+	 *
+	 * @return string
+	 */
+	public function getName();
 
-    /**
-     * Returns the resource name for this template class.
-     *
-     * @return string
-     */
-    public function getResourceName();
+	/**
+	 * Returns the resource name for this template class.
+	 *
+	 * @return string
+	 */
+	public function getResourceName();
 
-    /**
-     * Returns the resource identifier for this template or false if it has no identifier.
-     *
-     * @return string|false
-     */
-    public function getResourceIdentifier();
+	/**
+	 * Returns the resource identifier for this template or false if it has no identifier.
+	 *
+	 * @return string|false
+	 */
+	public function getResourceIdentifier();
 
-    /**
-     * Returns the template source of this template.
-     *
-     * @return string
-     */
-    public function getSource();
+	/**
+	 * Returns the template source of this template.
+	 *
+	 * @return string
+	 */
+	public function getSource();
 
-    /**
-     * Returns an unique string identifying the current version of this template,
-     * for example a timestamp of the last modified date or a hash of the template source.
-     *
-     * @return string
-     */
-    public function getUid();
+	/**
+	 * Returns an unique string identifying the current version of this template,
+	 * for example a timestamp of the last modified date or a hash of the template source.
+	 *
+	 * @return string
+	 */
+	public function getUid();
 
-    /**
-     * Returns the compiler used by this template, if it was just compiled, or null.
-     *
-     * @return ICompiler
-     */
-    public function getCompiler();
+	/**
+	 * Returns the compiler used by this template, if it was just compiled, or null.
+	 *
+	 * @return ICompiler
+	 */
+	public function getCompiler();
 
-    /**
-     * 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();
+	/**
+	 * 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();
 
-    /**
-     * Returns a new template object from the given resource identifier, null if no include is
-     * possible (resource not found), or false if include is not permitted by this resource type.
-     * this method should also check if $dwoo->getSecurityPolicy() is null or not and do the
-     * necessary permission checks if required, if the security policy prevents the template
-     * generation it should throw a new Security\Exception with a relevant message
-     *
-     * @param mixed     $resourceId     the resource identifier
-     * @param int       $cacheTime      duration of the cache validity for this template, if null it defaults to the
-     *                                  Dwoo instance that will render 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 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 template from
-     *                                  others, if null it defaults to the filename+bits of the path
-     * @param ITemplate $parentTemplate the template that is requesting a new template object (through an include,
-     *                                  extends or any other plugin) an include, extends or any other plugin)
-     *
-     * @return ITemplate|null|false
-     */
-    public static function templateFactory(Core $dwoo, $resourceId, $cacheTime = null, $cacheId = null, $compileId = null, ITemplate $parentTemplate = null);
+	/**
+	 * Returns a new template object from the given resource identifier, null if no include is
+	 * possible (resource not found), or false if include is not permitted by this resource type.
+	 * this method should also check if $dwoo->getSecurityPolicy() is null or not and do the
+	 * necessary permission checks if required, if the security policy prevents the template
+	 * generation it should throw a new Security\Exception with a relevant message
+	 *
+	 * @param mixed     $resourceId     the resource identifier
+	 * @param int       $cacheTime      duration of the cache validity for this template, if null it defaults to the
+	 *                                  Dwoo instance that will render 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 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 template from
+	 *                                  others, if null it defaults to the filename+bits of the path
+	 * @param ITemplate $parentTemplate the template that is requesting a new template object (through an include,
+	 *                                  extends or any other plugin) an include, extends or any other plugin)
+	 *
+	 * @return ITemplate|null|false
+	 */
+	public static function templateFactory(Core $dwoo, $resourceId, $cacheTime = null, $cacheId = null, $compileId = null, ITemplate $parentTemplate = null);
 }

lib/Dwoo/Filter.php

Indentation +24 added lines, -24 removed lines

@@ -23,30 +23,30 @@
  */
 abstract class Filter
 {
-    /**
-     * The dwoo instance that runs this filter.
-     *
-     * @var Core
-     */
-    protected $dwoo;
+	/**
+	 * The dwoo instance that runs this filter.
+	 *
+	 * @var Core
+	 */
+	protected $dwoo;
 
-    /**
-     * Constructor, if you override it, call parent::__construct($dwoo); or assign
-     * the dwoo instance yourself if you need it.
-     *
-     * @param Core $dwoo the dwoo instance that runs this plugin
-     */
-    public function __construct(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 Core $dwoo the dwoo instance that runs this plugin
+	 */
+	public function __construct(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/ILoader.php

Indentation +11 added lines, -11 removed lines

@@ -23,15 +23,15 @@
  */
 interface ILoader
 {
-    /**
-     * Loads a plugin file.
-     * the second parameter is used to avoid permanent rehashing when using php functions,
-     * however this means that if you have add a plugin that overrides a php function you have
-     * to delete the classpath.cache file(s) by hand to force a rehash of the plugins
-     *
-     * @param string $class       the plugin name, without the `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
-     */
-    public function loadPlugin($class, $forceRehash = true);
+	/**
+	 * Loads a plugin file.
+	 * the second parameter is used to avoid permanent rehashing when using php functions,
+	 * however this means that if you have add a plugin that overrides a php function you have
+	 * to delete the classpath.cache file(s) by hand to force a rehash of the plugins
+	 *
+	 * @param string $class       the plugin name, without the `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
+	 */
+	public function loadPlugin($class, $forceRehash = true);
 }

lib/Dwoo/ICompilable.php

Indentation +2 added lines, -2 removed lines

@@ -26,6 +26,6 @@
  */
 interface ICompilable
 {
-    // this replaces the process function
-    //public static function compile(Compiler $compiler, $arg, $arg, ...);
+	// this replaces the process function
+	//public static function compile(Compiler $compiler, $arg, $arg, ...);
 }

lib/Dwoo/Adapters/CakePHP/dwoo.php

Indentation +113 added lines, -113 removed lines

@@ -42,118 +42,118 @@
  */
 class DwooView extends View
 {
-    protected $_sv_template_dir;
-    protected $_sv_layout_dir;
-    protected $_sv_compile_dir;
-    protected $_sv_cache_dir;
-    protected $_sv_compile_id;
-
-    protected $_dwoo;
-
-    public $sv_processedTpl;
+	protected $_sv_template_dir;
+	protected $_sv_layout_dir;
+	protected $_sv_compile_dir;
+	protected $_sv_cache_dir;
+	protected $_sv_compile_id;
+
+	protected $_dwoo;
+
+	public $sv_processedTpl;
 
-    public function __construct(&$controller)
-    {
-        parent::__construct($controller);
-
-        $this->ext = '.tpl';
-
-        $this->_sv_template_dir = array(
-            VIEWS.$this->viewPath.DS.$this->subDir,
-            VIEWS.$this->viewPath,
-            VIEWS,
-        );
-
-        $this->_sv_layout_dir = array(
-            LAYOUTS.$this->subDir,
-            VIEWS,
-        );
-
-        $this->_sv_compile_dir = TMP.'dwoo'.DS.'compile';
-        $this->_sv_cache_dir = TMP.'dwoo'.DS.'cache';
-
-        $this->_dwoo = new Dwoo_Core($this->_sv_compile_dir, $this->_sv_cache_dir);
-
-        $this->_sv_compile_id = $controller->name;
-
-        $this->_dwoo->sv_this = $this;
-        $this->_dwoo->setSecurityPolicy();
-
-        return;
-    }
-
-    /**
-     * changes the template directory.
-     */
-    public function setTemplateDir($path = VIEW)
-    {
-        $old = $this->_sv_template_dir;
-        $this->_sv_template_dir = $path;
-
-        return $old;
-    }
-
-    public function getTemplateDir()
-    {
-        return $this->_sv_template_dir;
-    }
-
-    public function _render($___viewFn, $___data_for_view, $___play_safe = true, $loadHelpers = true)
-    {
-        // let's determine if this is a layout call or a template call
-        // and change the template dir accordingly
-        $layout = false;
-        if (isset($___data_for_view['content_for_layout'])) {
-            $this->_sv_template_dir = $this->_sv_layout_dir;
-            $layout = true;
-        }
-
-        $tpl = new Dwoo_Template_File($___viewFn);
-        $data = $___data_for_view;
-
-        $data['view'] = $this;
-
-        if ($this->helpers != false && $loadHelpers === true) {
-            $loadedHelpers = array();
-            $loadedHelpers = $this->_loadHelpers($loadedHelpers, $this->helpers);
-
-            foreach (array_keys($loadedHelpers) as $helper) {
-                $camelBackedHelper = strtolower(substr($helper, 0, 1)).substr($helper, 1);
-
-                ${$camelBackedHelper} = $loadedHelpers[$helper];
-
-                if (is_array(${$camelBackedHelper}->helpers) && !empty(${$camelBackedHelper}->helpers)) {
-                    $subHelpers = ${$camelBackedHelper}->helpers;
-                    foreach ($subHelpers as $subHelper) {
-                        ${$camelBackedHelper}->{$subHelper} = $loadedHelpers[$subHelper];
-                    }
-                }
-
-                if (isset($this->passedArgs)) {
-                    ${$camelBackedHelper}->passedArgs = $this->passedArgs;
-                }
-
-                $this->loaded[$camelBackedHelper] = ${$camelBackedHelper};
-
-                $data[$camelBackedHelper] = ${$camelBackedHelper};
-            }
-        }
-
-        if ($this->helpers != false && $loadHelpers === true) {
-            foreach ($loadedHelpers as $helper) {
-                if (is_object($helper)) {
-                    if (is_subclass_of($helper, 'Helper') || is_subclass_of($helper, 'helper')) {
-                        $helper->beforeRender();
-                    }
-                }
-            }
-        }
-
-        return $this->_dwoo->get($tpl, $data);
-    }
-
-    public function get()
-    {
-        return $this->_dwoo;
-    }
+	public function __construct(&$controller)
+	{
+		parent::__construct($controller);
+
+		$this->ext = '.tpl';
+
+		$this->_sv_template_dir = array(
+			VIEWS.$this->viewPath.DS.$this->subDir,
+			VIEWS.$this->viewPath,
+			VIEWS,
+		);
+
+		$this->_sv_layout_dir = array(
+			LAYOUTS.$this->subDir,
+			VIEWS,
+		);
+
+		$this->_sv_compile_dir = TMP.'dwoo'.DS.'compile';
+		$this->_sv_cache_dir = TMP.'dwoo'.DS.'cache';
+
+		$this->_dwoo = new Dwoo_Core($this->_sv_compile_dir, $this->_sv_cache_dir);
+
+		$this->_sv_compile_id = $controller->name;
+
+		$this->_dwoo->sv_this = $this;
+		$this->_dwoo->setSecurityPolicy();
+
+		return;
+	}
+
+	/**
+	 * changes the template directory.
+	 */
+	public function setTemplateDir($path = VIEW)
+	{
+		$old = $this->_sv_template_dir;
+		$this->_sv_template_dir = $path;
+
+		return $old;
+	}
+
+	public function getTemplateDir()
+	{
+		return $this->_sv_template_dir;
+	}
+
+	public function _render($___viewFn, $___data_for_view, $___play_safe = true, $loadHelpers = true)
+	{
+		// let's determine if this is a layout call or a template call
+		// and change the template dir accordingly
+		$layout = false;
+		if (isset($___data_for_view['content_for_layout'])) {
+			$this->_sv_template_dir = $this->_sv_layout_dir;
+			$layout = true;
+		}
+
+		$tpl = new Dwoo_Template_File($___viewFn);
+		$data = $___data_for_view;
+
+		$data['view'] = $this;
+
+		if ($this->helpers != false && $loadHelpers === true) {
+			$loadedHelpers = array();
+			$loadedHelpers = $this->_loadHelpers($loadedHelpers, $this->helpers);
+
+			foreach (array_keys($loadedHelpers) as $helper) {
+				$camelBackedHelper = strtolower(substr($helper, 0, 1)).substr($helper, 1);
+
+				${$camelBackedHelper} = $loadedHelpers[$helper];
+
+				if (is_array(${$camelBackedHelper}->helpers) && !empty(${$camelBackedHelper}->helpers)) {
+					$subHelpers = ${$camelBackedHelper}->helpers;
+					foreach ($subHelpers as $subHelper) {
+						${$camelBackedHelper}->{$subHelper} = $loadedHelpers[$subHelper];
+					}
+				}
+
+				if (isset($this->passedArgs)) {
+					${$camelBackedHelper}->passedArgs = $this->passedArgs;
+				}
+
+				$this->loaded[$camelBackedHelper] = ${$camelBackedHelper};
+
+				$data[$camelBackedHelper] = ${$camelBackedHelper};
+			}
+		}
+
+		if ($this->helpers != false && $loadHelpers === true) {
+			foreach ($loadedHelpers as $helper) {
+				if (is_object($helper)) {
+					if (is_subclass_of($helper, 'Helper') || is_subclass_of($helper, 'helper')) {
+						$helper->beforeRender();
+					}
+				}
+			}
+		}
+
+		return $this->_dwoo->get($tpl, $data);
+	}
+
+	public function get()
+	{
+		return $this->_dwoo;
+	}
 }