Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Calendar event interface.

Copyright: 2017 Cameron Ball <cameron@cameron1729.xyz>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 142 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

event_interface:: (15 methods):
  get_id()
  get_name()
  get_description()
  get_location()
  get_category()
  get_course()
  get_course_module()
  get_group()
  get_user()
  get_type()
  get_times()
  get_repeats()
  get_subscription()
  is_visible()
  get_component()


Interface: event_interface  - X-Ref

Interface for an event class.

get_id()   X-Ref
Get the event's ID.

return: integer

get_name()   X-Ref
Get the event's name.

return: string

get_description()   X-Ref
Get the event's description.

return: description_interface

get_location()   X-Ref
Get the event's location.

return: location_interface

get_category()   X-Ref
Get the category object associated with the event.

return: proxy_interface

get_course()   X-Ref
Get the course object associated with the event.

return: proxy_interface

get_course_module()   X-Ref
Get the course module object that created the event.

return: proxy_interface

get_group()   X-Ref
Get the group object associated with the event.

return: proxy_interface

get_user()   X-Ref
Get the user object associated with the event.

return: proxy_interface

get_type()   X-Ref
Get the event's type.

return: string

get_times()   X-Ref
Get the times associated with the event.

return: times_interface

get_repeats()   X-Ref
Get repeats of this event or null if the event has no
repeats.

return: event_collection_interface|null

get_subscription()   X-Ref
Get the event's subscription.

return: proxy_interface

is_visible()   X-Ref
Get the event's visibility.

return: bool true if the event is visible, false otherwise

get_component()   X-Ref
Resolved event component (frankenstyle name of activity module or the component)

return: string|null