Class HTMLPurifier_PropertyList

All Classes | Properties | Methods

Inheritance	HTMLPurifier_PropertyList

Generic property list implementation

Protected Properties

Property	Description	Defined By
$cache	Cache.	HTMLPurifier_PropertyList
$data	Internal data-structure for properties.	HTMLPurifier_PropertyList
$parent	Parent plist.	HTMLPurifier_PropertyList

Method	Description	Defined By
__construct()		HTMLPurifier_PropertyList
get()	Recursively retrieves the value for a key	HTMLPurifier_PropertyList
getParent()	Returns the parent plist.	HTMLPurifier_PropertyList
has()	Returns true if a given key exists	HTMLPurifier_PropertyList
reset()	Resets a value to the value of it's parent, usually the default. If no value is specified, the entire plist is reset.	HTMLPurifier_PropertyList
set()	Sets the value of a key, for this plist	HTMLPurifier_PropertyList
setParent()	Sets the parent plist.	HTMLPurifier_PropertyList
squash()	Squashes this property list and all of its property lists into a single array, and returns the array. This value is cached by default.	HTMLPurifier_PropertyList

$cache protected property

protected $cache = null

$data protected property

protected $data = []

$parent protected property

protected $parent = null

__construct() public method

public void __construct ( $parent = null )
$parent	HTMLPurifier_PropertyList	Parent plist

get() public method

Recursively retrieves the value for a key

getParent() public method

Returns the parent plist.

public HTMLPurifier_PropertyList getParent ( )

has() public method

Returns true if a given key exists

public bool has ( $name )
$name	string

reset() public method

Resets a value to the value of it's parent, usually the default. If no value is specified, the entire plist is reset.

public void reset ( $name = null )
$name	string

set() public method

Sets the value of a key, for this plist

setParent() public method

Sets the parent plist.

public void setParent ( $plist )
$plist	HTMLPurifier_PropertyList	Parent plist

squash() public method

Squashes this property list and all of its property lists into a single array, and returns the array. This value is cached by default.

public array squash ( $force = false )
$force	bool	If true, ignores the cache and regenerates the array.