Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]
Event documentation
Copyright: | 2014 Adrian Greeve <adrian@moodle.com> |
License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
File Size: | 334 lines (14 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
report_eventlist_list_generator:: (8 methods):
get_all_events_list()
get_core_events_list()
get_crud_string()
get_edulevel_string()
get_file_list()
get_non_core_event_list()
get_observer_list()
format_data()
Class: report_eventlist_list_generator - X-Ref
Class for returning system event information.get_all_events_list($detail = true) X-Ref |
Convenience method. Returns all of the core events either with or without details. param: bool $detail True will return details, but no abstract classes, False will return all events, but no details. return: array All events. |
get_core_events_list($detail = true) X-Ref |
Return all of the core event files. param: bool $detail True will return details, but no abstract classes, False will return all events, but no details. return: array Core events. |
get_crud_string($crudcharacter) X-Ref |
Returns the appropriate string for the CRUD character. param: string $crudcharacter The CRUD character. return: string get_string for the specific CRUD character. |
get_edulevel_string($edulevel) X-Ref |
Returns the appropriate string for the event education level. param: int $edulevel Takes either the edulevel constant or string. return: string get_string for the specific education level. |
get_file_list($directory) X-Ref |
Returns a list of files (events) with a full directory path for events in a specified directory. param: string $directory location of files. return: array full location of files from the specified directory. |
get_non_core_event_list($detail = true) X-Ref |
This function returns an array of all events for the plugins of the system. param: bool $detail True will return details, but no abstract classes, False will return all events, but no details. return: array A list of events from all plug-ins. |
get_observer_list() X-Ref |
Get the full list of observers for the system. return: array An array of observers in the system. |
format_data($eventdata, $eventfullpath) X-Ref |
Returns the event data list section with url links and other formatting. param: array $eventdata The event data list section. param: string $eventfullpath Full path to the events for this plugin / subplugin. return: array The event data list section with additional formatting. |