PSR-2 reformatting PHPDoc corrections
[htmlpurifier.git] / library / HTMLPurifier / DefinitionCache / Decorator.php
blobb57a51b6cb828741dd823780474bc622b64c025f
1 <?php
3 class HTMLPurifier_DefinitionCache_Decorator extends HTMLPurifier_DefinitionCache
6 /**
7 * Cache object we are decorating
8 * @type HTMLPurifier_DefinitionCache
9 */
10 public $cache;
12 /**
13 * The name of the decorator
14 * @var string
16 public $name;
18 public function __construct()
22 /**
23 * Lazy decorator function
24 * @param HTMLPurifier_DefinitionCache $cache Reference to cache object to decorate
25 * @return HTMLPurifier_DefinitionCache_Decorator
27 public function decorate(&$cache)
29 $decorator = $this->copy();
30 // reference is necessary for mocks in PHP 4
31 $decorator->cache =& $cache;
32 $decorator->type = $cache->type;
33 return $decorator;
36 /**
37 * Cross-compatible clone substitute
38 * @return HTMLPurifier_DefinitionCache_Decorator
40 public function copy()
42 return new HTMLPurifier_DefinitionCache_Decorator();
45 /**
46 * @param HTMLPurifier_Definition $def
47 * @param HTMLPurifier_Config $config
48 * @return mixed
50 public function add($def, $config)
52 return $this->cache->add($def, $config);
55 /**
56 * @param HTMLPurifier_Definition $def
57 * @param HTMLPurifier_Config $config
58 * @return mixed
60 public function set($def, $config)
62 return $this->cache->set($def, $config);
65 /**
66 * @param HTMLPurifier_Definition $def
67 * @param HTMLPurifier_Config $config
68 * @return mixed
70 public function replace($def, $config)
72 return $this->cache->replace($def, $config);
75 /**
76 * @param HTMLPurifier_Config $config
77 * @return mixed
79 public function get($config)
81 return $this->cache->get($config);
84 /**
85 * @param HTMLPurifier_Config $config
86 * @return mixed
88 public function remove($config)
90 return $this->cache->remove($config);
93 /**
94 * @param HTMLPurifier_Config $config
95 * @return mixed
97 public function flush($config)
99 return $this->cache->flush($config);
103 * @param HTMLPurifier_Config $config
104 * @return mixed
106 public function cleanup($config)
108 return $this->cache->cleanup($config);
112 // vim: et sw=4 sts=4