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/classes/local/event/entities/ -> event.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 39 and 401]

Calendar event class.

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

Defines 1 class

event:: (16 methods):
  __construct()
  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()


Class: event  - X-Ref

Class representing a calendar event.

__construct($id,$name,description_interface $description,?proxy_interface $category,?proxy_interface $course,?proxy_interface $group,?proxy_interface $user,?event_collection_interface $repeats,?proxy_interface $coursemodule,$type,times_interface $times,$visible,proxy_interface $subscription = null,$location = null,$component = null)   X-Ref
Constructor.

param: int                        $id             The event's ID in the database.
param: string                     $name           The event's name.
param: description_interface      $description    The event's description.
param: proxy_interface|null       $category       The category associated with the event.
param: proxy_interface|null       $course         The course associated with the event.
param: proxy_interface|null       $group          The group associated with the event.
param: proxy_interface|null       $user           The user associated with the event.
param: event_collection_interface|null $repeats   Collection of repeat events.
param: proxy_interface|null       $coursemodule   The course module that created the event.
param: string                     $type           The event's type.
param: times_interface            $times          The times associated with the event.
param: bool                       $visible        The event's visibility. True for visible, false for invisible.
param: proxy_interface|null       $subscription   The event's subscription.
param: string                     $location       The event's location.
param: string                     $component      The event's component.

get_id()   X-Ref
No description

get_name()   X-Ref
No description

get_description()   X-Ref
No description

get_location()   X-Ref
No description

get_category()   X-Ref
No description

get_course()   X-Ref
No description

get_course_module()   X-Ref
No description

get_group()   X-Ref
No description

get_user()   X-Ref
No description

get_type()   X-Ref
No description

get_times()   X-Ref
No description

get_repeats()   X-Ref
No description

get_subscription()   X-Ref
No description

is_visible()   X-Ref
No description

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

return: string|null