\HTMLPurifier_Context

Registry object that contains information about the current context.

Summary

Methods
Properties
Constants
register()
get()
destroy()
exists()
loadArray()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$_storage
N/A

Properties

$_storage

$_storage

Private array that stores the references.

Methods

register()

register(string  $name, mixed  $ref) : mixed

Registers a variable into the context.

Parameters

string $name

String name

mixed $ref

Reference to variable to be registered

Returns

mixed —

get()

& get(string  $name, bool  $ignore_error = false) : mixed

Retrieves a variable reference from the context.

Parameters

string $name

String name

bool $ignore_error

Boolean whether or not to ignore error

Returns

mixed —

destroy()

destroy(string  $name) : mixed

Destroys a variable in the context.

Parameters

string $name

String name

Returns

mixed —

exists()

exists(string  $name) : bool

Checks whether or not the variable exists.

Parameters

string $name

String name

Returns

bool —

loadArray()

loadArray(array  $context_array) : mixed

Loads a series of variables from an associative array

Parameters

array $context_array

Assoc array of variables to load

Returns

mixed —