diff options
Diffstat (limited to 'library/HTMLPurifier/DefinitionCache/Decorator')
3 files changed, 147 insertions, 38 deletions
diff --git a/library/HTMLPurifier/DefinitionCache/Decorator/Cleanup.php b/library/HTMLPurifier/DefinitionCache/Decorator/Cleanup.php index d4cc35c4b..4991777ce 100644 --- a/library/HTMLPurifier/DefinitionCache/Decorator/Cleanup.php +++ b/library/HTMLPurifier/DefinitionCache/Decorator/Cleanup.php @@ -4,40 +4,75 @@ * Definition cache decorator class that cleans up the cache * whenever there is a cache miss. */ -class HTMLPurifier_DefinitionCache_Decorator_Cleanup extends - HTMLPurifier_DefinitionCache_Decorator +class HTMLPurifier_DefinitionCache_Decorator_Cleanup extends HTMLPurifier_DefinitionCache_Decorator { - + /** + * @type string + */ public $name = 'Cleanup'; - public function copy() { + /** + * @return HTMLPurifier_DefinitionCache_Decorator_Cleanup + */ + public function copy() + { return new HTMLPurifier_DefinitionCache_Decorator_Cleanup(); } - public function add($def, $config) { + /** + * @param HTMLPurifier_Definition $def + * @param HTMLPurifier_Config $config + * @return mixed + */ + public function add($def, $config) + { $status = parent::add($def, $config); - if (!$status) parent::cleanup($config); + if (!$status) { + parent::cleanup($config); + } return $status; } - public function set($def, $config) { + /** + * @param HTMLPurifier_Definition $def + * @param HTMLPurifier_Config $config + * @return mixed + */ + public function set($def, $config) + { $status = parent::set($def, $config); - if (!$status) parent::cleanup($config); + if (!$status) { + parent::cleanup($config); + } return $status; } - public function replace($def, $config) { + /** + * @param HTMLPurifier_Definition $def + * @param HTMLPurifier_Config $config + * @return mixed + */ + public function replace($def, $config) + { $status = parent::replace($def, $config); - if (!$status) parent::cleanup($config); + if (!$status) { + parent::cleanup($config); + } return $status; } - public function get($config) { + /** + * @param HTMLPurifier_Config $config + * @return mixed + */ + public function get($config) + { $ret = parent::get($config); - if (!$ret) parent::cleanup($config); + if (!$ret) { + parent::cleanup($config); + } return $ret; } - } // vim: et sw=4 sts=4 diff --git a/library/HTMLPurifier/DefinitionCache/Decorator/Memory.php b/library/HTMLPurifier/DefinitionCache/Decorator/Memory.php index 18f16d32b..d529dce48 100644 --- a/library/HTMLPurifier/DefinitionCache/Decorator/Memory.php +++ b/library/HTMLPurifier/DefinitionCache/Decorator/Memory.php @@ -5,42 +5,81 @@ * to PHP's memory; good for unit tests or circumstances where * there are lots of configuration objects floating around. */ -class HTMLPurifier_DefinitionCache_Decorator_Memory extends - HTMLPurifier_DefinitionCache_Decorator +class HTMLPurifier_DefinitionCache_Decorator_Memory extends HTMLPurifier_DefinitionCache_Decorator { - + /** + * @type array + */ protected $definitions; + + /** + * @type string + */ public $name = 'Memory'; - public function copy() { + /** + * @return HTMLPurifier_DefinitionCache_Decorator_Memory + */ + public function copy() + { return new HTMLPurifier_DefinitionCache_Decorator_Memory(); } - public function add($def, $config) { + /** + * @param HTMLPurifier_Definition $def + * @param HTMLPurifier_Config $config + * @return mixed + */ + public function add($def, $config) + { $status = parent::add($def, $config); - if ($status) $this->definitions[$this->generateKey($config)] = $def; + if ($status) { + $this->definitions[$this->generateKey($config)] = $def; + } return $status; } - public function set($def, $config) { + /** + * @param HTMLPurifier_Definition $def + * @param HTMLPurifier_Config $config + * @return mixed + */ + public function set($def, $config) + { $status = parent::set($def, $config); - if ($status) $this->definitions[$this->generateKey($config)] = $def; + if ($status) { + $this->definitions[$this->generateKey($config)] = $def; + } return $status; } - public function replace($def, $config) { + /** + * @param HTMLPurifier_Definition $def + * @param HTMLPurifier_Config $config + * @return mixed + */ + public function replace($def, $config) + { $status = parent::replace($def, $config); - if ($status) $this->definitions[$this->generateKey($config)] = $def; + if ($status) { + $this->definitions[$this->generateKey($config)] = $def; + } return $status; } - public function get($config) { + /** + * @param HTMLPurifier_Config $config + * @return mixed + */ + public function get($config) + { $key = $this->generateKey($config); - if (isset($this->definitions[$key])) return $this->definitions[$key]; + if (isset($this->definitions[$key])) { + return $this->definitions[$key]; + } $this->definitions[$key] = parent::get($config); return $this->definitions[$key]; } - } // vim: et sw=4 sts=4 diff --git a/library/HTMLPurifier/DefinitionCache/Decorator/Template.php.in b/library/HTMLPurifier/DefinitionCache/Decorator/Template.php.in index 21a8fcfda..b1fec8d36 100644 --- a/library/HTMLPurifier/DefinitionCache/Decorator/Template.php.in +++ b/library/HTMLPurifier/DefinitionCache/Decorator/Template.php.in @@ -5,43 +5,78 @@ require_once 'HTMLPurifier/DefinitionCache/Decorator.php'; /** * Definition cache decorator template. */ -class HTMLPurifier_DefinitionCache_Decorator_Template extends - HTMLPurifier_DefinitionCache_Decorator +class HTMLPurifier_DefinitionCache_Decorator_Template extends HTMLPurifier_DefinitionCache_Decorator { - var $name = 'Template'; // replace this + /** + * @type string + */ + public $name = 'Template'; // replace this - function copy() { + public function copy() + { // replace class name with yours return new HTMLPurifier_DefinitionCache_Decorator_Template(); } // remove methods you don't need - function add($def, $config) { + /** + * @param HTMLPurifier_Definition $def + * @param HTMLPurifier_Config $config + * @return mixed + */ + public function add($def, $config) + { return parent::add($def, $config); } - function set($def, $config) { + /** + * @param HTMLPurifier_Definition $def + * @param HTMLPurifier_Config $config + * @return mixed + */ + public function set($def, $config) + { return parent::set($def, $config); } - function replace($def, $config) { + /** + * @param HTMLPurifier_Definition $def + * @param HTMLPurifier_Config $config + * @return mixed + */ + public function replace($def, $config) + { return parent::replace($def, $config); } - function get($config) { + /** + * @param HTMLPurifier_Config $config + * @return mixed + */ + public function get($config) + { return parent::get($config); } - function flush() { - return parent::flush(); + /** + * @param HTMLPurifier_Config $config + * @return mixed + */ + public function flush($config) + { + return parent::flush($config); } - function cleanup($config) { + /** + * @param HTMLPurifier_Config $config + * @return mixed + */ + public function cleanup($config) + { return parent::cleanup($config); } - } // vim: et sw=4 sts=4 |