\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.

Type

Methods

register()

register(string  $name, mixed  $ref) 

Registers a variable into the context.

Parameters

string $name

String name

mixed $ref

Reference to variable to be registered

get()

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

Retrieves a variable reference from the context.

Parameters

string $name

String name

boolean $ignore_error

Boolean whether or not to ignore error

Returns

mixed

destroy()

destroy(string  $name) 

Destroys a variable in the context.

Parameters

string $name

String name

exists()

exists(string  $name) : boolean

Checks whether or not the variable exists.

Parameters

string $name

String name

Returns

boolean

loadArray()

loadArray(array  $context_array) 

Loads a series of variables from an associative array

Parameters

array $context_array

Assoc array of variables to load