HTMLPurifier_PropertyList Class Reference

Generic property list implementation. More...

Collaboration diagram for HTMLPurifier_PropertyList:

Public Member Functions
	__construct ($parent=null)
	get ($name)
	Recursively retrieves the value for a key. More...
	set ($name, $value)
	Sets the value of a key, for this plist. More...
	has ($name)
	Returns true if a given key exists. More...
	reset ($name=null)
	Resets a value to the value of it's parent, usually the default. More...
	squash ($force=false)
	Squashes this property list and all of its property lists into a single array, and returns the array. More...
	getParent ()
	Returns the parent plist. More...
	setParent ($plist)
	Sets the parent plist. More...

Protected Attributes
	$data = array()
	Internal data-structure for properties. More...
	$parent
	Parent plist. More...
	$cache
	Cache. More...

Detailed Description

Generic property list implementation.

Definition at line 6 of file PropertyList.php.

Constructor & Destructor Documentation

__construct()

HTMLPurifier_PropertyList::__construct

(

$parent = null

)

Parameters

HTMLPurifier_PropertyList

$parent

Parent plist

Definition at line 29 of file PropertyList.php.

    {
        $this->parent = $parent;
    }

References $parent.

Member Function Documentation

get()

HTMLPurifier_PropertyList::get

(

$name

)

Recursively retrieves the value for a key.

Parameters

string

$name

Exceptions

HTMLPurifier_Exception

Definition at line 39 of file PropertyList.php.

    {
        if ($this->has($name)) {
            return $this->data[$name];
        }
        // possible performance bottleneck, convert to iterative if necessary
        if ($this->parent) {
            return $this->parent->get($name);
        }
        throw new HTMLPurifier_Exception("Key '$name' not found");
    }

References has().

Here is the call graph for this function:

getParent()

HTMLPurifier_PropertyList::getParent

(

)

Returns the parent plist.

Returns

HTMLPurifier_PropertyList

Definition at line 107 of file PropertyList.php.

    {
        return $this->parent;
    }

References $parent.

has()

HTMLPurifier_PropertyList::has

(

$name

)

Returns true if a given key exists.

Parameters

string

$name

Returns

bool

Definition at line 66 of file PropertyList.php.

    {
        return array_key_exists($name, $this->data);
    }

Referenced by get().

Here is the caller graph for this function:

reset()

HTMLPurifier_PropertyList::reset

(

$name = null

)

Resets a value to the value of it's parent, usually the default.

If no value is specified, the entire plist is reset.

Parameters

string

$name

Definition at line 76 of file PropertyList.php.

    {
        if ($name == null) {
            $this->data = array();
        } else {
            unset($this->data[$name]);
        }
    }

set()

HTMLPurifier_PropertyList::set	(		$name,
			$value
	)

Sets the value of a key, for this plist.

Parameters

string	$name
mixed	$value

Definition at line 56 of file PropertyList.php.

    {
        $this->data[$name] = $value;
    }

setParent()

HTMLPurifier_PropertyList::setParent

(

$plist

)

Sets the parent plist.

Parameters

HTMLPurifier_PropertyList

$plist

Parent plist

Definition at line 116 of file PropertyList.php.

    {
        $this->parent = $plist;
    }

squash()

HTMLPurifier_PropertyList::squash

(

$force = false

)

Squashes this property list and all of its property lists into a single array, and returns the array.

This value is cached by default.

Parameters

bool

$force

If true, ignores the cache and regenerates the array.

Returns

array

Definition at line 91 of file PropertyList.php.

    {
        if ($this->cache !== null && !$force) {
            return $this->cache;
        }
        if ($this->parent) {
            return $this->cache = array_merge($this->parent->squash($force), $this->data);
        } else {
            return $this->cache = $this->data;
        }
    }

References $cache, and $data.

Field Documentation

$cache

HTMLPurifier_PropertyList::$cache

protected

Cache.

@type array

Definition at line 24 of file PropertyList.php.

Referenced by squash().

$data

HTMLPurifier_PropertyList::$data = array()

protected

Internal data-structure for properties.

@type array

Definition at line 12 of file PropertyList.php.

Referenced by squash().

$parent

HTMLPurifier_PropertyList::$parent

protected

Parent plist.

@type HTMLPurifier_PropertyList

Definition at line 18 of file PropertyList.php.

Referenced by __construct(), and getParent().

---

The documentation for this class was generated from the following file:

• Services/Html/HtmlPurifier/library/HTMLPurifier/PropertyList.php