core_calendar\local\event\entities\action_event Class Reference

Class representing an actionable event. More...

Inheritance diagram for core_calendar\local\event\entities\action_event:

Public Member Functions
	__construct (event_interface $event, action_interface $action)
	Constructor. More...
	get_action ()
	Get the action event's action. More...
	get_category ()
	Get the category object associated with the event. 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
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.

Detailed Description

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.

Copyright

2017 Cameron Ball camer.nosp@m.on@c.nosp@m.amero.nosp@m.n172.nosp@m.9.xyz

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

core_calendar\local\event\entities\action_event::__construct	(	event_interface	$event,
		action_interface	$action
	)

Constructor.

Parameters

event_interface	$event	The event to delegate to.
action_interface	$action	The action associated with this event.

Member Function Documentation

get_action()

core_calendar\local\event\entities\action_event::get_action

(

)

Get the action event's action.

Return values

action_interface

Implements core_calendar\local\event\entities\action_event_interface.

get_category()

core_calendar\local\event\entities\action_event::get_category

(

)

Get the category object associated with the event.

Return values

proxy_interface

Implements core_calendar\local\event\entities\event_interface.

get_course()

core_calendar\local\event\entities\action_event::get_course

(

)

Get the course object associated with the event.

Return values

proxy_interface

Implements core_calendar\local\event\entities\event_interface.

get_course_module()

core_calendar\local\event\entities\action_event::get_course_module

(

)

Get the course module object that created the event.

Return values

proxy_interface

Implements core_calendar\local\event\entities\event_interface.

get_description()

core_calendar\local\event\entities\action_event::get_description

(

)

Get the event's description.

Return values

description_interface

Implements core_calendar\local\event\entities\event_interface.

get_group()

core_calendar\local\event\entities\action_event::get_group

(

)

Get the group object associated with the event.

Return values

proxy_interface

Implements core_calendar\local\event\entities\event_interface.

get_id()

core_calendar\local\event\entities\action_event::get_id

(

)

Get the event's ID.

Return values

integer

Implements core_calendar\local\event\entities\event_interface.

get_location()

core_calendar\local\event\entities\action_event::get_location

(

)

Get the event's location.

Return values

location_interface

Implements core_calendar\local\event\entities\event_interface.

get_name()

core_calendar\local\event\entities\action_event::get_name

(

)

Get the event's name.

Return values

string

Implements core_calendar\local\event\entities\event_interface.

get_repeats()

core_calendar\local\event\entities\action_event::get_repeats

(

)

Get repeats of this event or null if the event has no repeats.

Return values

event_collection_interface|null

Implements core_calendar\local\event\entities\event_interface.

get_subscription()

core_calendar\local\event\entities\action_event::get_subscription

(

)

Get the event's subscription.

Return values

proxy_interface

Implements core_calendar\local\event\entities\event_interface.

get_times()

core_calendar\local\event\entities\action_event::get_times

(

)

Get the times associated with the event.

Return values

times_interface

Implements core_calendar\local\event\entities\event_interface.

get_type()

core_calendar\local\event\entities\action_event::get_type

(

)

Get the event's type.

Return values

string

Implements core_calendar\local\event\entities\event_interface.

get_user()

core_calendar\local\event\entities\action_event::get_user

(

)

Get the user object associated with the event.

Return values

proxy_interface

Implements core_calendar\local\event\entities\event_interface.

is_visible()

core_calendar\local\event\entities\action_event::is_visible

(

)

Get the event's visibility.

Return values

bool	true if the event is visible, false otherwise

Implements core_calendar\local\event\entities\event_interface.

---

The documentation for this class was generated from the following file:

• calendar/classes/local/event/entities/action_event.php