Namespaces
namespace	calendartype_test_example


namespace	core_calendar


namespace	core_calendar\external


namespace	core_calendar\external\export


namespace	core_calendar\external\subscription


namespace	core_calendar\local


namespace	core_calendar\local\event


namespace	core_calendar\local\event\data_access


namespace	core_calendar\local\event\entities


namespace	core_calendar\local\event\exceptions


namespace	core_calendar\local\event\factories


namespace	core_calendar\local\event\forms


namespace	core_calendar\local\event\mappers


namespace	core_calendar\local\event\proxies


namespace	core_calendar\local\event\strategies


namespace	core_calendar\local\event\value_objects


namespace	core_calendar\output


namespace	core_calendar\privacy

Classes
class	action_event_test_factory
	A test factory that will create action events. More...

class	behat_calendar
	Contains functions used by behat to test functionality. More...

class	behat_calendar_deprecated

class	calendar_event

class	calendar_information
	Calendar information class. More...

class	calendartype_test_example\structure

class	core_calendar\action_factory
	Action factory class. More...

class	core_calendar\external\calendar_day_exporter

class	core_calendar\external\calendar_event_exporter
	Class for displaying a calendar event. More...

class	core_calendar\external\calendar_upcoming_exporter
	Class for displaying the day view. More...

class	core_calendar\external\date_exporter
	Class for normalising the date data. More...

class	core_calendar\external\day_exporter

class	core_calendar\external\day_name_exporter
	Class for displaying the day view. More...

class	core_calendar\external\event_action_exporter
	Class for displaying a calendar event's action. More...

class	core_calendar\external\event_exporter
	Class for displaying a calendar event. More...

class	core_calendar\external\event_exporter_base
	Class for displaying a calendar event. More...

class	core_calendar\external\event_icon_exporter
	Class for displaying a calendar event's icon. More...

class	core_calendar\external\event_subscription_exporter
	Class for displaying a calendar event's subscription. More...

class	core_calendar\external\events_exporter
	Class for displaying a list of calendar events. More...

class	core_calendar\external\events_grouped_by_course_exporter
	Class for displaying a list of calendar events grouped by course id. More...

class	core_calendar\external\events_related_objects_cache
	Class to providing the related objects when exporting a list of calendar events. More...

class	core_calendar\external\events_same_course_exporter
	Class for displaying a list of calendar events for a single course. More...

class	core_calendar\external\export\token
	This is the external method for exporting a calendar token. More...

class	core_calendar\external\footer_options_exporter

class	core_calendar\external\month_exporter
	Class for displaying the month view. More...

class	core_calendar\external\subscription\delete
	Calendar external API for deleting the subscription. More...

class	core_calendar\external\week_day_exporter
	Class for displaying the day on month view. More...

class	core_calendar\external\week_exporter
	Class for displaying the week view. More...

class	core_calendar\local\api
	Class containing the local calendar API. More...

class	core_calendar\local\event\container
	Core container. More...

class	core_calendar\local\event\data_access\event_vault
	Event vault class. More...

interface	core_calendar\local\event\data_access\event_vault_interface
	Interface for an event vault class. More...

class	core_calendar\local\event\entities\action_event
	Class representing an actionable event. More...

interface	core_calendar\local\event\entities\action_event_interface
	Interface for an action event class. More...

interface	core_calendar\local\event\entities\action_interface
	Interface for a action class. More...

class	core_calendar\local\event\entities\event
	Class representing a calendar event. More...

interface	core_calendar\local\event\entities\event_collection_interface
	Interface for an event collection class. More...

interface	core_calendar\local\event\entities\event_interface
	Interface for an event class. More...

class	core_calendar\local\event\entities\repeat_event_collection
	Class representing a collection of repeat events. More...

class	core_calendar\local\event\exceptions\invalid_callback_exception
	Invalid callback exception. More...

class	core_calendar\local\event\exceptions\invalid_parameter_exception
	General invalid parameter exception. More...

class	core_calendar\local\event\exceptions\limit_invalid_parameter_exception
	Invalid limit parameter exception. More...

class	core_calendar\local\event\exceptions\member_does_not_exist_exception
	Member does not exist exception. More...

class	core_calendar\local\event\exceptions\timesort_invalid_parameter_exception
	Invalid timesort parameter exception. More...

interface	core_calendar\local\event\factories\action_factory_interface

class	core_calendar\local\event\factories\event_abstract_factory
	Abstract factory for creating calendar events. More...

class	core_calendar\local\event\factories\event_factory
	Event factory class. More...

interface	core_calendar\local\event\factories\event_factory_interface
	Interface for an event factory class. More...

class	core_calendar\local\event\forms\create
	The mform class for creating a calendar event. More...

class	core_calendar\local\event\forms\update
	The mform class for updating a calendar event. More...

class	core_calendar\local\event\mappers\create_update_form_mapper
	Event create form and update form mapper class. More...

