HTMLPurifier_Context Class Reference

Public Member Functions
	destroy ($name)
	Destroys a variable in the context.
	exists ($name)
	Checks whether or not the variable exists.
&	get ($name, $ignore_error=false)
	Retrieves a variable reference from the context.
	loadArray ($context_array)
	Loads a series of variables from an associative array.
	register ($name, &$ref)
	Registers a variable into the context.

Member Function Documentation

destroy()

HTMLPurifier_Context::destroy

(

$name

)

Destroys a variable in the context.

Parameters

string

$name

String name

exists()

HTMLPurifier_Context::exists

(

$name

)

Checks whether or not the variable exists.

Parameters

string

$name

String name

Return values

bool

get()

& HTMLPurifier_Context::get	(		$name,
			$ignore_error = false )

Retrieves a variable reference from the context.

Parameters

string	$name	String name
bool	$ignore_error	Boolean whether or not to ignore error

Return values

mixed

loadArray()

HTMLPurifier_Context::loadArray

(

$context_array

)

Loads a series of variables from an associative array.

Parameters

array

$context_array

Assoc array of variables to load

register()

HTMLPurifier_Context::register	(		$name,
		&	$ref )

Registers a variable into the context.

Parameters

string	$name	String name
mixed	$ref	Reference to variable to be registered

---

The documentation for this class was generated from the following file:

• lib/htmlpurifier/HTMLPurifier/Context.php