HTMLPurifier_PropertyList Class Reference

Public Member Functions
	__construct ($parent=null)
	get ($name)
	set ($name, $value)
	has ($name)
	reset ($name=null)
	squash ($force=false)
	getParent ()
	setParent ($plist)

Protected Attributes
	$data = array()
	$parent
	$cache

Detailed Description

Generic property list implementation

Definition at line 8173 of file HTMLPurifier.standalone.php.

Constructor & Destructor Documentation

__construct()

HTMLPurifier_PropertyList::__construct

(

$parent = null

)

Parameters

HTMLPurifier_PropertyList

$parent

Parent plist

Definition at line 8196 of file HTMLPurifier.standalone.php.

Member Function Documentation

get()

HTMLPurifier_PropertyList::get

(

$name

)

Recursively retrieves the value for a key

Parameters

string

$name

Exceptions

HTMLPurifier_Exception

Definition at line 8206 of file HTMLPurifier.standalone.php.

getParent()

HTMLPurifier_PropertyList::getParent

(

)

Returns the parent plist.

Returns

HTMLPurifier_PropertyList

Definition at line 8274 of file HTMLPurifier.standalone.php.

has()

HTMLPurifier_PropertyList::has

(

$name

)

Returns true if a given key exists

Parameters

string

$name

Returns

bool

Definition at line 8233 of file HTMLPurifier.standalone.php.

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 8243 of file HTMLPurifier.standalone.php.

set()

HTMLPurifier_PropertyList::set	(		$name,
			$value
	)

Sets the value of a key, for this plist

Parameters

string	$name
mixed	$value

Definition at line 8223 of file HTMLPurifier.standalone.php.

setParent()

HTMLPurifier_PropertyList::setParent

(

$plist

)

Sets the parent plist.

Parameters

HTMLPurifier_PropertyList

$plist

Parent plist

Definition at line 8283 of file HTMLPurifier.standalone.php.

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 8258 of file HTMLPurifier.standalone.php.

Member Data Documentation

$cache

HTMLPurifier_PropertyList::$cache

protected

Cache. @type array

Definition at line 8191 of file HTMLPurifier.standalone.php.

$data

HTMLPurifier_PropertyList::$data = array()

protected

Internal data-structure for properties. @type array

Definition at line 8179 of file HTMLPurifier.standalone.php.

$parent

HTMLPurifier_PropertyList::$parent

protected

Parent plist. @type HTMLPurifier_PropertyList

Definition at line 8185 of file HTMLPurifier.standalone.php.

---

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

• plugins/htmlpurifier/HTMLPurifier.standalone.php