core_calendar\local\event\entities\event Class Reference

Class representing a calendar event. More...

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

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)
	Constructor. 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
proxy_interface	$category
	$category Category for this event.
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.

Detailed Description

Class representing a calendar event.

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\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
	)

Constructor.

Parameters

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.

Member Function Documentation

get_category()

core_calendar\local\event\entities\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\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\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\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\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\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\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\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\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\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\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\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\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\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/event.php