Calendar API: Difference between revisions
Helen Foster (talk | contribs) (see also link to user docs) |
No edit summary |
||
Line 1: | Line 1: | ||
The Calendar API allows you to add and modify events in the calendar for user, groups, courses, or the whole site. | The Calendar API allows you to add and modify events in the calendar for user, groups, courses, or the whole site. | ||
==Overview== | |||
The Moodle [[:en:Calendar]] collects and displays calendar events from everything users have access to. | |||
If your plugin generates calendar events (such as due dates) then you need to add your events to the calendar. | |||
==File locations== | |||
All the calendar code is located in /calendar/lib.php. You need to include this file in your script if you intend to use it. | |||
==The calendar_event class== | |||
All management of events that you might need to do can be done by the '''calendar_event()''' class. | |||
[Rossi, describe this class and the methods available here] | |||
==Examples== | |||
Adding an event to the calendar | |||
Dealing with files | |||
etc | |||
==See also== | ==See also== | ||
* [[:en:Calendar|Calendar user docs]] | * [[:en:Calendar|Calendar user docs]] |
Revision as of 08:17, 13 January 2012
The Calendar API allows you to add and modify events in the calendar for user, groups, courses, or the whole site.
Overview
The Moodle en:Calendar collects and displays calendar events from everything users have access to.
If your plugin generates calendar events (such as due dates) then you need to add your events to the calendar.
File locations
All the calendar code is located in /calendar/lib.php. You need to include this file in your script if you intend to use it.
The calendar_event class
All management of events that you might need to do can be done by the calendar_event() class.
[Rossi, describe this class and the methods available here]
Examples
Adding an event to the calendar
Dealing with files
etc