HTMLPurifier_Context Class Reference

Registry object that contains information about the current context. More...

List of all members.

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

---

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!

Definition at line 10 of file Context.php.

---

Member Function Documentation

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

Registers a variable into the context.

Parameters:

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

Definition at line 23 of file Context.php.

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

Retrieves a variable reference from the context.

Parameters:

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

Definition at line 37 of file Context.php.

HTMLPurifier_Context::destroy

(

$

name

)

Destorys a variable in the context.

Parameters:

$name

String name

Definition at line 53 of file Context.php.

HTMLPurifier_Context::exists

(

$

name

)

Checks whether or not the variable exists.

Parameters:

$name

String name

Definition at line 66 of file Context.php.

HTMLPurifier_Context::loadArray

(

$

context_array

)

Loads a series of variables from an associative array.

Parameters:

$context_array

Assoc array of variables to load

Definition at line 74 of file Context.php.

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

Registers a variable into the context.

Parameters:

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

Definition at line 2100 of file HTMLPurifier.standalone.php.

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

Retrieves a variable reference from the context.

Parameters:

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

Definition at line 2114 of file HTMLPurifier.standalone.php.

HTMLPurifier_Context::destroy

(

$

name

)

Destorys a variable in the context.

Parameters:

$name

String name

Definition at line 2130 of file HTMLPurifier.standalone.php.

HTMLPurifier_Context::exists

(

$

name

)

Checks whether or not the variable exists.

Parameters:

$name

String name

Definition at line 2143 of file HTMLPurifier.standalone.php.

HTMLPurifier_Context::loadArray

(

$

context_array

)

Loads a series of variables from an associative array.

Parameters:

$context_array

Assoc array of variables to load

Definition at line 2151 of file HTMLPurifier.standalone.php.

---

Member Data Documentation

HTMLPurifier_Context::$_storage = array() [private]

Private array that stores the references.

Definition at line 16 of file Context.php.

---

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

• library/HTMLPurifier/Context.php
• library/HTMLPurifier.standalone.php

---