filter_manager Class Reference

Inheritance diagram for filter_manager:

Public Member Functions
	filter_text ($text, $context, array $options=array())
	filter_string ($string, $context)
	text_filtering_hash ($context)
Static Public Member Functions
static	instance ()
Protected Member Functions
	__construct ()
	load_filters ($context)
	make_filter_object ($filtername, $context, $localconfig)
	apply_filter_chain ($text, $filterchain, array $options=array())
	get_text_filters ($context)
	get_string_filters ($context)
Protected Attributes
	$textfilters = array()
	$stringfilters = array()
	$stringfilternames = array()
Static Protected Attributes
static	$singletoninstance

---

Detailed Description

Definition at line 58 of file filterlib.php.

---

Constructor & Destructor Documentation

__construct

(

)

[protected]

Reimplemented in testable_filter_manager.

Definition at line 77 of file filterlib.php.

Here is the call graph for this function:

---

Member Function Documentation

apply_filter_chain	(	$	text,
		$	filterchain,
		array $	options = array()
	)		[protected]

Todo:

Document this function

Parameters:

string	$text
array	$filterchain
array	$options	options passed to the filters

Returns:

string $text

Definition at line 155 of file filterlib.php.

Here is the caller graph for this function:

filter_string	(	$	string,
		$	context
	)

Filter a piece of string

Parameters:

string	$string	The text to filter
object	$context

Returns:

string resulting string

Reimplemented in performance_measuring_filter_manager.

Definition at line 208 of file filterlib.php.

Here is the call graph for this function:

filter_text	(	$	text,
		$	context,
		array $	options = array()
	)

Filter some text

Parameters:

string	$text	The text to filter
object	$context
array	$options	options passed to the filters

Returns:

string resulting text

<nolink> tags removed for XHTML compatibility

Reimplemented in performance_measuring_filter_manager.

Definition at line 194 of file filterlib.php.

Here is the call graph for this function:

get_string_filters

(

$

context

)

[protected]

Todo:

Document this function

Parameters:

object

$context

Returns:

object A string filter

Definition at line 179 of file filterlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_text_filters

(

$

context

)

[protected]

Todo:

Document this function

Parameters:

object

$context

Returns:

object A text filter

Definition at line 167 of file filterlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static instance

(

)

[static]

Returns:

filter_manager the singleton instance.

Definition at line 84 of file filterlib.php.

Here is the caller graph for this function:

load_filters

(

$

context

)

[protected]

Load all the filters required by this context.

Parameters:

object

$context

Definition at line 101 of file filterlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

make_filter_object	(	$	filtername,
		$	context,
		$	localconfig
	)		[protected]

Factory method for creating a filter

Parameters:

string	$filter	The filter name, for example 'filter/tex' or 'mod/glossary'.
object	$context	context object.
array	$localconfig	array of local configuration variables for this filter.

Returns:

object moodle_text_filter The filter, or null, if this type of filter is not recognised or could not be created.

Reimplemented in performance_measuring_filter_manager.

Definition at line 126 of file filterlib.php.

Here is the caller graph for this function:

text_filtering_hash

(

$

context

)

Todo:

Document this function

Parameters:

object

$context

Returns:

object A string filter

Definition at line 217 of file filterlib.php.

Here is the call graph for this function:

---

Field Documentation

$singletoninstance [static, protected]

Definition at line 75 of file filterlib.php.

$stringfilternames = array() [protected]

Definition at line 72 of file filterlib.php.

$stringfilters = array() [protected]

Definition at line 69 of file filterlib.php.

$textfilters = array() [protected]

Definition at line 63 of file filterlib.php.

---

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

• C:/xampp/htdocs/moodle/lib/filterlib.php