dwoo-project / dwoo

lib/Dwoo/Data.php

Indentation +219 added lines, -219 removed lines

@@ -24,241 +24,241 @@
  */
 class Data implements IDataProvider
 {
-    /**
-     * Data array.
-     *
-     * @var array
-     */
-    protected $data = array();
+	/**
+	 * Data array.
+	 *
+	 * @var array
+	 */
+	protected $data = array();
 
-    /**
-     * Returns the data array.
-     *
-     * @return array
-     */
-    public function getData()
-    {
-        return $this->data;
-    }
+	/**
+	 * Returns the data array.
+	 *
+	 * @return array
+	 */
+	public function getData()
+	{
+		return $this->data;
+	}
 
-    /**
-     * Clears a the entire data or only the given key.
-     *
-     * @param array|string $name clears only one value if you give a name, multiple values if
-     *                           you give an array of names, or the entire data if left null
-     */
-    public function clear($name = null)
-    {
-        if ($name === null) {
-            $this->data = array();
-        } elseif (is_array($name)) {
-            foreach ($name as $index) {
-                unset($this->data[$index]);
-            }
-        } else {
-            unset($this->data[$name]);
-        }
-    }
+	/**
+	 * Clears a the entire data or only the given key.
+	 *
+	 * @param array|string $name clears only one value if you give a name, multiple values if
+	 *                           you give an array of names, or the entire data if left null
+	 */
+	public function clear($name = null)
+	{
+		if ($name === null) {
+			$this->data = array();
+		} elseif (is_array($name)) {
+			foreach ($name as $index) {
+				unset($this->data[$index]);
+			}
+		} else {
+			unset($this->data[$name]);
+		}
+	}
 
-    /**
-     * Overwrites the entire data with the given array.
-     *
-     * @param array $data the new data array to use
-     */
-    public function setData(array $data)
-    {
-        $this->data = $data;
-    }
+	/**
+	 * Overwrites the entire data with the given array.
+	 *
+	 * @param array $data the new data array to use
+	 */
+	public function setData(array $data)
+	{
+		$this->data = $data;
+	}
 
-    /**
-     * merges the given array(s) with the current data with array_merge.
-     *
-     * @param array $data  the array to merge
-     */
-    public function mergeData(array $data)
-    {
-        $args = func_get_args();
-        foreach ($args as $key => $v) {
-            if (is_array($v)) {
-                $this->data = array_merge($this->data, $v);
-            }
-        }
-    }
+	/**
+	 * merges the given array(s) with the current data with array_merge.
+	 *
+	 * @param array $data  the array to merge
+	 */
+	public function mergeData(array $data)
+	{
+		$args = func_get_args();
+		foreach ($args as $key => $v) {
+			if (is_array($v)) {
+				$this->data = array_merge($this->data, $v);
+			}
+		}
+	}
 
-    /**
-     * Assigns a value or an array of values to the data object.
-     *
-     * @param array|string $name an associative array of multiple (index=>value) or a string
-     *                           that is the index to use, i.e. a value assigned to "foo" will be
-     *                           accessible in the template through {$foo}
-     * @param mixed        $val  the value to assign, or null if $name was an array
-     */
-    public function assign($name, $val = null)
-    {
-        if (is_array($name)) {
-            reset($name);
-            foreach ($name as $k => $v){
-                $this->data[$k] = $v;
-            }
-        } else {
-            $this->data[$name] = $val;
-        }
-    }
+	/**
+	 * Assigns a value or an array of values to the data object.
+	 *
+	 * @param array|string $name an associative array of multiple (index=>value) or a string
+	 *                           that is the index to use, i.e. a value assigned to "foo" will be
+	 *                           accessible in the template through {$foo}
+	 * @param mixed        $val  the value to assign, or null if $name was an array
+	 */
+	public function assign($name, $val = null)
+	{
+		if (is_array($name)) {
+			reset($name);
+			foreach ($name as $k => $v){
+				$this->data[$k] = $v;
+			}
+		} else {
+			$this->data[$name] = $val;
+		}
+	}
 
-    /**
-     * Allows to assign variables using the object syntax.
-     *
-     * @param string $name  the variable name
-     * @param string $value the value to assign to it
-     */
-    public function __set($name, $value)
-    {
-        $this->assign($name, $value);
-    }
+	/**
+	 * Allows to assign variables using the object syntax.
+	 *
+	 * @param string $name  the variable name
+	 * @param string $value the value to assign to it
+	 */
+	public function __set($name, $value)
+	{
+		$this->assign($name, $value);
+	}
 
-    /**
-     * Assigns a value by reference to the data object.
-     *
-     * @param string $name the index to use, i.e. a value assigned to "foo" will be
-     *                     accessible in the template through {$foo}
-     * @param mixed  $val  the value to assign by reference
-     */
-    public function assignByRef($name, &$val)
-    {
-        $this->data[$name] = &$val;
-    }
+	/**
+	 * Assigns a value by reference to the data object.
+	 *
+	 * @param string $name the index to use, i.e. a value assigned to "foo" will be
+	 *                     accessible in the template through {$foo}
+	 * @param mixed  $val  the value to assign by reference
+	 */
+	public function assignByRef($name, &$val)
+	{
+		$this->data[$name] = &$val;
+	}
 
-    /**
-     * Appends values or an array of values to the data object.
-     *
-     * @param array|string $name  an associative array of multiple (index=>value) or a string
-     *                            that is the index to use, i.e. a value assigned to "foo" will be
-     *                            accessible in the template through {$foo}
-     * @param mixed        $val   the value to assign, or null if $name was an array
-     * @param bool         $merge true to merge data or false to append, defaults to false
-     */
-    public function append($name, $val = null, $merge = false)
-    {
-        if (is_array($name)) {
-            foreach ($name as $key => $val) {
-                if (isset($this->data[$key]) && !is_array($this->data[$key])) {
-                    settype($this->data[$key], 'array');
-                }
+	/**
+	 * Appends values or an array of values to the data object.
+	 *
+	 * @param array|string $name  an associative array of multiple (index=>value) or a string
+	 *                            that is the index to use, i.e. a value assigned to "foo" will be
+	 *                            accessible in the template through {$foo}
+	 * @param mixed        $val   the value to assign, or null if $name was an array
+	 * @param bool         $merge true to merge data or false to append, defaults to false
+	 */
+	public function append($name, $val = null, $merge = false)
+	{
+		if (is_array($name)) {
+			foreach ($name as $key => $val) {
+				if (isset($this->data[$key]) && !is_array($this->data[$key])) {
+					settype($this->data[$key], 'array');
+				}
 
-                if ($merge === true && is_array($val)) {
-                    $this->data[$key] = $val + $this->data[$key];
-                } else {
-                    $this->data[$key][] = $val;
-                }
-            }
-        } elseif ($val !== null) {
-            if (isset($this->data[$name]) && !is_array($this->data[$name])) {
-                settype($this->data[$name], 'array');
-            } elseif (!isset($this->data[$name])) {
-                $this->data[$name] = array();
-            }
+				if ($merge === true && is_array($val)) {
+					$this->data[$key] = $val + $this->data[$key];
+				} else {
+					$this->data[$key][] = $val;
+				}
+			}
+		} elseif ($val !== null) {
+			if (isset($this->data[$name]) && !is_array($this->data[$name])) {
+				settype($this->data[$name], 'array');
+			} elseif (!isset($this->data[$name])) {
+				$this->data[$name] = array();
+			}
 
-            if ($merge === true && is_array($val)) {
-                $this->data[$name] = $val + $this->data[$name];
-            } else {
-                $this->data[$name][] = $val;
-            }
-        }
-    }
+			if ($merge === true && is_array($val)) {
+				$this->data[$name] = $val + $this->data[$name];
+			} else {
+				$this->data[$name][] = $val;
+			}
+		}
+	}
 
-    /**
-     * Appends a value by reference to the data object.
-     *
-     * @param string $name  the index to use, i.e. a value assigned to "foo" will be
-     *                      accessible in the template through {$foo}
-     * @param mixed  $val   the value to append by reference
-     * @param bool   $merge true to merge data or false to append, defaults to false
-     */
-    public function appendByRef($name, &$val, $merge = false)
-    {
-        if (isset($this->data[$name]) && !is_array($this->data[$name])) {
-            settype($this->data[$name], 'array');
-        }
+	/**
+	 * Appends a value by reference to the data object.
+	 *
+	 * @param string $name  the index to use, i.e. a value assigned to "foo" will be
+	 *                      accessible in the template through {$foo}
+	 * @param mixed  $val   the value to append by reference
+	 * @param bool   $merge true to merge data or false to append, defaults to false
+	 */
+	public function appendByRef($name, &$val, $merge = false)
+	{
+		if (isset($this->data[$name]) && !is_array($this->data[$name])) {
+			settype($this->data[$name], 'array');
+		}
 
-        if ($merge === true && is_array($val)) {
-            foreach ($val as $key => &$value) {
-                $this->data[$name][$key] = &$value;
-            }
-        } else {
-            $this->data[$name][] = &$val;
-        }
-    }
+		if ($merge === true && is_array($val)) {
+			foreach ($val as $key => &$value) {
+				$this->data[$name][$key] = &$value;
+			}
+		} else {
+			$this->data[$name][] = &$val;
+		}
+	}
 
-    /**
-     * Returns true if the variable has been assigned already, false otherwise.
-     *
-     * @param string $name the variable name
-     *
-     * @return bool
-     */
-    public function isAssigned($name)
-    {
-        return isset($this->data[$name]);
-    }
+	/**
+	 * Returns true if the variable has been assigned already, false otherwise.
+	 *
+	 * @param string $name the variable name
+	 *
+	 * @return bool
+	 */
+	public function isAssigned($name)
+	{
+		return isset($this->data[$name]);
+	}
 
-    /**
-     * Supports calls to isset($dwoo->var).
-     *
-     * @param string $name the variable name
-     *
-     * @return bool
-     */
-    public function __isset($name)
-    {
-        return isset($this->data[$name]);
-    }
+	/**
+	 * Supports calls to isset($dwoo->var).
+	 *
+	 * @param string $name the variable name
+	 *
+	 * @return bool
+	 */
+	public function __isset($name)
+	{
+		return isset($this->data[$name]);
+	}
 
-    /**
-     * Unassigns/removes a variable.
-     *
-     * @param string $name the variable name
-     */
-    public function unassign($name)
-    {
-        unset($this->data[$name]);
-    }
+	/**
+	 * Unassigns/removes a variable.
+	 *
+	 * @param string $name the variable name
+	 */
+	public function unassign($name)
+	{
+		unset($this->data[$name]);
+	}
 
-    /**
-     * Supports unsetting variables using the object syntax.
-     *
-     * @param string $name the variable name
-     */
-    public function __unset($name)
-    {
-        unset($this->data[$name]);
-    }
+	/**
+	 * Supports unsetting variables using the object syntax.
+	 *
+	 * @param string $name the variable name
+	 */
+	public function __unset($name)
+	{
+		unset($this->data[$name]);
+	}
 
-    /**
-     * Returns a variable if it was assigned.
-     *
-     * @param string $name the variable name
-     *
-     * @return mixed
-     */
-    public function get($name)
-    {
-        return $this->__get($name);
-    }
+	/**
+	 * Returns a variable if it was assigned.
+	 *
+	 * @param string $name the variable name
+	 *
+	 * @return mixed
+	 */
+	public function get($name)
+	{
+		return $this->__get($name);
+	}
 
-    /**
-     * Allows to read variables using the object syntax.
-     *
-     * @param string $name the variable name
-     *
-     * @return mixed
-     * @throws Exception
-     */
-    public function __get($name)
-    {
-        if (isset($this->data[$name])) {
-            return $this->data[$name];
-        } else {
-            throw new Exception('Tried to read a value that was not assigned yet : "' . $name . '"');
-        }
-    }
+	/**
+	 * Allows to read variables using the object syntax.
+	 *
+	 * @param string $name the variable name
+	 *
+	 * @return mixed
+	 * @throws Exception
+	 */
+	public function __get($name)
+	{
+		if (isset($this->data[$name])) {
+			return $this->data[$name];
+		} else {
+			throw new Exception('Tried to read a value that was not assigned yet : "' . $name . '"');
+		}
+	}
 }

