Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
filter_emoticon Class Reference
Inheritance diagram for filter_emoticon:
moodle_text_filter

Public Member Functions

 filter ($text, array $options=array())
 Apply the filter to the text.
 
 filter_stage_post_clean (string $text, array $options)
 Filter HTML text at the very end after text is sanitised.
 
 filter_stage_pre_clean (string $text, array $options)
 Filter HTML text before sanitising text.
 
 filter_stage_pre_format (string $text, array $options)
 Filter text before changing format to HTML.
 
 filter_stage_string (string $text, array $options)
 Filter simple text coming from format_string().
 
 hash ()
 
 setup ($page, $context)
 Setup page with filter requirements and other prepare stuff.
 

Protected Member Functions

 replace_emoticons ($text)
 Replace emoticons found in the text with their images.
 

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.
 
static array $emoticontexts = array()
 Internal cache used for replacing.
 

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$textto be processed by the text
array$optionsfilter options
Return values
stringtext 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$textto modify
Return values
stringthe 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: