HTMLPurifier_PropertyList

Generic property list implementation

• Full name: \HTMLPurifier_PropertyList

Properties

data

Internal data-structure for properties.

protected $data

---

parent

Parent plist.

protected $parent

---

cache

Cache.

protected $cache

---

Methods

__construct

public __construct(\HTMLPurifier_PropertyList $parent = null): mixed

Parameters:

Parameter	Type	Description
$parent	\HTMLPurifier_PropertyList	Parent plist

---

get

Recursively retrieves the value for a key

public get(string $name): mixed

Parameters:

Parameter	Type	Description
$name	string

Throws:

• HTMLPurifier_Exception

---

set

Sets the value of a key, for this plist

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

Parameters:

Parameter	Type	Description
$name	string
$value	mixed

---

has

Returns true if a given key exists

public has(string $name): bool

Parameters:

Parameter	Type	Description
$name	string

---

reset

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:

Parameter	Type	Description
$name	string

---

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

Parameters:

Parameter	Type	Description
$force	bool	If true, ignores the cache and regenerates the array.

---

getParent

Returns the parent plist.

public getParent(): \HTMLPurifier_PropertyList

---

setParent

Sets the parent plist.

public setParent(\HTMLPurifier_PropertyList $plist): mixed

Parameters:

Parameter	Type	Description
$plist	\HTMLPurifier_PropertyList	Parent plist

---

---

Automatically generated on 2025-03-18