lib/Dwoo/ITemplate.php

Indentation +122 added lines, -122 removed lines

@@ -23,139 +23,139 @@
  */
 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 $core the dwoo instance that requests it
-     *
-     * @return string|bool
-     */
-    public function getCachedTemplate(Core $core);
+	/**
+	 * 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);
 
-    /**
-     * 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);
+	/**
+	 * 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);
 
-    /**
-     * 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);
+	/**
+	 * 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);
 
-    /**
-     * 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);
+	/**
+	 * 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);
 
-    /**
-     * 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 Core      $core
-     * @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|false|null
-     */
-    public static function templateFactory(Core $core, $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 Core      $core
+	 * @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|false|null
+	 */
+	public static function templateFactory(Core $core, $resourceId, $cacheTime = null, $cacheId = null,
+										   $compileId = null, ITemplate $parentTemplate = null);
 }

lib/Dwoo/Plugins/Functions/PluginCapitalize.php

Indentation +23 added lines, -23 removed lines

@@ -29,28 +29,28 @@
  */
 class PluginCapitalize extends Plugin
 {
-    /**
-     * @param string $value
-     * @param bool   $numwords
-     *
-     * @return string
-     */
-    public function process($value, $numwords = false)
-    {
-        if ($numwords || preg_match('#^[^0-9]+$#', $value)) {
-            return mb_convert_case((string)$value, MB_CASE_TITLE, $this->core->getCharset());
-        } else {
-            $bits = explode(' ', (string)$value);
-            $out  = '';
-            foreach ($bits as $k => $v){
-                if (preg_match('#^[^0-9]+$#', $v)) {
-                    $out .= ' ' . mb_convert_case($v, MB_CASE_TITLE, $this->core->getCharset());
-                } else {
-                    $out .= ' ' . $v;
-                }
-            }
+	/**
+	 * @param string $value
+	 * @param bool   $numwords
+	 *
+	 * @return string
+	 */
+	public function process($value, $numwords = false)
+	{
+		if ($numwords || preg_match('#^[^0-9]+$#', $value)) {
+			return mb_convert_case((string)$value, MB_CASE_TITLE, $this->core->getCharset());
+		} else {
+			$bits = explode(' ', (string)$value);
+			$out  = '';
+			foreach ($bits as $k => $v){
+				if (preg_match('#^[^0-9]+$#', $v)) {
+					$out .= ' ' . mb_convert_case($v, MB_CASE_TITLE, $this->core->getCharset());
+				} else {
+					$out .= ' ' . $v;
+				}
+			}
 
-            return substr($out, 1);
-        }
-    }
+			return substr($out, 1);
+		}
+	}
 }