interface	core_calendar\local\event\mappers\create_update_form_mapper_interface
	Interface for a create_update_form_mapper class. More...

class	core_calendar\local\event\mappers\event_mapper
	Event mapper class. More...

interface	core_calendar\local\event\mappers\event_mapper_interface
	Interface for an event mapper class. More...

class	core_calendar\local\event\proxies\cm_info_proxy
	Course module stdClass proxy. More...

class	core_calendar\local\event\proxies\coursecat_proxy
	Course category proxy. More...

interface	core_calendar\local\event\proxies\proxy_interface
	Interface for a proxy class. More...

class	core_calendar\local\event\proxies\std_proxy
	stdClass proxy. More...

class	core_calendar\local\event\strategies\raw_event_retrieval_strategy
	Raw event retrieval strategy. More...

interface	core_calendar\local\event\strategies\raw_event_retrieval_strategy_interface
	Interface for an raw event retrival strategy class. More...

class	core_calendar\local\event\value_objects\action
	Class representing an action a user should take. More...

interface	core_calendar\local\event\value_objects\description_interface
	Interface for a description value object. More...

class	core_calendar\local\event\value_objects\event_description
	Class representing a description value object. More...

class	core_calendar\local\event\value_objects\event_times
	Class representing event times. More...

interface	core_calendar\local\event\value_objects\times_interface
	Interface for various times. More...

class	core_calendar\output\refreshintervalcollection

class	core_calendar\privacy\provider
	Privacy Subsystem for core_calendar implementing metadata, plugin, and user_preference providers. More...

class	core_calendar\rrule_manager
	Defines calendar class to manage recurrence rule (rrule) during ical imports. More...

class	core_calendar\type_base

class	core_calendar\type_factory

class	core_calendar_export_form
	The mform class for creating and editing a calendar. More...

class	core_calendar_external
	Calendar external functions. More...

