1
0
mirror of https://github.com/ezyang/htmlpurifier.git synced 2025-08-05 05:37:49 +02:00

A bunch of PHPdoc and php codesniffer corrections - no functional code changes

This commit is contained in:
Synchro
2013-07-16 14:20:01 +02:00
committed by Edward Z. Yang
parent 75bd7abcc7
commit 29a3c70370
4 changed files with 394 additions and 158 deletions

View File

@@ -8,19 +8,26 @@ class HTMLPurifier_DefinitionCacheFactory
protected $caches = array('Serializer' => array());
protected $implementations = array();
/**
* @var HTMLPurifier_DefinitionCache_Decorator[]
*/
protected $decorators = array();
/**
* Initialize default decorators
*/
public function setup() {
public function setup()
{
$this->addDecorator('Cleanup');
}
/**
* Retrieves an instance of global definition cache factory.
*
* @return HTMLPurifier_DefinitionCacheFactory
*/
public static function instance($prototype = null) {
public static function instance($prototype = null)
{
static $instance;
if ($prototype !== null) {
$instance = $prototype;
@@ -33,19 +40,22 @@ class HTMLPurifier_DefinitionCacheFactory
/**
* Registers a new definition cache object
* @param $short Short name of cache object, for reference
* @param $long Full class name of cache object, for construction
* @param string $short Short name of cache object, for reference
* @param string $long Full class name of cache object, for construction
*/
public function register($short, $long) {
public function register($short, $long)
{
$this->implementations[$short] = $long;
}
/**
* Factory method that creates a cache object based on configuration
* @param $name Name of definitions handled by cache
* @param $config Instance of HTMLPurifier_Config
*
* @param string $name Name of definitions handled by cache
* @param HTMLPurifier_Config $config Config instance
*/
public function create($type, $config) {
public function create($type, $config)
{
$method = $config->get('Cache.DefinitionImpl');
if ($method === null) {
return new HTMLPurifier_DefinitionCache_Null($type);
@@ -76,9 +86,10 @@ class HTMLPurifier_DefinitionCacheFactory
/**
* Registers a decorator to add to all new cache objects
* @param
* @param HTMLPurifier_DefinitionCache_Decorator|string $decorator An instance or the name of a decorator
*/
public function addDecorator($decorator) {
public function addDecorator($decorator)
{
if (is_string($decorator)) {
$class = "HTMLPurifier_DefinitionCache_Decorator_$decorator";
$decorator = new $class;