Differences Between: [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403]
Event documentation
Copyright: | 2014 onwards Ankit Agarwal <ankit.agrr@gmail.com> |
License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
File Size: | 222 lines (9 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
eventlist:: (6 methods):
get_core_eventlist()
get_non_core_eventlist()
get_file_list()
get_all_eventlist()
get_plugin_list()
validate_event_plugin()
get_core_eventlist() X-Ref |
Return all of the core event files. return: array Core events. |
get_non_core_eventlist($withoutcomponent = false) X-Ref |
This function returns an array of all events for the plugins of the system. param: bool $withoutcomponent Return an eventlist without associated components. return: array A list of events from all plug-ins. |
get_file_list($directory) X-Ref |
Returns a list of files with a full directory path in a specified directory. param: string $directory location of files. return: array full location of files from the specified directory. |
get_all_eventlist($withoutcomponent = false) X-Ref |
Get a list of events present in the system. param: bool $withoutcomponent Return an eventlist without associated components. return: array list of events present in the system. |
get_plugin_list($eventlist = array() X-Ref |
Return list of plugins that have events. param: array $eventlist a list of events present in the system {@link eventlist::get_all_eventlist}. return: array list of plugins with human readable name. |
validate_event_plugin($plugin, $eventname, $eventlist = array() X-Ref |
validate if the given event belongs to the given plugin. param: string $plugin Frankenstyle name of the plugin. param: string $eventname Full qualified event name. param: array $eventlist List of events generated by {@link eventlist::get_all_eventlist} return: bool Returns true if the selected event belongs to the selected plugin, false otherwise. |