core_calendar\local\event\entities\event_interface Interface Reference

Interface for an event class. More...

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

Public Member Functions
	get_category ()
	Get the category object associated with the event.
	get_component ()
	Resolved event component (frankenstyle name of activity module or the 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.

Detailed Description

Interface for an event class.

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

Member Function Documentation

get_category()

core_calendar\local\event\entities\event_interface::get_category

(

)

Get the category object associated with the event.

Return values

proxy_interface

Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.

get_component()

core_calendar\local\event\entities\event_interface::get_component

(

)

Resolved event component (frankenstyle name of activity module or the component)

Return values

string|null

Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.

get_course()

core_calendar\local\event\entities\event_interface::get_course

(

)

Get the course object associated with the event.

Return values

proxy_interface

Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.

get_course_module()

core_calendar\local\event\entities\event_interface::get_course_module

(

)

Get the course module object that created the event.

Return values

proxy_interface

Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.

get_description()

core_calendar\local\event\entities\event_interface::get_description

(

)

Get the event's description.

Return values

description_interface

Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.

get_group()

core_calendar\local\event\entities\event_interface::get_group

(

)

Get the group object associated with the event.

Return values

proxy_interface

Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.

get_id()

core_calendar\local\event\entities\event_interface::get_id

(

)

Get the event's ID.

Return values

integer

Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.

get_location()

core_calendar\local\event\entities\event_interface::get_location

(

)

Get the event's location.

Return values

location_interface

Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.

get_name()

core_calendar\local\event\entities\event_interface::get_name

(

)

Get the event's name.

Return values

string

Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.

get_repeats()

core_calendar\local\event\entities\event_interface::get_repeats

(

)

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

Return values

event_collection_interface|null

Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.

get_subscription()

core_calendar\local\event\entities\event_interface::get_subscription

(

)

Get the event's subscription.

Return values

proxy_interface

Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.

get_times()

core_calendar\local\event\entities\event_interface::get_times

(

)

Get the times associated with the event.

Return values

times_interface

Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.

get_type()

core_calendar\local\event\entities\event_interface::get_type

(

)

Get the event's type.

Return values

string

Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.

get_user()

core_calendar\local\event\entities\event_interface::get_user

(

)

Get the user object associated with the event.

Return values

proxy_interface

Implemented in core_calendar\local\event\entities\action_event, and core_calendar\local\event\entities\event.

is_visible()

core_calendar\local\event\entities\event_interface::is_visible

(

)

Get the event's visibility.

Return values

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.

---

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

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