HTMLPurifier_PropertyList
in package
Generic property list implementation
Table of Contents
Properties
- $cache : mixed
- Cache.
- $data : mixed
- Internal data-structure for properties.
- $parent : mixed
- Parent plist.
Methods
- __construct() : mixed
- get() : mixed
- Recursively retrieves the value for a key
- getParent() : HTMLPurifier_PropertyList
- Returns the parent plist.
- has() : bool
- Returns true if a given key exists
- reset() : mixed
- Resets a value to the value of it's parent, usually the default. If no value is specified, the entire plist is reset.
- set() : mixed
- Sets the value of a key, for this plist
- setParent() : mixed
- Sets the parent plist.
- squash() : array<string|int, mixed>
- Squashes this property list and all of its property lists into a single array, and returns the array. This value is cached by default.
Properties
$cache
Cache.
protected
mixed
$cache
Tags
$data
Internal data-structure for properties.
protected
mixed
$data
= array()
Tags
$parent
Parent plist.
protected
mixed
$parent
Tags
Methods
__construct()
public
__construct([HTMLPurifier_PropertyList $parent = null ]) : mixed
Parameters
- $parent : HTMLPurifier_PropertyList = null
-
Parent plist
get()
Recursively retrieves the value for a key
public
get(string $name) : mixed
Parameters
- $name : string
Tags
getParent()
Returns the parent plist.
public
getParent() : HTMLPurifier_PropertyList
Return values
HTMLPurifier_PropertyListhas()
Returns true if a given key exists
public
has(string $name) : bool
Parameters
- $name : string
Return values
boolreset()
Resets a value to the value of it's parent, usually the default. If no value is specified, the entire plist is reset.
public
reset([string $name = null ]) : mixed
Parameters
- $name : string = null
set()
Sets the value of a key, for this plist
public
set(string $name, mixed $value) : mixed
Parameters
- $name : string
- $value : mixed
setParent()
Sets the parent plist.
public
setParent(HTMLPurifier_PropertyList $plist) : mixed
Parameters
- $plist : HTMLPurifier_PropertyList
-
Parent plist
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.
public
squash([bool $force = false ]) : array<string|int, mixed>
Parameters
- $force : bool = false
-
If true, ignores the cache and regenerates the array.