Functions
	calendar_add_event_allowed ($event)
	Check wether the current user is permitted to add events.

	calendar_add_event_metadata ($event)
	Add calendar event metadata.

	calendar_add_icalendar_event ($event, $unused, $subscriptionid, $timezone='UTC')
	Add an iCalendar event to the Moodle calendar.

	calendar_add_month ($month, $year)
	Get the next following month.

	calendar_add_subscription ($sub)
	Add an iCalendar subscription to the database.

	calendar_can_edit_subscription ($subscriptionorid)
	Checks to see if the user can edit a given subscription feed.

	calendar_can_manage_non_user_event_in_system ($event)
	Can current user manage a non user event in system context.

	calendar_can_manage_user_event ($event)
	Can current user edit/delete/add an user event?

	calendar_day_representation ($tstamp, $now=false, $usecommonwords=true)
	Return the representation day.

	calendar_days_in_month ($month, $year)
	Return the number of days in month.

	calendar_delete_event_allowed ($event)
	Return the capability for deleting a calendar event.

	calendar_delete_subscription ($subscription)
	Delete subscription and all related events.

	calendar_edit_event_allowed ($event, $manualedit=false)
	Return the capability for editing calendar event.

	calendar_events_by_day ($events, $month, $year, &$eventsbyday, &$durationbyday, &$typesbyday, &$courses)
	Get per-day basis events.

	calendar_format_event_location (calendar_event $event)
	Format event location property.

	calendar_format_event_time ($event, $now, $linkparams=null, $usecommonwords=true, $showtime=0)
	Get event format time.

	calendar_get_allowed_event_types (int $courseid=null)
	Get event types the user can create event based on categories, courses and groups the logged in user belongs to.

	calendar_get_allowed_types (&$allowed, $course=null, $groups=null, $category=null)
	Get calendar's allowed types.

	calendar_get_calendar_context ($subscription)
	Helper function to determine the context of a calendar subscription.

	calendar_get_course_cached (&$coursecache, $courseid)
	Get current course cache.

	calendar_get_courselink ($course)
	Get a HTML link to a course.

	calendar_get_days ()
	Return the days of the week.

	calendar_get_default_courses ($courseid=null, $fields=' *', $canmanage=false, int $userid=null)
	Returns the default courses to display on the calendar when there isn't a specific course to display.

	calendar_get_events ($tstart, $tend, $users, $groups, $courses, $withduration=true, $ignorehidden=true, $categories=[])
	Get calendar events.

	calendar_get_events_by_id ($eventids)
	Get calendar events by id.

	calendar_get_eventtype_choices ($courseid)
	Returns option list of available options for the calendar event type, given the current user and course.

	calendar_get_export_import_link_params ()
	Get the list of URL parameters for calendar expport and import links.

	calendar_get_export_token (stdClass $user)
	Get the auth token for exporting the given user calendar.

	calendar_get_filter_types ()
	Get the list of potential calendar filter types as a type => name combination.

	calendar_get_footer_options ($calendar, array $options=[])
	Get the calendar footer options.

	calendar_get_group_cached ($groupid)
	Get group from groupid for calendar display.

	calendar_get_icalendar ($url)
	From a URL, fetch the calendar and return an iCalendar object.

	calendar_get_legacy_events ($tstart, $tend, $users, $groups, $courses, $withduration=true, $ignorehidden=true, $categories=[], $limitnum=0)
	Get legacy calendar events.

	calendar_get_link_href ($linkbase, $d, $m, $y, $time=0)
	Adds day, month, year arguments to a URL and returns a moodle_url object.

	calendar_get_link_next ($text, $linkbase, $d, $m, $y, $accesshide=false, $time=0)
	Build and return a next month HTML link, with an arrow.

	calendar_get_link_previous ($text, $linkbase, $d, $m, $y, $accesshide=false, $time=0)
	Build and return a previous month HTML link, with an arrow.

	calendar_get_module_cached (&$modulecache, $modulename, $instance)
	Get current module cache.

	calendar_get_pollinterval_choices ()
	Returns option list for the poll interval setting.

	calendar_get_starting_weekday ()
	Gets the first day of the week.

	calendar_get_subscription ($id)
	Get the subscription from a given id.

	calendar_get_timestamp ($d, $m, $y, $time=0)
	Calculate the timestamp from the supplied Gregorian Year, Month, and Day.

	calendar_get_view (\calendar_information $calendar, $view, $includenavigation=true, bool $skipevents=false, ?int $lookahead=null)
	Get the calendar view output.

	calendar_import_events_from_ical (iCalendar $ical, int $subscriptionid=null)
	Import events from an iCalendar object into a course calendar.

	calendar_inplace_editable (string $itemtype, int $itemid, int $newvalue)
	Implements the inplace editable feature.

	calendar_internal_update_course_and_group_permission (int $courseid, context $context, array &$types)
	Given a course id, and context, updates the permission types array to add the 'course' or 'group' permission if it is relevant for that course.

	calendar_is_valid_eventtype ($type)
	Check whether the specified event type is valid.

	calendar_output_fragment_event_form ($args)
	Request and render event form fragment.

	calendar_set_event_type_display ($type, $display=null, $user=null)
	Sets the display of the event type given $display.

	calendar_set_filters (array $courseeventsfrom, $ignorefilters=false, stdClass $user=null)
	Returns the courses to load events for.

	calendar_show_event_type ($type, $user=null)
	Checks to see if the requested type of event should be shown for the given user.

	calendar_sub_month ($month, $year)
	Get the previous month.

	calendar_time_representation ($time)
	return the formatted representation time.

	calendar_top_controls ($type, $data)
	Get control options for calendar.

	calendar_update_subscription ($subscription)
	Update a calendar subscription.

	calendar_update_subscription_events ($subscriptionid)
	Fetch a calendar subscription and update the events in the calendar.

	calendar_user_can_add_event ($course)
	See if user can add calendar entries at all used to print the "New Event" button.

	calendar_view_event_allowed (calendar_event $event)
	Return the capability for viewing a calendar event.

	core_calendar_user_preferences ()
	Implements callback user_preferences, lists preferences that users are allowed to update directly.

	create_action_event (array $data)
	Helper function to create an action event.

	create_event ($properties)
	Create a calendar event with the given properties.

	create_group_override_event (string $modulename, int $instanceid, int $courseid, int $groupid)
	Helper function to create an group override calendar event.

	create_standard_events (int $quantity)
	Helper function to create a x number of events for each event type.

	create_user_override_event (string $modulename, int $instanceid, int $userid)
	Helper function to create an user override calendar event.

Variables
global	$CFG

global	core_calendar\external\export::$CFG

const	CALENDAR_DEFAULT_STARTING_WEEKDAY 1
	CALENDAR_DEFAULT_STARTING_WEEKDAY - default value to display the starting weekday.

const	CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD (!defined('MOODLE_INTERNAL')) 21
	These are read by the administration component to provide default values.

const	CALENDAR_DEFAULT_UPCOMING_MAXEVENTS 10
	CALENDAR_DEFAULT_UPCOMING_MAXEVENTS - default value to display the maximum number of upcoming event.

const	CALENDAR_DEFAULT_WEEKEND 65
	CALENDAR_DEFAULT_WEEKEND - default value for weekend (Saturday & Sunday)

const	CALENDAR_EVENT_COURSE 2
	CALENDAR_EVENT_COURSE - Course calendar event types.

const	CALENDAR_EVENT_COURSECAT 16
	CALENDAR_EVENT_COURSECAT - Course category calendar event types.

const	CALENDAR_EVENT_GROUP 4
	CALENDAR_EVENT_GROUP - group calendar event types.

const	CALENDAR_EVENT_SITE 1
	CALENDAR_EVENT_SITE - Site calendar event types.

const	CALENDAR_EVENT_TYPE_ACTION 1
	CALENDAR_EVENT_TYPE_ACTION - Action events.

