Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
tool_monitor\eventlist Class Reference

Static Public Member Functions

static get_all_eventlist ($withoutcomponent=false)
 Get a list of events present in the system.
 
static get_plugin_list ($eventlist=array())
 Return list of plugins that have events.
 
static validate_event_plugin ($plugin, $eventname, $eventlist=array())
 validate if the given event belongs to the given plugin.
 

Member Function Documentation

◆ get_all_eventlist()

static tool_monitor\eventlist::get_all_eventlist ( $withoutcomponent = false)
static

Get a list of events present in the system.

Parameters
bool$withoutcomponentReturn an eventlist without associated components.
Return values
arraylist of events present in the system.

◆ get_plugin_list()

static tool_monitor\eventlist::get_plugin_list ( $eventlist = array())
static

Return list of plugins that have events.

Parameters
array$eventlista list of events present in the system eventlist::get_all_eventlist.
Return values
arraylist of plugins with human readable name, grouped by their type

◆ validate_event_plugin()

static tool_monitor\eventlist::validate_event_plugin ( $plugin,
$eventname,
$eventlist = array() )
static

validate if the given event belongs to the given plugin.

Parameters
string$pluginFrankenstyle name of the plugin.
string$eventnameFull qualified event name.
array$eventlistList of events generated by eventlist::get_all_eventlist
Return values
boolReturns true if the selected event belongs to the selected plugin, false otherwise.

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