Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
filter_activitynames Class Reference

Activity name filtering. More...

Inheritance diagram for filter_activitynames:

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 ()
 
 setup ($page, $context)
 Setup page with filter requirements and other prepare stuff.
 

Protected Member Functions

 get_activity_list ($courseid)
 Get all the activity list for a course.
 
 get_cached_activity_list ($courseid)
 Get all the cached activity list for a course.
 

Protected Attributes

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

Detailed Description

Activity name filtering.

Member Function Documentation

◆ filter()

filter_activitynames::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$textsome HTML content to process.
array$optionsoptions passed to the filters
Return values
stringthe HTML content after the filtering has been applied.

Reimplemented from moodle_text_filter.

◆ get_activity_list()

filter_activitynames::get_activity_list ( $courseid)
protected

Get all the activity list for a course.

Parameters
int$courseidid of the course
Return values
filterobject[]the activities

◆ get_cached_activity_list()

filter_activitynames::get_cached_activity_list ( $courseid)
protected

Get all the cached activity list for a course.

Parameters
int$courseidid of the course
Return values
filterobject[]the activities

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