const	CALENDAR_EVENT_TYPE_STANDARD 0
	CALENDAR_EVENT_TYPE_STANDARD - Standard events.

const	CALENDAR_EVENT_USER 8
	CALENDAR_EVENT_USER - user calendar event types.

const	CALENDAR_EVENT_USER_OVERRIDE_PRIORITY 0
	CALENDAR_EVENT_USER_OVERRIDE_PRIORITY - Constant for the user override priority.

const	CALENDAR_IMPORT_EVENT_INSERTED 2
	CALENDAR_IMPORT_EVENT_INSERTED - imported event was added by insert.

const	CALENDAR_IMPORT_EVENT_SKIPPED -1
	CALENDAR_IMPORT_EVENT_UPDATED_SKIPPED - imported event was skipped.

const	CALENDAR_IMPORT_EVENT_UPDATED 1
	CALENDAR_IMPORT_EVENT_UPDATED - imported event was updated.

const	CALENDAR_IMPORT_FROM_FILE 0
	CALENDAR_IMPORT_FROM_FILE - import the calendar from a file.

const	CALENDAR_IMPORT_FROM_URL 1
	CALENDAR_IMPORT_FROM_URL - import the calendar from a URL.

const	CALENDAR_SUBSCRIPTION_REMOVE 2
	CALENDAR_SUBSCRIPTION_REMOVE - Used to represent remove action for subscriptions in various forms.

const	CALENDAR_SUBSCRIPTION_UPDATE 1
	CALENDAR_SUBSCRIPTION_UPDATE - Used to represent update action for subscriptions in various forms.

const	CALENDAR_TF_12 '%I:%M %p'
	CALENDAR_TF_12 - Calendar time in 12 hours format.

const	CALENDAR_TF_24 '%H:%M'
	CALENDAR_TF_24 - Calendar time in 24 hours format.

const	CALENDAR_URL $CFG->wwwroot.'/calendar/'
	CALENDAR_URL - path to calendar's folder.

	if (!defined( 'MOODLE_INTERNAL'))

Detailed Description

Function Documentation

◆ calendar_add_event_allowed()

calendar_add_event_allowed ( $event )

Check wether the current user is permitted to add events.

Parameters

stdClass $event object of event

Return values

bool	has the capability to add event

◆ calendar_add_event_metadata()

calendar_add_event_metadata ( $event )

Add calendar event metadata.

Deprecated: since 3.9

Parameters

stdClass $event event info

Return values

stdClass\$event metadata

◆ calendar_add_icalendar_event()

calendar_add_icalendar_event	(	$event,
		$unused,
		$subscriptionid,
		$timezone = 'UTC' )

Add an iCalendar event to the Moodle calendar.

Parameters

stdClass	$event	The RFC-2445 iCalendar event
int	$unused	Deprecated
int	$subscriptionid	The iCalendar subscription ID
string	$timezone	The X-WR-TIMEZONE iCalendar property if provided

Exceptions

dml_exception A DML specific exception is thrown for invalid subscriptionids.

Return values

int	Code: CALENDAR_IMPORT_EVENT_UPDATED = updated, CALENDAR_IMPORT_EVENT_INSERTED = inserted, 0 = error

◆ calendar_add_month()

calendar_add_month	(		$month,
			$year )

Get the next following month.

Parameters

int	$month	the number of the month.
int	$year	the number of the year.

Return values

array the following month

◆ calendar_add_subscription()

calendar_add_subscription ( $sub )

Add an iCalendar subscription to the database.

Parameters

stdClass $sub The subscription object (e.g. from the form)

Return values

int	The insert ID, if any.

◆ calendar_can_edit_subscription()

calendar_can_edit_subscription ( $subscriptionorid )

Checks to see if the user can edit a given subscription feed.

Parameters

mixed $subscriptionorid Subscription object or id

Return values

bool	true if current user can edit the subscription else false

◆ calendar_can_manage_non_user_event_in_system()

calendar_can_manage_non_user_event_in_system ( $event )

Can current user manage a non user event in system context.

Parameters

calendar_event | stdClass $event event object

Return values

boolean

◆ calendar_can_manage_user_event()

calendar_can_manage_user_event ( $event )

Can current user edit/delete/add an user event?

Parameters

calendar_event | stdClass $event event object

Return values

bool

◆ calendar_day_representation()

calendar_day_representation	(	$tstamp,
		$now = false,
		$usecommonwords = true )

Return the representation day.

Parameters

int	$tstamp	Timestamp in GMT
int \| bool	$now	current Unix timestamp
bool	$usecommonwords

Return values

string the formatted date/time

◆ calendar_days_in_month()

calendar_days_in_month	(		$month,
			$year )

Return the number of days in month.

Parameters

int	$month	the number of the month.
int	$year	the number of the year

Return values

int

◆ calendar_delete_event_allowed()

calendar_delete_event_allowed ( $event )

Return the capability for deleting a calendar event.

Parameters

calendar_event $event The event object

