Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Static Public Member Functions | Static Protected Member Functions | List of all members
tool_monitor\eventlist Class Reference

Class for returning event information. More...

Static Public Member Functions

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

Static Protected Member Functions

static get_core_eventlist ()
 Return all of the core event files. More...
 
static get_file_list ($directory)
 Returns a list of files with a full directory path in a specified directory. More...
 
static get_non_core_eventlist ($withoutcomponent=false)
 This function returns an array of all events for the plugins of the system. More...
 

Detailed Description

Class for returning event information.

Since
Moodle 2.8
License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

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_core_eventlist()

static tool_monitor\eventlist::get_core_eventlist ( )
staticprotected

Return all of the core event files.

Return values
arrayCore events.

◆ get_file_list()

static tool_monitor\eventlist::get_file_list (   $directory)
staticprotected

Returns a list of files with a full directory path in a specified directory.

Parameters
string$directorylocation of files.
Return values
arrayfull location of files from the specified directory.

◆ get_non_core_eventlist()

static tool_monitor\eventlist::get_non_core_eventlist (   $withoutcomponent = false)
staticprotected

This function returns an array of all events for the plugins of the system.

Parameters
bool$withoutcomponentReturn an eventlist without associated components.
Return values
arrayA list of events from all plug-ins.

◆ 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.

◆ 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: