filter_mathjaxloader Class Reference

Mathjax filtering. More...

Inheritance diagram for filter_mathjaxloader:

Public Member Functions
	filter ($text, array $options=array())
	Override this function to actually implement the filtering.
	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 ()
	map_language_code ($moodlelangcode)
	setup ($page, $context)
	Setup page with filter requirements and other prepare stuff.

Protected Member Functions
	insert_span ($text, $start, $end)
	Wrap a portion of the $text inside a no link span ().
	wrap_math_in_nolink ($text)
	Find math environments in the $text and wrap them in no link spans ().

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

Detailed Description

Mathjax filtering.

Member Function Documentation

filter()

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

Override this function to actually implement the filtering.

Filter developers must make sure that filtering done after text cleaning does not introduce security vulnerabilities.

Parameters

string	$text	some HTML content to process.
array	$options	options passed to the filters

Return values

string

the HTML content after the filtering has been applied.

Reimplemented from moodle_text_filter.

insert_span()

filter_mathjaxloader::insert_span ( $text, $start, $end )

protected

Wrap a portion of the $text inside a no link span ().

The whole text is then returned.

Parameters

string	$text	The text to modify.
int	$start	The start index of the substring in $text that should be wrapped in the span.
int	$end	The end index of the substring in $text that should be wrapped in the span.

Return values

string

The whole $text with the span inserted around the defined substring.

setup()

filter_mathjaxloader::setup	(		$page,
			$context )

Setup page with filter requirements and other prepare stuff.

Override this method if the filter needs to setup page requirements or needs other stuff to be executed.

Note this method is invoked from {

See also

setup_page_for_filters()} for each piece of text being filtered, so it is responsible for controlling its own execution cardinality.

Parameters

moodle_page	$page	the page we are going to add requirements to.
context	$context	the context which contents are going to be filtered.

Since

Moodle 2.3

Reimplemented from moodle_text_filter.

wrap_math_in_nolink()

filter_mathjaxloader::wrap_math_in_nolink ( $text )

protected

Find math environments in the $text and wrap them in no link spans ().

If math environments are nested, only the outer environment is wrapped in the span.

The recognized math environments are [ ] and $$ $$ for display mathematics and ( ) for inline mathematics.

Parameters

string

$text

The text to filter.

Return values

array

An array containing the potentially modified text and a boolean that is true if any changes were made to the text.

---

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

• filter/mathjaxloader/filter.php