[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/ -> eventslib.php (summary)

Library of functions for events manipulation. The public API is all at the end of this file.

Copyright: 1999 onwards Martin Dougiamas {@link http://moodle.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 141 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 5 functions

  events_get_cached()
  events_uninstall()
  events_cleanup()
  events_dequeue()
  events_get_handlers()

Functions
Functions that are not part of a class:

events_get_cached($component)   X-Ref
Gets the capabilities that have been cached in the database for this
component.

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
return: array of events

events_uninstall($component)   X-Ref
Remove all event handlers and queued events

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'

events_cleanup($component, $cachedhandlers)   X-Ref
Deletes cached events that are no longer needed by the component.

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
param: array $cachedhandlers array of the cached events definitions that will be
return: int number of unused handlers that have been removed

events_dequeue($qhandler)   X-Ref
Removes this queued handler from the events_queued_handler table

Removes events_queue record from events_queue if no more references to this event object exists

param: stdClass $qhandler A row from the events_queued_handler table

events_get_handlers($eventname)   X-Ref
Returns handlers for given event. Uses caching for better perf.

param: string $eventname name of event or 'reset'
return: array|false array of handlers or false otherwise



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1