HTMLPurifier_Context Class Reference

Public Member Functions
	register ($name, &$ref)
&	get ($name, $ignore_error=false)
	destroy ($name)
	exists ($name)
	loadArray ($context_array)

Detailed Description

Registry object that contains information about the current context.

Warning

Is a bit buggy when variables are set to null: it thinks they don't exist! So use false instead, please.

Note

Since the variables Context deals with may not be objects, references are very important here! Do not remove!

Member Function Documentation

destroy()

destroy

(

$name

)

Destroys a variable in the context.

Parameters

string

$name

String name

exists()

exists

(

$name

)

Checks whether or not the variable exists.

Parameters

string

$name

String name

Returns

bool

get()

& 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

Returns

mixed

loadArray()

loadArray

(

$context_array

)

Loads a series of variables from an associative array

Parameters

array

$context_array

Assoc array of variables to load

register()

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:

• C:/xoops2511b2/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/Context.php