Return values

bool	Whether the user has permission to delete the event or not.

◆ calendar_delete_subscription()

calendar_delete_subscription ( $subscription )

Delete subscription and all related events.

Parameters

int | stdClass $subscription subscription or it's id, which needs to be deleted.

◆ calendar_edit_event_allowed()

calendar_edit_event_allowed	(		$event,
			$manualedit = false )

Return the capability for editing calendar event.

Parameters

calendar_event	$event	event object
bool	$manualedit	is the event being edited manually by the user

Return values

bool	capability to edit event

◆ calendar_events_by_day()

calendar_events_by_day	(		$events,
			$month,
			$year,
		&	$eventsbyday,
		&	$durationbyday,
		&	$typesbyday,
		&	$courses )

Get per-day basis events.

Parameters

array	$events	list of events
int	$month	the number of the month
int	$year	the number of the year
array	$eventsbyday	event on specific day
array	$durationbyday	duration of the event in days
array	$typesbyday	event type (eg: site, course, user, or group)
array	$courses	list of courses

Return values

void

◆ calendar_format_event_location()

calendar_format_event_location ( calendar_event $event )

Format event location property.

Parameters

calendar_event $event

Return values

string

◆ calendar_format_event_time()

calendar_format_event_time	(	$event,
		$now,
		$linkparams = null,
		$usecommonwords = true,
		$showtime = 0 )

Get event format time.

Parameters

calendar_event	$event	event object
int	$now	current time in gmt
array	$linkparams	list of params for event link
bool	$usecommonwords	the words as formatted date/time.
int	$showtime	determine the show time GMT timestamp

Return values

string\$eventtime link/string for event time

◆ calendar_get_allowed_event_types()

calendar_get_allowed_event_types ( int $courseid = null )

Get event types the user can create event based on categories, courses and groups the logged in user belongs to.

Parameters

int | null $courseid The course id.

Return values

array The array of allowed types.

◆ calendar_get_allowed_types()

calendar_get_allowed_types	(	&	$allowed,
			$course = null,
			$groups = null,
			$category = null )

Get calendar's allowed types.

Parameters

stdClass	$allowed	list of allowed edit for event type
stdClass \| int	$course	object of a course or course id
array	$groups	array of groups for the given course
stdClass \| int	$category	object of a category

◆ calendar_get_calendar_context()

calendar_get_calendar_context ( $subscription )

Helper function to determine the context of a calendar subscription.

Subscriptions can be created in two contexts COURSE, or USER.

Parameters

stdClass $subscription

Return values

context instance

◆ calendar_get_course_cached()

calendar_get_course_cached	(	&	$coursecache,
			$courseid )

Get current course cache.

Parameters

array	$coursecache	list of course cache
int	$courseid	id of the course

Return values

stdClass\$coursecache,[$courseid] return the specific course cache

◆ calendar_get_courselink()

calendar_get_courselink ( $course )

Get a HTML link to a course.

Parameters

int | stdClass $course the course id or course object

Return values

string a link to the course (as HTML); empty if the course id is invalid

◆ calendar_get_days()

calendar_get_days ( )

Return the days of the week.

Return values

array array of days

◆ calendar_get_default_courses()

calendar_get_default_courses	(		$courseid = null,
			$fields = '*',
			$canmanage = false,
		int	$userid = null )

Returns the default courses to display on the calendar when there isn't a specific course to display.

Parameters

int	$courseid	(optional) If passed, an additional course can be returned for admins (the current course).
string	$fields	Comma separated list of course fields to return.
bool	$canmanage	If true, this will return the list of courses the user can create events in, rather than the list of courses they see events from (an admin can always add events in a course calendar, even if they are not enrolled in the course).
int	$userid	(optional) The user which this function returns the default courses for. By default the current user.

Return values

array\$courses Array of courses to display

◆ calendar_get_events()

calendar_get_events	(	$tstart,
		$tend,
		$users,
		$groups,
		$courses,
		$withduration = true,
		$ignorehidden = true,
		$categories = [] )

Get calendar events.

Parameters

int	$tstart	Start time of time range for events
int	$tend	End time of time range for events
array \| int \| boolean	$users	array of users, user id or boolean for all/no user events
array \| int \| boolean	$groups	array of groups, group id or boolean for all/no group events
array \| int \| boolean	$courses	array of courses, course id or boolean for all/no course events
boolean	$withduration	whether only events starting within time range selected or events in progress/already started selected as well
boolean	$ignorehidden	whether to select only visible events or all events
array \| int \| boolean	$categories	array of categories, category id or boolean for all/no course events

Return values

array\$events of selected events or an empty array if there aren't any (or there was an error)

◆ calendar_get_events_by_id()

calendar_get_events_by_id ( $eventids )

Get calendar events by id.

Since: Moodle 2.5

Parameters

array $eventids list of event ids

Return values

array Array of event entries, empty array if nothing found

◆ calendar_get_eventtype_choices()

calendar_get_eventtype_choices ( $courseid )

Returns option list of available options for the calendar event type, given the current user and course.

Parameters

int $courseid The id of the course

Return values

array An array containing the event types the user can create.

◆ calendar_get_export_import_link_params()

calendar_get_export_import_link_params ( )

Get the list of URL parameters for calendar expport and import links.

Return values

array

◆ calendar_get_export_token()

calendar_get_export_token ( stdClass $user )

Get the auth token for exporting the given user calendar.

Parameters

stdClass $user The user to export the calendar for

Return values

string The export token.

◆ calendar_get_filter_types()

calendar_get_filter_types ( )

Get the list of potential calendar filter types as a type => name combination.

Return values

array

◆ calendar_get_footer_options()

calendar_get_footer_options	(		$calendar,
		array	$options = [] )

Get the calendar footer options.

Parameters

calendar_information	$calendar	The calendar information object.
array	$options	Display options for the footer. If an option is not set, a default value will be provided. It consists of: showfullcalendarlink - bool - Whether to show the full calendar link or not. Defaults to false.

Return values

array The data for template and template name.

◆ calendar_get_group_cached()

calendar_get_group_cached ( $groupid )

Get group from groupid for calendar display.

Parameters

int $groupid

Return values

stdClass group object with fields 'id', 'name' and 'courseid'

◆ calendar_get_icalendar()

calendar_get_icalendar ( $url )

From a URL, fetch the calendar and return an iCalendar object.

Parameters

string $url The iCalendar URL

Return values

iCalendar The iCalendar object

◆ calendar_get_legacy_events()

calendar_get_legacy_events	(	$tstart,
		$tend,
		$users,
		$groups,
		$courses,
		$withduration = true,
		$ignorehidden = true,
		$categories = [],
		$limitnum = 0 )

Get legacy calendar events.

Parameters

int	$tstart	Start time of time range for events
int	$tend	End time of time range for events
array \| int \| boolean	$users	array of users, user id or boolean for all/no user events
array \| int \| boolean	$groups	array of groups, group id or boolean for all/no group events
array \| int \| boolean	$courses	array of courses, course id or boolean for all/no course events
boolean	$withduration	whether only events starting within time range selected or events in progress/already started selected as well
boolean	$ignorehidden	whether to select only visible events or all events
array	$categories	array of category ids and/or objects.
int	$limitnum	Number of events to fetch or zero to fetch all.

Return values

array\$events of selected events or an empty array if there aren't any (or there was an error)

◆ calendar_get_link_href()

calendar_get_link_href	(	$linkbase,
		$d,
		$m,
		$y,
		$time = 0 )

Adds day, month, year arguments to a URL and returns a moodle_url object.

Parameters

string \| moodle_url	$linkbase
int	$d	The number of the day.
int	$m	The number of the month.
int	$y	The number of the year.
int	$time	the unixtime, used for multiple calendar support. The values $d, $m and $y are kept for backwards compatibility.

Return values

moodle_url|null\$linkbase

◆ calendar_get_link_next()

calendar_get_link_next	(	$text,
		$linkbase,
		$d,
		$m,
		$y,
		$accesshide = false,
		$time = 0 )

Build and return a next month HTML link, with an arrow.

Deprecated: since Moodle 4.3

Parameters

string	$text	The text label.
string \| moodle_url	$linkbase	The URL stub.
int	$d	the number of the Day
int	$m	The number of the month.
int	$y	The number of the year.
bool	$accesshide	Default visible, or hide from all except screenreaders.
int	$time	the unixtime, used for multiple calendar support. The values $d, $m and $y are kept for backwards compatibility.

Return values

string HTML string.

◆ calendar_get_link_previous()

calendar_get_link_previous	(	$text,
		$linkbase,
		$d,
		$m,
		$y,
		$accesshide = false,
		$time = 0 )

Build and return a previous month HTML link, with an arrow.

Deprecated: since Moodle 4.3

Parameters

string	$text	The text label.
string \| moodle_url	$linkbase	The URL stub.
int	$d	The number of the date.
int	$m	The number of the month.
int	$y	year The number of the year.
bool	$accesshide	Default visible, or hide from all except screenreaders.
int	$time	the unixtime, used for multiple calendar support. The values $d, $m and $y are kept for backwards compatibility.

Return values

string HTML string.

◆ calendar_get_module_cached()

calendar_get_module_cached	(	&	$modulecache,
			$modulename,
			$instance )

Get current module cache.

Only use this method if you do not know courseid. Otherwise use: get_fast_modinfo($courseid)->instances[$modulename][$instance]

Parameters

array	$modulecache	in memory module cache
string	$modulename	name of the module
int	$instance	module instance number

Return values

stdClass|bool\$module information

◆ calendar_get_pollinterval_choices()

calendar_get_pollinterval_choices ( )

Returns option list for the poll interval setting.

Return values

array An array of poll interval options. Interval => description.

