Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
Class representing an actionable event. More...
Public Member Functions | |
__construct (event_interface $event, action_interface $action) | |
Constructor. | |
get_action () | |
Get the action event's action. | |
get_category () | |
Get the category object associated with the event. | |
get_component () | |
Event component. | |
get_course () | |
Get the course object associated with the event. | |
get_course_module () | |
Get the course module object that created the event. | |
get_description () | |
Get the event's description. | |
get_group () | |
Get the group object associated with the event. | |
get_id () | |
Get the event's ID. | |
get_location () | |
Get the event's location. | |
get_name () | |
Get the event's name. | |
get_repeats () | |
Get repeats of this event or null if the event has no repeats. | |
get_subscription () | |
Get the event's subscription. | |
get_times () | |
Get the times associated with the event. | |
get_type () | |
Get the event's type. | |
get_user () | |
Get the user object associated with the event. | |
is_visible () | |
Get the event's visibility. | |
Protected Attributes | |
action_interface | $action |
$action The action associated with this event. | |
proxy_interface | $category |
$category Category for this event. | |
event_interface | $event |
$event The event to delegate to. | |
Class representing an actionable event.
An actionable event can be thought of as an embellished event. That is, it does everything a regular event does, but has some extra information attached to it. For example, the URL a user needs to visit to complete an action, the number of actionable items, etc.
core_calendar\local\event\entities\action_event::__construct | ( | event_interface | $event, |
action_interface | $action ) |
Constructor.
event_interface | $event | The event to delegate to. |
action_interface | $action | The action associated with this event. |
core_calendar\local\event\entities\action_event::get_action | ( | ) |
Get the action event's action.
action_interface |
Implements core_calendar\local\event\entities\action_event_interface.
core_calendar\local\event\entities\action_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\action_event::get_component | ( | ) |
Event component.
string |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\action_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\action_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\action_event::get_description | ( | ) |
Get the event's description.
description_interface |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\action_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\action_event::get_id | ( | ) |
Get the event's ID.
integer |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\action_event::get_location | ( | ) |
Get the event's location.
location_interface |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\action_event::get_name | ( | ) |
Get the event's name.
string |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\action_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\action_event::get_subscription | ( | ) |
Get the event's subscription.
proxy_interface |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\action_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\action_event::get_type | ( | ) |
Get the event's type.
string |
Implements core_calendar\local\event\entities\event_interface.
core_calendar\local\event\entities\action_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\action_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.