2010-09-09 05:14:17 +02:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Generic property list implementation
|
|
|
|
*/
|
|
|
|
class HTMLPurifier_PropertyList
|
|
|
|
{
|
|
|
|
/**
|
2016-02-09 11:06:17 +01:00
|
|
|
* Internal data-structure for properties.
|
|
|
|
* @type array
|
2010-09-09 05:14:17 +02:00
|
|
|
*/
|
|
|
|
protected $data = array();
|
|
|
|
|
|
|
|
/**
|
2016-02-09 11:06:17 +01:00
|
|
|
* Parent plist.
|
|
|
|
* @type HTMLPurifier_PropertyList
|
2010-09-09 05:14:17 +02:00
|
|
|
*/
|
|
|
|
protected $parent;
|
|
|
|
|
2016-02-09 11:06:17 +01:00
|
|
|
/**
|
|
|
|
* Cache.
|
|
|
|
* @type array
|
|
|
|
*/
|
2010-09-09 05:14:17 +02:00
|
|
|
protected $cache;
|
|
|
|
|
2016-02-09 11:06:17 +01:00
|
|
|
/**
|
|
|
|
* @param HTMLPurifier_PropertyList $parent Parent plist
|
|
|
|
*/
|
|
|
|
public function __construct($parent = null)
|
|
|
|
{
|
2010-09-09 05:14:17 +02:00
|
|
|
$this->parent = $parent;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Recursively retrieves the value for a key
|
2016-02-09 11:06:17 +01:00
|
|
|
* @param string $name
|
|
|
|
* @throws HTMLPurifier_Exception
|
2010-09-09 05:14:17 +02:00
|
|
|
*/
|
2016-02-09 11:06:17 +01:00
|
|
|
public function get($name)
|
|
|
|
{
|
|
|
|
if ($this->has($name)) {
|
|
|
|
return $this->data[$name];
|
|
|
|
}
|
2010-09-09 05:14:17 +02:00
|
|
|
// possible performance bottleneck, convert to iterative if necessary
|
2016-02-09 11:06:17 +01:00
|
|
|
if ($this->parent) {
|
|
|
|
return $this->parent->get($name);
|
|
|
|
}
|
2010-09-09 05:14:17 +02:00
|
|
|
throw new HTMLPurifier_Exception("Key '$name' not found");
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the value of a key, for this plist
|
2016-02-09 11:06:17 +01:00
|
|
|
* @param string $name
|
|
|
|
* @param mixed $value
|
2010-09-09 05:14:17 +02:00
|
|
|
*/
|
2016-02-09 11:06:17 +01:00
|
|
|
public function set($name, $value)
|
|
|
|
{
|
2010-09-09 05:14:17 +02:00
|
|
|
$this->data[$name] = $value;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns true if a given key exists
|
2016-02-09 11:06:17 +01:00
|
|
|
* @param string $name
|
|
|
|
* @return bool
|
2010-09-09 05:14:17 +02:00
|
|
|
*/
|
2016-02-09 11:06:17 +01:00
|
|
|
public function has($name)
|
|
|
|
{
|
2010-09-09 05:14:17 +02:00
|
|
|
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.
|
2016-02-09 11:06:17 +01:00
|
|
|
* @param string $name
|
2010-09-09 05:14:17 +02:00
|
|
|
*/
|
2016-02-09 11:06:17 +01:00
|
|
|
public function reset($name = null)
|
|
|
|
{
|
|
|
|
if ($name == null) {
|
|
|
|
$this->data = array();
|
|
|
|
} else {
|
|
|
|
unset($this->data[$name]);
|
|
|
|
}
|
2010-09-09 05:14:17 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Squashes this property list and all of its property lists into a single
|
|
|
|
* array, and returns the array. This value is cached by default.
|
2016-02-09 11:06:17 +01:00
|
|
|
* @param bool $force If true, ignores the cache and regenerates the array.
|
|
|
|
* @return array
|
2010-09-09 05:14:17 +02:00
|
|
|
*/
|
2016-02-09 11:06:17 +01:00
|
|
|
public function squash($force = false)
|
|
|
|
{
|
|
|
|
if ($this->cache !== null && !$force) {
|
|
|
|
return $this->cache;
|
|
|
|
}
|
2010-09-09 05:14:17 +02:00
|
|
|
if ($this->parent) {
|
|
|
|
return $this->cache = array_merge($this->parent->squash($force), $this->data);
|
|
|
|
} else {
|
|
|
|
return $this->cache = $this->data;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the parent plist.
|
2016-02-09 11:06:17 +01:00
|
|
|
* @return HTMLPurifier_PropertyList
|
2010-09-09 05:14:17 +02:00
|
|
|
*/
|
2016-02-09 11:06:17 +01:00
|
|
|
public function getParent()
|
|
|
|
{
|
2010-09-09 05:14:17 +02:00
|
|
|
return $this->parent;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the parent plist.
|
2016-02-09 11:06:17 +01:00
|
|
|
* @param HTMLPurifier_PropertyList $plist Parent plist
|
2010-09-09 05:14:17 +02:00
|
|
|
*/
|
2016-02-09 11:06:17 +01:00
|
|
|
public function setParent($plist)
|
|
|
|
{
|
2010-09-09 05:14:17 +02:00
|
|
|
$this->parent = $plist;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// vim: et sw=4 sts=4
|