lib/Dwoo/Loader.php

Indentation +145 added lines, -145 removed lines

@@ -23,159 +23,159 @@
  */
 class Loader implements 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;
 
-    /**
-     * Path where builtin plugins are stored.
-     *
-     * @var string
-     */
-    protected $corePluginDir;
+	/**
+	 * Path where builtin plugins are stored.
+	 *
+	 * @var string
+	 */
+	protected $corePluginDir;
 
-    /**
-     * Loader constructor.
-     *
-     * @param $cacheDir
-     */
-    public function __construct($cacheDir)
-    {
-        $this->corePluginDir = __DIR__ . DIRECTORY_SEPARATOR . 'Plugins';
-        $this->cacheDir      = rtrim($cacheDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+	/**
+	 * Loader constructor.
+	 *
+	 * @param $cacheDir
+	 */
+	public function __construct($cacheDir)
+	{
+		$this->corePluginDir = __DIR__ . DIRECTORY_SEPARATOR . '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' . 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' . 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|boolean $cacheFile the file where to store the plugin paths cache, it will be overwritten
-     *
-     * @throws Exception
-     */
-    protected function rebuildClassPathCache($path, $cacheFile)
-    {
-        $tmp = array();
-        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|boolean $cacheFile the file where to store the plugin paths cache, it will be overwritten
+	 *
+	 * @throws Exception
+	 */
+	protected function rebuildClassPathCache($path, $cacheFile)
+	{
+		$tmp = array();
+		if ($cacheFile !== false) {
+			$tmp             = $this->classPath;
+			$this->classPath = array();
+		}
 
-        // iterates over all files/folders
-        foreach (new \DirectoryIterator($path) as $fileInfo) {
-            if (!$fileInfo->isDot()) {
-                if ($fileInfo->isDir()) {
-                    $this->rebuildClassPathCache($fileInfo->getPathname(), false);
-                } else {
-                    $this->classPath[$fileInfo->getBasename('.php')] = $fileInfo->getPathname();
-                }
-            }
-        }
+		// iterates over all files/folders
+		foreach (new \DirectoryIterator($path) as $fileInfo) {
+			if (!$fileInfo->isDot()) {
+				if ($fileInfo->isDir()) {
+					$this->rebuildClassPathCache($fileInfo->getPathname(), false);
+				} else {
+					$this->classPath[$fileInfo->getBasename('.php')] = $fileInfo->getPathname();
+				}
+			}
+		}
 
-        // save in file if it's the first call (not recursed)
-        if ($cacheFile !== false) {
-            if (!file_put_contents($cacheFile, serialize($this->classPath))) {
-                throw new 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 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 `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 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])) || (!isset
-                ($this->classPath[$class . 'Compile']) || !is_readable($this->classPath[$class . 'Compile']))) {
-            if ($forceRehash) {
-                $this->rebuildClassPathCache($this->corePluginDir, $this->cacheDir . 'classpath.cache.d' .
-                    Core::RELEASE_TAG . '.php');
-                foreach ($this->paths as $path => $file) {
-                    $this->rebuildClassPathCache($path, $file);
-                }
-                if (isset($this->classPath[$class])) {
-                    include_once $this->classPath[$class];
-                } elseif (isset($this->classPath[$class . 'Compile'])) {
-                    include_once $this->classPath[$class . 'Compile'];
-                } else {
-                    throw new Exception('Plugin "' . $class . '" can not be found, maybe you forgot to bind it if it\'s a custom plugin ?', E_USER_NOTICE);
-                }
-            } else {
-                throw new Exception('Plugin "' . $class . '" 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 `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 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])) || (!isset
+				($this->classPath[$class . 'Compile']) || !is_readable($this->classPath[$class . 'Compile']))) {
+			if ($forceRehash) {
+				$this->rebuildClassPathCache($this->corePluginDir, $this->cacheDir . 'classpath.cache.d' .
+					Core::RELEASE_TAG . '.php');
+				foreach ($this->paths as $path => $file) {
+					$this->rebuildClassPathCache($path, $file);
+				}
+				if (isset($this->classPath[$class])) {
+					include_once $this->classPath[$class];
+				} elseif (isset($this->classPath[$class . 'Compile'])) {
+					include_once $this->classPath[$class . 'Compile'];
+				} else {
+					throw new Exception('Plugin "' . $class . '" can not be found, maybe you forgot to bind it if it\'s a custom plugin ?', E_USER_NOTICE);
+				}
+			} else {
+				throw new Exception('Plugin "' . $class . '" 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 Exception
-     */
-    public function addDirectory($pluginDirectory)
-    {
-        $pluginDir = realpath($pluginDirectory);
-        if (!$pluginDir) {
-            throw new 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' . 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 Exception
+	 */
+	public function addDirectory($pluginDirectory)
+	{
+		$pluginDir = realpath($pluginDirectory);
+		if (!$pluginDir) {
+			throw new 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' . 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);
+		}
+	}
 }

lib/Dwoo/Template/File.php

Indentation +222 added lines, -222 removed lines

@@ -30,247 +30,247 @@
  */
 class File extends Str
 {
-    /**
-     * Template filename.
-     *
-     * @var string
-     */
-    protected $file;
+	/**
+	 * Template filename.
+	 *
+	 * @var string
+	 */
+	protected $file;
 
-    /**
-     * Include path(s) to look into to find this template.
-     *
-     * @var array
-     */
-    protected $includePath = array();
+	/**
+	 * Include path(s) to look into to find this template.
+	 *
+	 * @var array
+	 */
+	protected $includePath = array();
 
-    /**
-     * Resolved path cache when looking for a file in multiple include paths.
-     * this is reset when the include path is changed
-     *
-     * @var string
-     */
-    protected $resolvedPath = null;
+	/**
+	 * Resolved path cache when looking for a file in multiple include paths.
+	 * this is reset when the include path is changed
+	 *
+	 * @var string
+	 */
+	protected $resolvedPath = null;
 
-    /**
-     * Creates a template from a file.
-     *
-     * @param string $file        the path to the template file, make sure it exists
-     * @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 mixed  $includePath a string for a single path to look into for the given file, or an array of paths
-     */
-    public function __construct($file, $cacheTime = null, $cacheId = null, $compileId = null, $includePath = array())
-    {
-        parent::__construct($file, $cacheTime, $cacheId, $compileId);
-        $this->template = null;
-        $this->file     = $file;
-        $this->name     = basename($file);
-        $this->setIncludePath($includePath);
-        $this->compileId = $this->getResourceIdentifier();
-    }
+	/**
+	 * Creates a template from a file.
+	 *
+	 * @param string $file        the path to the template file, make sure it exists
+	 * @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 mixed  $includePath a string for a single path to look into for the given file, or an array of paths
+	 */
+	public function __construct($file, $cacheTime = null, $cacheId = null, $compileId = null, $includePath = array())
+	{
+		parent::__construct($file, $cacheTime, $cacheId, $compileId);
+		$this->template = null;
+		$this->file     = $file;
+		$this->name     = basename($file);
+		$this->setIncludePath($includePath);
+		$this->compileId = $this->getResourceIdentifier();
+	}
 
-    /**
-     * Sets the include path(s) to where the given template filename must be looked up.
-     *
-     * @param mixed $paths the path to look into, can be string for a single path or an array of paths
-     */
-    public function setIncludePath($paths)
-    {
-        if (is_array($paths) === false) {
-            $paths = array($paths);
-        }
+	/**
+	 * Sets the include path(s) to where the given template filename must be looked up.
+	 *
+	 * @param mixed $paths the path to look into, can be string for a single path or an array of paths
+	 */
+	public function setIncludePath($paths)
+	{
+		if (is_array($paths) === false) {
+			$paths = array($paths);
+		}
 
-        $this->includePath  = $paths;
-        $this->resolvedPath = null;
-    }
+		$this->includePath  = $paths;
+		$this->resolvedPath = null;
+	}
 
-    /**
-     * Return the current include path(s).
-     *
-     * @return array
-     */
-    public function getIncludePath()
-    {
-        return $this->includePath;
-    }
+	/**
+	 * Return the current include path(s).
+	 *
+	 * @return array
+	 */
+	public function getIncludePath()
+	{
+		return $this->includePath;
+	}
 
-    /**
-     * Checks if compiled file is valid (exists and it's the modification is greater or
-     * equal to the modification time of the template file).
-     *
-     * @param string file
-     *
-     * @return bool True cache file existance and it's modification time
-     */
-    protected function isValidCompiledFile($file)
-    {
-        return parent::isValidCompiledFile($file) && (int)$this->getUid() <= filemtime($file);
-    }
+	/**
+	 * Checks if compiled file is valid (exists and it's the modification is greater or
+	 * equal to the modification time of the template file).
+	 *
+	 * @param string file
+	 *
+	 * @return bool True cache file existance and it's modification time
+	 */
+	protected function isValidCompiledFile($file)
+	{
+		return parent::isValidCompiledFile($file) && (int)$this->getUid() <= filemtime($file);
+	}
 
-    /**
-     * Returns the template source of this template.
-     *
-     * @return string
-     */
-    public function getSource()
-    {
-        return file_get_contents($this->getResourceIdentifier());
-    }
+	/**
+	 * Returns the template source of this template.
+	 *
+	 * @return string
+	 */
+	public function getSource()
+	{
+		return file_get_contents($this->getResourceIdentifier());
+	}
 
-    /**
-     * Returns the resource name for this template class.
-     *
-     * @return string
-     */
-    public function getResourceName()
-    {
-        return 'file';
-    }
+	/**
+	 * Returns the resource name for this template class.
+	 *
+	 * @return string
+	 */
+	public function getResourceName()
+	{
+		return 'file';
+	}
 
-    /**
-     * Returns this template's source filename.
-     *
-     * @return string
-     * @throws DwooException
-     */
-    public function getResourceIdentifier()
-    {
-        if ($this->resolvedPath !== null) {
-            return $this->resolvedPath;
-        } elseif (array_filter($this->getIncludePath()) == array()) {
-            return $this->file;
-        } else {
-            foreach ($this->getIncludePath() as $path) {
-                $path = rtrim($path, DIRECTORY_SEPARATOR);
-                if (file_exists($path . DIRECTORY_SEPARATOR . $this->file) === true) {
-                    return $this->resolvedPath = $path . DIRECTORY_SEPARATOR . $this->file;
-                }
-            }
+	/**
+	 * Returns this template's source filename.
+	 *
+	 * @return string
+	 * @throws DwooException
+	 */
+	public function getResourceIdentifier()
+	{
+		if ($this->resolvedPath !== null) {
+			return $this->resolvedPath;
+		} elseif (array_filter($this->getIncludePath()) == array()) {
+			return $this->file;
+		} else {
+			foreach ($this->getIncludePath() as $path) {
+				$path = rtrim($path, DIRECTORY_SEPARATOR);
+				if (file_exists($path . DIRECTORY_SEPARATOR . $this->file) === true) {
+					return $this->resolvedPath = $path . DIRECTORY_SEPARATOR . $this->file;
+				}
+			}
 
-            throw new DwooException('Template "' . $this->file . '" could not be found in any of your include path(s)');
-        }
-    }
+			throw new DwooException('Template "' . $this->file . '" could not be found in any of your include path(s)');
+		}
+	}
 
-    /**
-     * Returns an unique value identifying the current version of this template,
-     * in this case it's the unix timestamp of the last modification.
-     *
-     * @return string
-     */
-    public function getUid()
-    {
-        return (string)filemtime($this->getResourceIdentifier());
-    }
+	/**
+	 * Returns an unique value identifying the current version of this template,
+	 * in this case it's the unix timestamp of the last modification.
+	 *
+	 * @return string
+	 */
+	public function getUid()
+	{
+		return (string)filemtime($this->getResourceIdentifier());
+	}
 
-    /**
-     * Returns a new template object from the given include name, null if no include is
-     * possible (resource not found), or false if include is not permitted by this resource type.
-     *
-     * @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 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 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 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) an include, extends or any other plugin)
-     *
-     * @return TemplateFile|null
-     * @throws DwooException
-     * @throws SecurityException
-     */
-    public static function templateFactory(Core $core, $resourceId, $cacheTime = null, $cacheId = null,
-                                           $compileId = null, ITemplate $parentTemplate = null)
-    {
-        if (DIRECTORY_SEPARATOR === '\\') {
-            $resourceId = str_replace(array("\t", "\n", "\r", "\f", "\v"), array(
-                '\\t',
-                '\\n',
-                '\\r',
-                '\\f',
-                '\\v'
-            ), $resourceId);
-        }
-        $resourceId = strtr($resourceId, '\\', '/');
+	/**
+	 * Returns a new template object from the given include name, null if no include is
+	 * possible (resource not found), or false if include is not permitted by this resource type.
+	 *
+	 * @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 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 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 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) an include, extends or any other plugin)
+	 *
+	 * @return TemplateFile|null
+	 * @throws DwooException
+	 * @throws SecurityException
+	 */
+	public static function templateFactory(Core $core, $resourceId, $cacheTime = null, $cacheId = null,
+										   $compileId = null, ITemplate $parentTemplate = null)
+	{
+		if (DIRECTORY_SEPARATOR === '\\') {
+			$resourceId = str_replace(array("\t", "\n", "\r", "\f", "\v"), array(
+				'\\t',
+				'\\n',
+				'\\r',
+				'\\f',
+				'\\v'
+			), $resourceId);
+		}
+		$resourceId = strtr($resourceId, '\\', '/');
 
-        $includePath = null;
+		$includePath = null;
 
-        if (file_exists($resourceId) === false) {
-            if ($parentTemplate === null) {
-                $parentTemplate = $core->getTemplate();
-            }
-            if ($parentTemplate instanceof self) {
-                if ($includePath = $parentTemplate->getIncludePath()) {
-                    if (strstr($resourceId, '../')) {
-                        throw new DwooException('When using an include path you can not reference a template into a parent directory (using ../)');
-                    }
-                } else {
-                    $resourceId = dirname($parentTemplate->getResourceIdentifier()) . DIRECTORY_SEPARATOR . $resourceId;
-                    if (file_exists($resourceId) === false) {
-                        return null;
-                    }
-                }
-            } else {
-                return null;
-            }
-        }
+		if (file_exists($resourceId) === false) {
+			if ($parentTemplate === null) {
+				$parentTemplate = $core->getTemplate();
+			}
+			if ($parentTemplate instanceof self) {
+				if ($includePath = $parentTemplate->getIncludePath()) {
+					if (strstr($resourceId, '../')) {
+						throw new DwooException('When using an include path you can not reference a template into a parent directory (using ../)');
+					}
+				} else {
+					$resourceId = dirname($parentTemplate->getResourceIdentifier()) . DIRECTORY_SEPARATOR . $resourceId;
+					if (file_exists($resourceId) === false) {
+						return null;
+					}
+				}
+			} else {
+				return null;
+			}
+		}
 
-        if ($policy = $core->getSecurityPolicy()) {
-            while (true) {
-                if (preg_match('{^([a-z]+?)://}i', $resourceId)) {
-                    throw new SecurityException('The security policy prevents you to read files from external sources : <em>' . $resourceId . '</em>.');
-                }
+		if ($policy = $core->getSecurityPolicy()) {
+			while (true) {
+				if (preg_match('{^([a-z]+?)://}i', $resourceId)) {
+					throw new SecurityException('The security policy prevents you to read files from external sources : <em>' . $resourceId . '</em>.');
+				}
 
-                if ($includePath) {
-                    break;
-                }
+				if ($includePath) {
+					break;
+				}
 
-                $resourceId = realpath($resourceId);
-                $dirs       = $policy->getAllowedDirectories();
-                foreach ($dirs as $dir => $dummy) {
-                    if (strpos($resourceId, $dir) === 0) {
-                        break 2;
-                    }
-                }
-                throw new SecurityException('The security policy prevents you to read <em>' . $resourceId . '</em>');
-            }
-        }
+				$resourceId = realpath($resourceId);
+				$dirs       = $policy->getAllowedDirectories();
+				foreach ($dirs as $dir => $dummy) {
+					if (strpos($resourceId, $dir) === 0) {
+						break 2;
+					}
+				}
+				throw new SecurityException('The security policy prevents you to read <em>' . $resourceId . '</em>');
+			}
+		}
 
-        $class = 'Dwoo\Template\File';
-        if ($parentTemplate) {
-            $class = get_class($parentTemplate);
-        }
+		$class = 'Dwoo\Template\File';
+		if ($parentTemplate) {
+			$class = get_class($parentTemplate);
+		}
 
-        return new $class($resourceId, $cacheTime, $cacheId, $compileId, $includePath);
-    }
+		return new $class($resourceId, $cacheTime, $cacheId, $compileId, $includePath);
+	}
 
-    /**
-     * 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 '"' . $this->getUid() . '" == filemtime(' . var_export($this->getResourceIdentifier(), true) . ')';
-    }
+	/**
+	 * 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 '"' . $this->getUid() . '" == filemtime(' . var_export($this->getResourceIdentifier(), true) . ')';
+	}
 }

lib/Dwoo/Template/Str.php

Indentation +503 added lines, -503 removed lines

@@ -29,507 +29,507 @@
  */
 class Str 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, '/-------'));
-        } else {
-            $this->compileId = $templateString;
-        }
-
-        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)
-    {
-        $cacheLength = $core->getCacheTime();
-        if ($this->cacheTime !== null) {
-            $cacheLength = $this->cacheTime;
-        }
-
-        // 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;
-        }
-
-        // 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 existence
-     */
-    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 Core instance that requests the file name
-     *
-     * @return string the full path to the compiled file
-     */
-    protected function getCompiledFilename(Core $core)
-    {
-        return $core->getCompileDir() . hash('md4', $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, '/-------'));
+		} else {
+			$this->compileId = $templateString;
+		}
+
+		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)
+	{
+		$cacheLength = $core->getCacheTime();
+		if ($this->cacheTime !== null) {
+			$cacheLength = $this->cacheTime;
+		}
+
+		// 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;
+		}
+
+		// 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 existence
+	 */
+	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 Core instance that requests the file name
+	 *
+	 * @return string the full path to the compiled file
+	 */
+	protected function getCompiledFilename(Core $core)
+	{
+		return $core->getCompileDir() . hash('md4', $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));
+				}
+			}
+		}
+	}
 }

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->getCore()->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->getCore()->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;
+	}
 }

