Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
|
Interface for an action event class. More...
Public Member Functions | |
get_action () | |
Get the action event's action. 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... | |
Interface for an action event class.
core_calendar\local\event\entities\action_event_interface::get_action | ( | ) |
Get the action event's action.
action_interface |
Implemented in core_calendar\local\event\entities\action_event.
|
inherited |
Get the category object associated with the event.
proxy_interface |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.
|
inherited |
Resolved event component (frankenstyle name of activity module or the component)
string|null |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.
|
inherited |
Get the course object associated with the event.
proxy_interface |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.
|
inherited |
Get the course module object that created the event.
proxy_interface |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.
|
inherited |
Get the event's description.
description_interface |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.
|
inherited |
Get the group object associated with the event.
proxy_interface |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.
|
inherited |
Get the event's ID.
integer |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.
|
inherited |
Get the event's location.
location_interface |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.
|
inherited |
Get the event's name.
string |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.
|
inherited |
Get repeats of this event or null if the event has no repeats.
event_collection_interface|null |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.
|
inherited |
Get the event's subscription.
proxy_interface |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.
|
inherited |
Get the times associated with the event.
times_interface |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.
|
inherited |
Get the event's type.
string |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.
|
inherited |
Get the user object associated with the event.
proxy_interface |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.
|
inherited |
Get the event's visibility.
bool | true if the event is visible, false otherwise |
Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.