filter_emoticon Class Reference

Inheritance diagram for filter_emoticon:

Public Member Functions
	filter ($text, array $options=array())
	Apply the filter to the text. More...
	hash ()
	setup ($page, $context)
	Setup page with filter requirements and other prepare stuff. More...

Protected Member Functions
	replace_emoticons ($text)
	Replace emoticons found in the text with their images. More...

Protected Attributes
context	$context
	The context we are in.
array	$localconfig
	Any local configuration for this filter in this context.

Static Protected Attributes
static array	$emoticonimgs = array()
	Internal cache used for replacing. More...
static array	$emoticontexts = array()
	Internal cache used for replacing. More...

Member Function Documentation

filter()

filter_emoticon::filter	(		$text,
		array	$options = array()
	)

Apply the filter to the text.

See also

filter_manager::apply_filter_chain()

Parameters

string	$text	to be processed by the text
array	$options	filter options

Return values

string

text after processing

Reimplemented from moodle_text_filter.

replace_emoticons()

filter_emoticon::replace_emoticons (   $text )

protected

Replace emoticons found in the text with their images.

Parameters

string

$text

to modify

Return values

string

the modified result

Member Data Documentation

$emoticonimgs

array filter_emoticon::$emoticonimgs = array()

staticprotected

Internal cache used for replacing.

Multidimensional array;

• dimension 1: language,
• dimension 2: theme.

$emoticontexts

array filter_emoticon::$emoticontexts = array()

staticprotected

Internal cache used for replacing.

Multidimensional array;

• dimension 1: language,
• dimension 2: theme.

---

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

• filter/emoticon/filter.php