lib/Dwoo/Plugins/Functions/PluginExtends.php

Indentation +155 added lines, -155 removed lines

@@ -34,28 +34,28 @@ 
  */
 class PluginExtends extends Plugin implements ICompilable
 {
-    protected static $childSource;
-    protected static $regex;
-    protected static $l;
-    protected static $r;
-    protected static $lastReplacement;
-
-    public function process()
-    {
-    }
-
-    /**
-     * @param Compiler $compiler
-     * @param          $file
-     *
-     * @throws CompilationException
-     */
-    public static function compile(Compiler $compiler, $file)
-    {
-        list($l, $r) = $compiler->getDelimiters();
-        self::$l     = preg_quote($l, '/');
-        self::$r     = preg_quote($r, '/');
-        self::$regex = '/
+	protected static $childSource;
+	protected static $regex;
+	protected static $l;
+	protected static $r;
+	protected static $lastReplacement;
+
+	public function process()
+	{
+	}
+
+	/**
+	 * @param Compiler $compiler
+	 * @param          $file
+	 *
+	 * @throws CompilationException
+	 */
+	public static function compile(Compiler $compiler, $file)
+	{
+		list($l, $r) = $compiler->getDelimiters();
+		self::$l     = preg_quote($l, '/');
+		self::$r     = preg_quote($r, '/');
+		self::$regex = '/
 			' . self::$l . 'block\s(["\']?)(.+?)\1' . self::$r . '(?:\r?\n?)
 			((?:
 				(?R)
@@ -70,137 +70,137 @@ 
 			' . self::$l . '\/block' . self::$r . '
 			/six';
 
-        if ($compiler->getLooseOpeningHandling()) {
-            self::$l .= '\s*';
-            self::$r = '\s*' . self::$r;
-        }
-        $inheritanceTree = array(array('source' => $compiler->getTemplateSource()));
-        $curPath         = dirname($compiler->getCore()->getTemplate()->getResourceIdentifier()) . DIRECTORY_SEPARATOR;
-        $curTpl          = $compiler->getCore()->getTemplate();
-
-        while (!empty($file)) {
-            if ($file === '""' || $file === "''" || (substr($file, 0, 1) !== '"' && substr($file, 0, 1) !== '\'')) {
-                throw new CompilationException($compiler, 'Extends : The file name must be a non-empty string');
-            }
-
-            if (preg_match('#^["\']([a-z]{2,}):(.*?)["\']$#i', $file, $m)) {
-                // resource:identifier given, extract them
-                $resource   = $m[1];
-                $identifier = $m[2];
-            } else {
-                // get the current template's resource
-                $resource   = $curTpl->getResourceName();
-                $identifier = substr($file, 1, - 1);
-            }
-
-            try {
-                $parent = $compiler->getCore()->templateFactory($resource, $identifier, null, null, null, $curTpl);
-            }
-            catch (SecurityException $e) {
-                throw new CompilationException($compiler, 'Extends : Security restriction : ' . $e->getMessage());
-            }
-            catch (Exception $e) {
-                throw new CompilationException($compiler, 'Extends : ' . $e->getMessage());
-            }
-
-            if ($parent === null) {
-                throw new CompilationException($compiler, 'Extends : Resource "' . $resource . ':' . $identifier . '" not found.');
-            } elseif ($parent === false) {
-                throw new CompilationException($compiler, 'Extends : Resource "' . $resource . '" does not support extends.');
-            }
-
-            $curTpl    = $parent;
-            $newParent = array(
-                'source'     => $parent->getSource(),
-                'resource'   => $resource,
-                'identifier' => $parent->getResourceIdentifier(),
-                'uid'        => $parent->getUid()
-            );
-            if (array_search($newParent, $inheritanceTree, true) !== false) {
-                throw new CompilationException($compiler, 'Extends : Recursive template inheritance detected');
-            }
-            $inheritanceTree[] = $newParent;
-
-            if (preg_match('/^' . self::$l . 'extends(?:\(?\s*|\s+)(?:file=)?\s*((["\']).+?\2|\S+?)\s*\)?\s*?' . self::$r . '/i', $parent->getSource(), $match)) {
-                $curPath = dirname($identifier) . DIRECTORY_SEPARATOR;
-                if (isset($match[2]) && $match[2] == '"') {
-                    $file = '"' . str_replace('"', '\\"', substr($match[1], 1, - 1)) . '"';
-                } elseif (isset($match[2]) && $match[2] == "'") {
-                    $file = '"' . substr($match[1], 1, - 1) . '"';
-                } else {
-                    $file = '"' . $match[1] . '"';
-                }
-            } else {
-                $file = false;
-            }
-        }
-
-        while (true) {
-            $parent                = array_pop($inheritanceTree);
-            $child                 = end($inheritanceTree);
-            self::$childSource     = $child['source'];
-            self::$lastReplacement = count($inheritanceTree) === 1;
-            if (!isset($newSource)) {
-                $newSource = $parent['source'];
-            }
-            $newSource = preg_replace_callback(self::$regex, array(
-                'Dwoo\Plugins\Functions\PluginExtends',
-                'replaceBlock'
-            ), $newSource);
-            $newSource = $l . 'do extendsCheck(' . var_export($parent['resource'] . ':' . $parent['identifier'], true) . ')' . $r . $newSource;
-
-            if (self::$lastReplacement) {
-                break;
-            }
-        }
-        $compiler->setTemplateSource($newSource);
-        $compiler->recompile();
-    }
-
-    /**
-     * @param array $matches
-     *
-     * @return mixed|string
-     */
-    protected static function replaceBlock(array $matches)
-    {
-        $matches[3] = self::removeTrailingNewline($matches[3]);
-
-        if (preg_match_all(self::$regex, self::$childSource, $override) && in_array($matches[2], $override[2])) {
-            $key      = array_search($matches[2], $override[2]);
-            $override = self::removeTrailingNewline($override[3][$key]);
-
-            $l = stripslashes(self::$l);
-            $r = stripslashes(self::$r);
-
-            if (self::$lastReplacement) {
-                return preg_replace('/' . self::$l . '\$dwoo\.parent' . self::$r . '/is', $matches[3], $override);
-            }
-
-            return $l . 'block ' . $matches[1] . $matches[2] . $matches[1] . $r . preg_replace('/' . self::$l . '\$dwoo\.parent' . self::$r . '/is', $matches[3], $override) . $l . '/block' . $r;
-        }
-
-        if (preg_match(self::$regex, $matches[3])) {
-            return preg_replace_callback(self::$regex, array(
-                'Dwoo\Plugins\Functions\PluginExtends',
-                'replaceBlock'
-            ), $matches[3]);
-        }
-
-        if (self::$lastReplacement) {
-            return $matches[3];
-        }
-
-        return $matches[0];
-    }
-
-    /**
-     * @param $text
-     *
-     * @return string
-     */
-    protected static function removeTrailingNewline($text)
-    {
-        return substr($text, - 1) === "\n" ? substr($text, - 2, 1) === "\r" ? substr($text, 0, - 2) : substr($text, 0, - 1) : $text;
-    }
+		if ($compiler->getLooseOpeningHandling()) {
+			self::$l .= '\s*';
+			self::$r = '\s*' . self::$r;
+		}
+		$inheritanceTree = array(array('source' => $compiler->getTemplateSource()));
+		$curPath         = dirname($compiler->getCore()->getTemplate()->getResourceIdentifier()) . DIRECTORY_SEPARATOR;
+		$curTpl          = $compiler->getCore()->getTemplate();
+
+		while (!empty($file)) {
+			if ($file === '""' || $file === "''" || (substr($file, 0, 1) !== '"' && substr($file, 0, 1) !== '\'')) {
+				throw new CompilationException($compiler, 'Extends : The file name must be a non-empty string');
+			}
+
+			if (preg_match('#^["\']([a-z]{2,}):(.*?)["\']$#i', $file, $m)) {
+				// resource:identifier given, extract them
+				$resource   = $m[1];
+				$identifier = $m[2];
+			} else {
+				// get the current template's resource
+				$resource   = $curTpl->getResourceName();
+				$identifier = substr($file, 1, - 1);
+			}
+
+			try {
+				$parent = $compiler->getCore()->templateFactory($resource, $identifier, null, null, null, $curTpl);
+			}
+			catch (SecurityException $e) {
+				throw new CompilationException($compiler, 'Extends : Security restriction : ' . $e->getMessage());
+			}
+			catch (Exception $e) {
+				throw new CompilationException($compiler, 'Extends : ' . $e->getMessage());
+			}
+
+			if ($parent === null) {
+				throw new CompilationException($compiler, 'Extends : Resource "' . $resource . ':' . $identifier . '" not found.');
+			} elseif ($parent === false) {
+				throw new CompilationException($compiler, 'Extends : Resource "' . $resource . '" does not support extends.');
+			}
+
+			$curTpl    = $parent;
+			$newParent = array(
+				'source'     => $parent->getSource(),
+				'resource'   => $resource,
+				'identifier' => $parent->getResourceIdentifier(),
+				'uid'        => $parent->getUid()
+			);
+			if (array_search($newParent, $inheritanceTree, true) !== false) {
+				throw new CompilationException($compiler, 'Extends : Recursive template inheritance detected');
+			}
+			$inheritanceTree[] = $newParent;
+
+			if (preg_match('/^' . self::$l . 'extends(?:\(?\s*|\s+)(?:file=)?\s*((["\']).+?\2|\S+?)\s*\)?\s*?' . self::$r . '/i', $parent->getSource(), $match)) {
+				$curPath = dirname($identifier) . DIRECTORY_SEPARATOR;
+				if (isset($match[2]) && $match[2] == '"') {
+					$file = '"' . str_replace('"', '\\"', substr($match[1], 1, - 1)) . '"';
+				} elseif (isset($match[2]) && $match[2] == "'") {
+					$file = '"' . substr($match[1], 1, - 1) . '"';
+				} else {
+					$file = '"' . $match[1] . '"';
+				}
+			} else {
+				$file = false;
+			}
+		}
+
+		while (true) {
+			$parent                = array_pop($inheritanceTree);
+			$child                 = end($inheritanceTree);
+			self::$childSource     = $child['source'];
+			self::$lastReplacement = count($inheritanceTree) === 1;
+			if (!isset($newSource)) {
+				$newSource = $parent['source'];
+			}
+			$newSource = preg_replace_callback(self::$regex, array(
+				'Dwoo\Plugins\Functions\PluginExtends',
+				'replaceBlock'
+			), $newSource);
+			$newSource = $l . 'do extendsCheck(' . var_export($parent['resource'] . ':' . $parent['identifier'], true) . ')' . $r . $newSource;
+
+			if (self::$lastReplacement) {
+				break;
+			}
+		}
+		$compiler->setTemplateSource($newSource);
+		$compiler->recompile();
+	}
+
+	/**
+	 * @param array $matches
+	 *
+	 * @return mixed|string
+	 */
+	protected static function replaceBlock(array $matches)
+	{
+		$matches[3] = self::removeTrailingNewline($matches[3]);
+
+		if (preg_match_all(self::$regex, self::$childSource, $override) && in_array($matches[2], $override[2])) {
+			$key      = array_search($matches[2], $override[2]);
+			$override = self::removeTrailingNewline($override[3][$key]);
+
+			$l = stripslashes(self::$l);
+			$r = stripslashes(self::$r);
+
+			if (self::$lastReplacement) {
+				return preg_replace('/' . self::$l . '\$dwoo\.parent' . self::$r . '/is', $matches[3], $override);
+			}
+
+			return $l . 'block ' . $matches[1] . $matches[2] . $matches[1] . $r . preg_replace('/' . self::$l . '\$dwoo\.parent' . self::$r . '/is', $matches[3], $override) . $l . '/block' . $r;
+		}
+
+		if (preg_match(self::$regex, $matches[3])) {
+			return preg_replace_callback(self::$regex, array(
+				'Dwoo\Plugins\Functions\PluginExtends',
+				'replaceBlock'
+			), $matches[3]);
+		}
+
+		if (self::$lastReplacement) {
+			return $matches[3];
+		}
+
+		return $matches[0];
+	}
+
+	/**
+	 * @param $text
+	 *
+	 * @return string
+	 */
+	protected static function removeTrailingNewline($text)
+	{
+		return substr($text, - 1) === "\n" ? substr($text, - 2, 1) === "\r" ? substr($text, 0, - 2) : substr($text, 0, - 1) : $text;
+	}
 }

lib/Dwoo/Plugins/Functions/PluginExtendsCheck.php

Indentation +29 added lines, -29 removed lines

@@ -28,37 +28,37 @@ 
  */
 class PluginExtendsCheck extends Plugin implements ICompilable
 {
-    /**
-     * @param Compiler $compiler
-     * @param          $file
-     *
-     * @return string
-     * @throws CompilationException
-     */
-    public static function compile(Compiler $compiler, $file)
-    {
-        preg_match('#^["\']([a-z]{2,}):(.*?)["\']$#i', $file, $m);
-        $resource   = $m[1];
-        $identifier = $m[2];
+	/**
+	 * @param Compiler $compiler
+	 * @param          $file
+	 *
+	 * @return string
+	 * @throws CompilationException
+	 */
+	public static function compile(Compiler $compiler, $file)
+	{
+		preg_match('#^["\']([a-z]{2,}):(.*?)["\']$#i', $file, $m);
+		$resource   = $m[1];
+		$identifier = $m[2];
 
-        $tpl = $compiler->getCore()->templateFactory($resource, $identifier);
+		$tpl = $compiler->getCore()->templateFactory($resource, $identifier);
 
-        if ($tpl === null) {
-            throw new CompilationException($compiler,
-                'Load Templates : Resource "' . $resource . ':' . $identifier . '" not found.');
-        } elseif ($tpl === false) {
-            throw new CompilationException($compiler,
-                'Load Templates : Resource "' . $resource . '" does not support includes.');
-        }
+		if ($tpl === null) {
+			throw new CompilationException($compiler,
+				'Load Templates : Resource "' . $resource . ':' . $identifier . '" not found.');
+		} elseif ($tpl === false) {
+			throw new CompilationException($compiler,
+				'Load Templates : Resource "' . $resource . '" does not support includes.');
+		}
 
-        $out = '\'\';// checking for modification in ' . $resource . ':' . $identifier . "\r\n";
+		$out = '\'\';// checking for modification in ' . $resource . ':' . $identifier . "\r\n";
 
-        $modCheck = $tpl->getIsModifiedCode();
+		$modCheck = $tpl->getIsModifiedCode();
 
-        if ($modCheck) {
-            $out .= 'if (!(' . $modCheck . ')) { ob_end_clean(); return false; }';
-        } else {
-            $out .= 'try {
+		if ($modCheck) {
+			$out .= 'if (!(' . $modCheck . ')) { ob_end_clean(); return false; }';
+		} else {
+			$out .= 'try {
 	$tpl = $this->templateFactory("' . $resource . '", "' . $identifier . '");
 } catch (Dwoo\Exception $e) {
 	$this->triggerError(\'Load Templates : Resource <em>' . $resource . '</em> was not added to Dwoo, can not extend <em>' . $identifier . '</em>\', E_USER_WARNING);
@@ -68,8 +68,8 @@ 
 elseif ($tpl === false)
 	$this->triggerError(\'Load Templates : Resource "' . $resource . '" does not support extends.\', E_USER_WARNING);
 if ($tpl->getUid() != "' . $tpl->getUid() . '") { ob_end_clean(); return false; }';
-        }
+		}
 
-        return $out;
-    }
+		return $out;
+	}
 }
\ No newline at end of file