filter_emoticon Class Reference

Inheritance diagram for filter_emoticon:

Collaboration diagram for filter_emoticon:

Public Member Functions
	filter ($text, array $options=array())
Protected Member Functions
	get_global_config ($name=null)
	load_global_config ()
	replace_emoticons (&$text)
Static Protected Attributes
static	$globalconfig

---

Detailed Description

Definition at line 33 of file filter.php.

---

Member Function Documentation

array global configuration for this 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

Returns:

string text after processing

This might be eventually moved into parent class if we found it useful for other filters, too.

Reimplemented from moodle_text_filter.

Definition at line 51 of file filter.php.

Here is the call graph for this function:

get_global_config

(

$

name = null

)

[protected]

Returns the global filter setting

If the $name is provided, returns single value. Otherwise returns all global settings in object. Returns null if the named setting is not found.

Parameters:

mixed

$name

optional config variable name, defaults to null for all

Returns:

string|object|null

Definition at line 79 of file filter.php.

Here is the call graph for this function:

Here is the caller graph for this function:

load_global_config

(

)

[protected]

Makes sure that the global config is loaded in $this->globalconfig

Returns:

void

Definition at line 97 of file filter.php.

Here is the call graph for this function:

Here is the caller graph for this function:

replace_emoticons

(

&$

text

)

[protected]

Replace emoticons found in the text with their images

Parameters:

string

$text

to modify

Returns:

void

Definition at line 109 of file filter.php.

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

$globalconfig [static, protected]

Definition at line 41 of file filter.php.

---

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

• C:/xampp/htdocs/moodle/filter/emoticon/filter.php