RSS API

From MoodleDocs
Revision as of 05:42, 16 January 2012 by Jason Fowler (talk | contribs)

Overview

The Events API is a core system in Moodle to allow communication between modules.

An event is when something "interesting" happens in Moodle that is worth alerting the system about.

Any Moodle modules can trigger new events (with attached data), and other modules can elect to handle those events with custom functions that operate on the given data.


Examples

Below you will find examples on how to use the RSS functions within your own modules.

Creating an RSS feed

Caching an RSS feed

Retrieving a cached RSS feed

Database structure

Field Type Info
id int(10) auto increment identifier
queuedeventid int(10) foreign key id corresponding to the id of the event_queues table
handlerid int(10) foreign key id corresponding to the id of the event_handlers table
status int(10) number of failed attempts to process this handler
errormessage text if an error happened last time we tried to process this event, record it here.
timemodified int(10) time stamp of the last attempt to run this from the queue

Standards for naming events

Events which exist

Other

See also