Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
|
Class representing a calendar event. More...
Public Member Functions | |
__construct ( $id, $name, description_interface $description, proxy_interface $category=null, proxy_interface $course=null, proxy_interface $group=null, proxy_interface $user=null, event_collection_interface $repeats=null, proxy_interface $coursemodule=null, $type, times_interface $times, $visible, proxy_interface $subscription=null, $location=null, $component=null) | |
Constructor. More... | |
get_category () | |
Get the category object associated with the event. More... | |
get_component () | |
Resolved event component (frankenstyle name of activity module or the component) More... | |
get_course () | |
Get the course object associated with the event. More... | |
get_course_module () | |
Get the course module object that created the event. More... | |
get_description () | |
Get the event's description. More... | |
get_group () | |
Get the group object associated with the event. More... | |
get_id () | |
Get the event's ID. More... | |
get_location () | |
Get the event's location. More... | |
get_name () | |
Get the event's name. More... | |
get_repeats () | |
Get repeats of this event or null if the event has no repeats. More... | |
get_subscription () | |
Get the event's subscription. More... | |
get_times () | |
Get the times associated with the event. More... | |
get_type () | |
Get the event's type. More... | |
get_user () | |
Get the user object associated with the event. More... | |
is_visible () | |
Get the event's visibility. More... | |
Protected Attributes | |
proxy_interface | $category |
$category Category for this event. | |
string | $component |
$component | |
proxy_interface | $course |
$course Course for this event. | |
proxy_interface | $coursemodule |
$coursemodule The course module that created this event. | |
description_interface | $description |
$description Description for this event. | |
proxy_interface | $group |
$group Group for this event. | |
int | $id |
$id The event's id in the database. | |
string | $location |
$location Location of this event. | |
string | $name |
$name The name of this event. | |
event_collection_interface | $repeats |
$repeats Collection of repeat events. | |
proxy_interface | $subscription |
$subscription Subscription for this event. | |
times_interface | $times |
$times The times for this event. | |
string | $type |
type The type of this event. | |
proxy_interface | $user |
$user User for this event. | |
bool | $visible |
$visible The visibility of this event. | |
Class representing a calendar event.
core_calendar\local\event\entities\event::__construct | ( | $id, | |
$name, | |||
description_interface | $description, | ||
proxy_interface | $category = null , |
||
proxy_interface | $course = null , |
||
proxy_interface | $group = null , |
||
proxy_interface | $user = null , |
||
event_collection_interface | $repeats = null , |
||
proxy_interface | $coursemodule = null , |
||
$type, | |||
times_interface | $times, | ||
$visible, | |||
proxy_interface | $subscription = null , |
||
$location = null , |
|||
$component = null |
|||
) |
Constructor.
int | $id | The event's ID in the database. |
string | $name | The event's name. |
description_interface | $description | The event's description. |
proxy_interface | $category | The category associated with the event. |
proxy_interface | $course | The course associated with the event. |
proxy_interface | $group | The group associated with the event. |
proxy_interface | $user | The user associated with the event. |
event_collection_interface | $repeats | Collection of repeat events. |
proxy_interface | $coursemodule | The course module that created the event. |
string | $type | The event's type. |
times_interface | $times | The times associated with the event. |
bool | $visible | The event's visibility. True for visible, false for invisible. |
proxy_interface | $subscription | The event's subscription. |
string | $location | The event's location. |
string | $component | The event's component. |
core_calendar\local\event\entities\event::get_category | ( | ) |
Get the category object associated with the event.
proxy_interface |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\event::get_component | ( | ) |
Resolved event component (frankenstyle name of activity module or the component)
string|null |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\event::get_course | ( | ) |
Get the course object associated with the event.
proxy_interface |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\event::get_course_module | ( | ) |
Get the course module object that created the event.
proxy_interface |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\event::get_description | ( | ) |
Get the event's description.
description_interface |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\event::get_group | ( | ) |
Get the group object associated with the event.
proxy_interface |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\event::get_id | ( | ) |
Get the event's ID.
integer |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\event::get_location | ( | ) |
Get the event's location.
location_interface |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\event::get_name | ( | ) |
Get the event's name.
string |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\event::get_repeats | ( | ) |
Get repeats of this event or null if the event has no repeats.
event_collection_interface|null |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\event::get_subscription | ( | ) |
Get the event's subscription.
proxy_interface |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\event::get_times | ( | ) |
Get the times associated with the event.
times_interface |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\event::get_type | ( | ) |
Get the event's type.
string |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\event::get_user | ( | ) |
Get the user object associated with the event.
proxy_interface |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\event::is_visible | ( | ) |
Get the event's visibility.
bool | true if the event is visible, false otherwise |
Implements core_calendar\local\event\entities\event_interface.