\HTMLPurifier_PropertyList

Generic property list implementation

Summary

Methods
Properties
Constants
__construct()
get()
set()
has()
reset()
squash()
getParent()
setParent()
No public properties found
No constants found
No protected methods found
$data
$parent
$cache
N/A
No private methods found
No private properties found
N/A

Properties

$data

$data

Internal data-structure for properties.

$parent

$parent

Parent plist.

$cache

$cache

Cache.

Methods

__construct()

__construct(\HTMLPurifier_PropertyList  $parent = null) : mixed

Parameters

\HTMLPurifier_PropertyList $parent

Parent plist

Returns

mixed —

get()

get(string  $name) : mixed

Recursively retrieves the value for a key

Parameters

string $name

Throws

\HTMLPurifier_Exception

Returns

mixed —

set()

set(string  $name, mixed  $value) : mixed

Sets the value of a key, for this plist

Parameters

string $name
mixed $value

Returns

mixed —

has()

has(string  $name) : bool

Returns true if a given key exists

Parameters

string $name

Returns

bool —

reset()

reset(string  $name = null) : mixed

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

Returns

mixed —

squash()

squash(bool  $force = false) : array

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 —

getParent()

getParent() : \HTMLPurifier_PropertyList

Returns the parent plist.

Returns

\HTMLPurifier_PropertyList —

setParent()

setParent(\HTMLPurifier_PropertyList  $plist) : mixed

Sets the parent plist.

Parameters

\HTMLPurifier_PropertyList $plist

Parent plist

Returns

mixed —