◆ calendar_get_starting_weekday()

calendar_get_starting_weekday ( )

Gets the first day of the week.

Used to be define('CALENDAR_STARTING_WEEKDAY', blah);

Return values

int

◆ calendar_get_subscription()

calendar_get_subscription ( $id )

Get the subscription from a given id.

Since: Moodle 2.5

Parameters

int $id id of the subscription

Return values

stdClass Subscription record from DB

Exceptions

moodle_exception for an invalid id

◆ calendar_get_timestamp()

calendar_get_timestamp	(	$d,
		$m,
		$y,
		$time = 0 )

Calculate the timestamp from the supplied Gregorian Year, Month, and Day.

Parameters

int	$d	The day
int	$m	The month
int	$y	The year
int	$time	The timestamp to use instead of a separate y/m/d.

Return values

int	The timestamp

◆ calendar_get_view()

calendar_get_view	(	\calendar_information	$calendar,
			$view,
			$includenavigation = true,
		bool	$skipevents = false,
		?int	$lookahead = null )

Get the calendar view output.

Parameters

calendar_information	$calendar	The calendar being represented
string	$view	The type of calendar to have displayed
bool	$includenavigation	Whether to include navigation
bool	$skipevents	Whether to load the events or not
int	$lookahead	Overwrites site and users's lookahead setting.

Return values

array[array,string]

◆ calendar_import_events_from_ical()

calendar_import_events_from_ical	(	iCalendar	$ical,
		int	$subscriptionid = null )

Import events from an iCalendar object into a course calendar.

Parameters

iCalendar	$ical	The iCalendar object.
int \| null	$subscriptionid	The subscription ID.

Return values

array A log of the import progress, including errors.

◆ calendar_inplace_editable()

calendar_inplace_editable	(	string	$itemtype,
		int	$itemid,
		int	$newvalue )

Implements the inplace editable feature.

Parameters

string	$itemtype	Type of the inplace editable element
int	$itemid	Id of the item to edit
int	$newvalue	New value of the item

Return values

core\output\inplace_editable

◆ calendar_internal_update_course_and_group_permission()

calendar_internal_update_course_and_group_permission	(	int	$courseid,
		context	$context,
		array &	$types )

Given a course id, and context, updates the permission types array to add the 'course' or 'group' permission if it is relevant for that course.

For efficiency, if they already have 'course' or 'group' then it skips checks.

Do not call this function directly, it is only for use by calendar_get_allowed_event_types().

Parameters

int	$courseid	Course id
context	$context	Context for that course
array	$types	Current permissions

◆ calendar_is_valid_eventtype()

calendar_is_valid_eventtype ( $type )

Check whether the specified event type is valid.

Parameters

string $type

Return values

bool

◆ calendar_output_fragment_event_form()

calendar_output_fragment_event_form ( $args )

Request and render event form fragment.

Parameters

array $args The fragment arguments.

Return values

string The rendered mform fragment.

◆ calendar_set_event_type_display()

calendar_set_event_type_display	(	$type,
		$display = null,
		$user = null )

Sets the display of the event type given $display.

If $display = true the event type will be shown. If $display = false the event type will NOT be shown. If $display = null the current value will be toggled and saved.

Parameters

int	$type	object of CALENDAR_EVENT_XXX
bool	$display	option to display event type
stdClass \| int	$user	moodle user object or id, null means current user

◆ calendar_set_filters()

calendar_set_filters	(	array	$courseeventsfrom,
			$ignorefilters = false,
		stdClass	$user = null )

Returns the courses to load events for.

Parameters

array	$courseeventsfrom	An array of courses to load calendar events for
bool	$ignorefilters	specify the use of filters, false is set as default
stdClass	$user	The user object. This defaults to the global $USER object.

Return values

array An array of courses, groups, and user to load calendar events for based upon filters

◆ calendar_show_event_type()

calendar_show_event_type	(		$type,
			$user = null )

Checks to see if the requested type of event should be shown for the given user.

Parameters

int	$type	The type to check the display for (default is to display all)
stdClass \| int \| null	$user	The user to check for - by default the current user

Return values

bool	True if the tyep should be displayed false otherwise

◆ calendar_sub_month()

calendar_sub_month	(		$month,
			$year )

Get the previous month.

Parameters

int	$month	the number of the month.
int	$year	the number of the year.

Return values

array previous month

◆ calendar_time_representation()

calendar_time_representation ( $time )

return the formatted representation time.

Parameters

int $time the timestamp in UTC, as obtained from the database

Return values

string the formatted date/time

◆ calendar_top_controls()

calendar_top_controls	(		$type,
			$data )

Get control options for calendar.

Deprecated: since Moodle 4.3

Parameters

string	$type	of calendar
array	$data	calendar information

Return values

string\$content return available control for the calendar in html

◆ calendar_update_subscription()

calendar_update_subscription ( $subscription )

Update a calendar subscription.

