1
0
mirror of https://github.com/ezyang/htmlpurifier.git synced 2025-07-31 19:30:21 +02:00

PSR-2 reformatting PHPDoc corrections

With minor corrections.

Signed-off-by: Marcus Bointon <marcus@synchromedia.co.uk>
Signed-off-by: Edward Z. Yang <ezyang@mit.edu>
This commit is contained in:
Marcus Bointon
2013-07-16 13:56:14 +02:00
committed by Edward Z. Yang
parent 19eee14899
commit fac747bdbd
433 changed files with 13302 additions and 6690 deletions

View File

@@ -6,61 +6,93 @@
class HTMLPurifier_PropertyList
{
/**
* Internal data-structure for properties
* Internal data-structure for properties.
* @type array
*/
protected $data = array();
/**
* Parent plist
* Parent plist.
* @type HTMLPurifier_PropertyList
*/
protected $parent;
/**
* Cache.
* @type array
*/
protected $cache;
public function __construct($parent = null) {
/**
* @param HTMLPurifier_PropertyList $parent Parent plist
*/
public function __construct($parent = null)
{
$this->parent = $parent;
}
/**
* Recursively retrieves the value for a key
* @param string $name
* @throws HTMLPurifier_Exception
*/
public function get($name) {
if ($this->has($name)) return $this->data[$name];
public function get($name)
{
if ($this->has($name)) {
return $this->data[$name];
}
// possible performance bottleneck, convert to iterative if necessary
if ($this->parent) return $this->parent->get($name);
if ($this->parent) {
return $this->parent->get($name);
}
throw new HTMLPurifier_Exception("Key '$name' not found");
}
/**
* Sets the value of a key, for this plist
* @param string $name
* @param mixed $value
*/
public function set($name, $value) {
public function set($name, $value)
{
$this->data[$name] = $value;
}
/**
* Returns true if a given key exists
* @param string $name
* @return bool
*/
public function has($name) {
public function has($name)
{
return array_key_exists($name, $this->data);
}
/**
* Resets a value to the value of it's parent, usually the default. If
* no value is specified, the entire plist is reset.
* @param string $name
*/
public function reset($name = null) {
if ($name == null) $this->data = array();
else unset($this->data[$name]);
public function reset($name = null)
{
if ($name == null) {
$this->data = array();
} else {
unset($this->data[$name]);
}
}
/**
* Squashes this property list and all of its property lists into a single
* array, and returns the array. This value is cached by default.
* @param $force If true, ignores the cache and regenerates the array.
* @param bool $force If true, ignores the cache and regenerates the array.
* @return array
*/
public function squash($force = false) {
if ($this->cache !== null && !$force) return $this->cache;
public function squash($force = false)
{
if ($this->cache !== null && !$force) {
return $this->cache;
}
if ($this->parent) {
return $this->cache = array_merge($this->parent->squash($force), $this->data);
} else {
@@ -70,15 +102,19 @@ class HTMLPurifier_PropertyList
/**
* Returns the parent plist.
* @return HTMLPurifier_PropertyList
*/
public function getParent() {
public function getParent()
{
return $this->parent;
}
/**
* Sets the parent plist.
* @param HTMLPurifier_PropertyList $plist Parent plist
*/
public function setParent($plist) {
public function setParent($plist)
{
$this->parent = $plist;
}
}