Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
report_eventlist_list_generator Class Reference

Class for returning system event information. More...

Static Public Member Functions

static get_all_events_list ($detail=true)
 Convenience method.
 
static get_core_events_list ($detail=true)
 Return all of the core event files.
 
static get_crud_string ($crudcharacter)
 Returns the appropriate string for the CRUD character.
 
static get_edulevel_string ($edulevel)
 Returns the appropriate string for the event education level.
 
static get_non_core_event_list ($detail=true)
 This function returns an array of all events for the plugins of the system.
 
static get_observer_list ()
 Get the full list of observers for the system.
 

Detailed Description

Class for returning system event information.

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

Member Function Documentation

◆ get_all_events_list()

static report_eventlist_list_generator::get_all_events_list ( $detail = true)
static

Convenience method.

Returns all of the core events either with or without details.

Parameters
bool$detailTrue will return details, but no abstract classes, False will return all events, but no details.
Return values
arrayAll events.

◆ get_core_events_list()

static report_eventlist_list_generator::get_core_events_list ( $detail = true)
static

Return all of the core event files.

Parameters
bool$detailTrue will return details, but no abstract classes, False will return all events, but no details.
Return values
arrayCore events.
Deprecated
since 4.0 use {
See also
get_all_events_list} instead

◆ get_crud_string()

static report_eventlist_list_generator::get_crud_string ( $crudcharacter)
static

Returns the appropriate string for the CRUD character.

Parameters
string$crudcharacterThe CRUD character.
Return values
stringget_string for the specific CRUD character.

◆ get_edulevel_string()

static report_eventlist_list_generator::get_edulevel_string ( $edulevel)
static

Returns the appropriate string for the event education level.

Parameters
int$edulevelTakes either the edulevel constant or string.
Return values
stringget_string for the specific education level.

◆ get_non_core_event_list()

static report_eventlist_list_generator::get_non_core_event_list ( $detail = true)
static

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

Parameters
bool$detailTrue will return details, but no abstract classes, False will return all events, but no details.
Return values
arrayA list of events from all plug-ins.
Deprecated
since 4.0 use {
See also
get_all_events_list} instead

◆ get_observer_list()

static report_eventlist_list_generator::get_observer_list ( )
static

Get the full list of observers for the system.

Return values
arrayAn array of observers in the system.

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