Also updates the associated cache.

Parameters

stdClass | array $subscription Subscription record.

Exceptions

coding_exception If something goes wrong

Since: Moodle 2.5

◆ calendar_update_subscription_events()

calendar_update_subscription_events ( $subscriptionid )

Fetch a calendar subscription and update the events in the calendar.

Parameters

int $subscriptionid The course ID for the calendar.

Return values

array A log of the import progress, including errors.

◆ calendar_user_can_add_event()

calendar_user_can_add_event ( $course )

See if user can add calendar entries at all used to print the "New Event" button.

Parameters

stdClass $course object of a course or course id

Return values

bool	has the capability to add at least one event type

◆ calendar_view_event_allowed()

calendar_view_event_allowed ( calendar_event $event )

Return the capability for viewing a calendar event.

Parameters

calendar_event $event event object

Return values

boolean

◆ core_calendar_user_preferences()

core_calendar_user_preferences ( )

Implements callback user_preferences, lists preferences that users are allowed to update directly.

Used in {

See also: core_user\fill_preferences_cache()}, see also {; useredit_update_user_preference()}

Return values

array

◆ create_action_event()

create_action_event ( array $data )

Helper function to create an action event.

Parameters

array $data The event data.

Return values

bool|calendar_event

◆ create_event()

create_event ( $properties )

Create a calendar event with the given properties.

Parameters

array $properties The properties to set on the event

Return values

calendar_event

◆ create_group_override_event()

create_group_override_event	(	string	$modulename,
		int	$instanceid,
		int	$courseid,
		int	$groupid )

Helper function to create an group override calendar event.

Parameters

string	$modulename	The modulename.
int	$instanceid	The instance id.
int	$courseid	The course id.
int	$groupid	The group id.

Return values

calendar_event|false

◆ create_standard_events()

create_standard_events ( int $quantity )

Helper function to create a x number of events for each event type.

Parameters

int $quantity The quantity of events to be created.

Return values

array List of created events.

◆ create_user_override_event()

create_user_override_event	(	string	$modulename,
		int	$instanceid,
		int	$userid )

Helper function to create an user override calendar event.

Parameters

string	$modulename	The modulename.
int	$instanceid	The instance id.
int	$userid	The user id.

Return values

calendar_event|false

Variable Documentation

◆ CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD

const CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD(!defined( 'MOODLE_INTERNAL')) ( ! defined 'MOODLE_INTERNAL' ) 21

These are read by the administration component to provide default values.

CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD - default value of upcoming event preference

Namespaces

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ calendar_add_event_allowed()

◆ calendar_add_event_metadata()

◆ calendar_add_icalendar_event()

◆ calendar_add_month()

◆ calendar_add_subscription()

◆ calendar_can_edit_subscription()

◆ calendar_can_manage_non_user_event_in_system()

◆ calendar_can_manage_user_event()

◆ calendar_day_representation()

◆ calendar_days_in_month()

◆ calendar_delete_event_allowed()

◆ calendar_delete_subscription()

◆ calendar_edit_event_allowed()

◆ calendar_events_by_day()

◆ calendar_format_event_location()

◆ calendar_format_event_time()

◆ calendar_get_allowed_event_types()

◆ calendar_get_allowed_types()

◆ calendar_get_calendar_context()

◆ calendar_get_course_cached()

◆ calendar_get_courselink()

◆ calendar_get_days()

◆ calendar_get_default_courses()

◆ calendar_get_events()

◆ calendar_get_events_by_id()

◆ calendar_get_eventtype_choices()

◆ calendar_get_export_import_link_params()

◆ calendar_get_export_token()

◆ calendar_get_filter_types()

◆ calendar_get_footer_options()

◆ calendar_get_group_cached()

◆ calendar_get_icalendar()

◆ calendar_get_legacy_events()

◆ calendar_get_link_href()

◆ calendar_get_link_next()

◆ calendar_get_link_previous()

◆ calendar_get_module_cached()

◆ calendar_get_pollinterval_choices()

◆ calendar_get_starting_weekday()

◆ calendar_get_subscription()

◆ calendar_get_timestamp()

◆ calendar_get_view()

◆ calendar_import_events_from_ical()

◆ calendar_inplace_editable()

◆ calendar_internal_update_course_and_group_permission()

◆ calendar_is_valid_eventtype()

◆ calendar_output_fragment_event_form()

◆ calendar_set_event_type_display()

◆ calendar_set_filters()

◆ calendar_show_event_type()

◆ calendar_sub_month()

◆ calendar_time_representation()

◆ calendar_top_controls()

◆ calendar_update_subscription()

◆ calendar_update_subscription_events()

◆ calendar_user_can_add_event()

◆ calendar_view_event_allowed()

◆ core_calendar_user_preferences()

◆ create_action_event()

◆ create_event()

◆ create_group_override_event()

◆ create_standard_events()

◆ create_user_override_event()

Variable Documentation

◆ CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD