Inheritance diagram for core_calendar_external:

Static Public Member Functions
static	call_external_function ($function, $args, $ajaxonly=false)
	Call an external function validating all params/returns correctly. More...

static	clean_returnvalue (external_description $description, $response)
	Clean response If a response attribute is unknown from the description, we just ignore the attribute. More...

static	create_calendar_events ($events)
	Create calendar events. More...

static	create_calendar_events_parameters ()
	Returns description of method parameters. More...

static	create_calendar_events_returns ()
	Returns description of method result value. More...

static	delete_calendar_events ($events)
	Delete Calendar events. More...

static	delete_calendar_events_parameters ()
	Returns description of method parameters. More...

static	delete_calendar_events_returns ()
	Returns description of method result value. More...

static	external_function_info ($function, $strictness=MUST_EXIST)
	Returns detailed function information. More...

static	get_allowed_event_types ($courseid=0)
	Get the type of events a user can create in the given course. More...

static	get_allowed_event_types_parameters ()
	Returns description of method parameters. More...

static	get_allowed_event_types_returns ()
	Returns description of method result value. More...

static	get_calendar_access_information ($courseid=0)
	Convenience function to retrieve some permissions information for the given course calendar. More...

static	get_calendar_access_information_parameters ()
	Returns description of method parameters. More...

static	get_calendar_access_information_returns ()
	Returns description of method result value. More...

static	get_calendar_action_events_by_course ( $courseid, $timesortfrom=null, $timesortto=null, $aftereventid=0, $limitnum=20)
	Get calendar action events for the given course. More...

static	get_calendar_action_events_by_course_parameters ()
	Returns description of method parameters. More...

static	get_calendar_action_events_by_course_returns ()
	Returns description of method result value. More...

static	get_calendar_action_events_by_courses (array $courseids, $timesortfrom=null, $timesortto=null, $limitnum=10)
	Get calendar action events for a given list of courses. More...

static	get_calendar_action_events_by_courses_parameters ()
	Returns description of method parameters. More...

static	get_calendar_action_events_by_courses_returns ()
	Returns description of method result value. More...

static	get_calendar_action_events_by_timesort ($timesortfrom=0, $timesortto=null, $aftereventid=0, $limitnum=20, $limittononsuspendedevents=false, $userid=null)
	Get calendar action events based on the timesort value. More...

static	get_calendar_action_events_by_timesort_parameters ()
	Returns description of method parameters. More...

static	get_calendar_action_events_by_timesort_returns ()
	Returns description of method result value. More...

static	get_calendar_day_view ($year, $month, $day, $courseid, $categoryid)
	Get data for the daily calendar view. More...

static	get_calendar_day_view_parameters ()
	Returns description of method parameters. More...

static	get_calendar_day_view_returns ()
	Returns description of method result value. More...

static	get_calendar_event_by_id ($eventid)
	Get calendar event by id. More...

static	get_calendar_event_by_id_parameters ()
	Returns description of method parameters. More...

static	get_calendar_event_by_id_returns ()
	Returns description of method result value. More...

static	get_calendar_events ($events=array(), $options=array())
	Get Calendar events. More...

static	get_calendar_events_parameters ()
	Returns description of method parameters. More...

static	get_calendar_events_returns ()
	Returns description of method result value. More...

static	get_calendar_monthly_view ($year, $month, $courseid, $categoryid, $includenavigation, $mini, $day)
	Get data for the monthly calendar view. More...

static	get_calendar_monthly_view_parameters ()
	Returns description of method parameters. More...

static	get_calendar_monthly_view_returns ()
	Returns description of method result value. More...

static	get_calendar_upcoming_view ($courseid, $categoryid)
	Get data for the monthly calendar view. More...

static	get_calendar_upcoming_view_parameters ()
	Returns description of method parameters. More...

static	get_calendar_upcoming_view_returns ()
	Returns description of method result value. More...

static	get_timestamps ($datetimes)
	Convert the specified dates into unix timestamps. More...

static	get_timestamps_parameters ()
	Describes the parameters for get_timestamps. More...

static	get_timestamps_returns ()
	Describes the timestamps return format. More...

static	set_context_restriction ($context)
	Set context restriction for all following subsequent function calls. More...

static	set_timeout ($seconds=360)
	This method has to be called before every operation that takes a longer time to finish! More...

static	submit_create_update_form ($formdata)
	Handles the event form submission. More...

static	submit_create_update_form_parameters ()
	Returns description of method parameters. More...

static	submit_create_update_form_returns ()
	Returns description of method result value. More...

static	update_event_start_day ($eventid, $daytimestamp)
	Change the start day for the given calendar event to the day that corresponds with the provided timestamp. More...

static	update_event_start_day_parameters ()
	Returns description of method parameters. More...

static	update_event_start_day_returns ()
	Returns description of method result value. More...

static	validate_context ($context)
	Makes sure user may execute functions in this context. More...

static	validate_parameters (external_description $description, $params)
	Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown. More...

Static Protected Member Functions
static	get_context_from_params ($param)
	Get context from passed parameters. More...

static	get_context_parameters ()
	Returns a prepared structure to use a context parameters. More...

Member Function Documentation

◆ call_external_function()

static external_api::call_external_function	(	$function,
		$args,
		$ajaxonly = `false`
	)

staticinherited

Call an external function validating all params/returns correctly.

Note that an external function may modify the state of the current page, so this wrapper saves and restores tha PAGE and COURSE global variables before/after calling the external function.

Parameters

string	$function	A webservice function name.
array	$args	Params array (named params)
boolean	$ajaxonly	If true, an extra check will be peformed to see if ajax is required.

Return values

array containing keys for error (bool), exception and data.

◆ clean_returnvalue()

static external_api::clean_returnvalue	(	external_description	$description,
			$response
	)

staticinherited

Clean response If a response attribute is unknown from the description, we just ignore the attribute.

If a response attribute is incorrect, invalid_response_exception is thrown. Note: this function is similar to validate parameters, however it is distinct because parameters validation must be distinct from cleaning return values.

Parameters

external_description	$description	description of the return values
mixed	$response	the actual response

Return values

mixed response with added defaults for optional items, invalid_response_exception thrown if any problem found

Author: 2010 Jerome Mouneyrac

Since: Moodle 2.0

◆ create_calendar_events()

static core_calendar_external::create_calendar_events ( $events )

static

Create calendar events.

Parameters

array $events A list of events to create.

Return values

array array of events created.

Since: Moodle 2.5

Exceptions

moodle_exception if user doesnt have the permission to create events.

◆ create_calendar_events_parameters()

static core_calendar_external::create_calendar_events_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters.

Since: Moodle 2.5

◆ create_calendar_events_returns()

static core_calendar_external::create_calendar_events_returns ( )

static

Returns description of method result value.

Return values

external_description.

Since: Moodle 2.5

◆ delete_calendar_events()

static core_calendar_external::delete_calendar_events ( $events )

static

Delete Calendar events.

Parameters

array $eventids A list of event ids with repeat flag to delete

Return values

null

Since: Moodle 2.5

◆ delete_calendar_events_parameters()

static core_calendar_external::delete_calendar_events_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 2.5

◆ delete_calendar_events_returns()

static core_calendar_external::delete_calendar_events_returns ( )

static

Returns description of method result value.

Return values

external_description

Since: Moodle 2.5

◆ external_function_info()

static external_api::external_function_info	(	$function,
		$strictness = `MUST_EXIST`
	)

staticinherited

Returns detailed function information.

Parameters

string \| object	$function	name of external function or record from external_function
int	$strictness	IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; MUST_EXIST means throw exception if no record or multiple records found

Return values

stdClass description or false if not found or exception thrown

Since: Moodle 2.0

◆ get_allowed_event_types()

static core_calendar_external::get_allowed_event_types ( $courseid = 0 )

static

Get the type of events a user can create in the given course.

Parameters

int $courseid Course to check, empty for site.

Return values

array The types allowed

Exceptions

moodle_exception

Since: Moodle 3.7

◆ get_allowed_event_types_parameters()

static core_calendar_external::get_allowed_event_types_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters.

Since: Moodle 3.7

◆ get_allowed_event_types_returns()

static core_calendar_external::get_allowed_event_types_returns ( )

static

Returns description of method result value.

Return values

external_description.

Since: Moodle 3.7

◆ get_calendar_access_information()

static core_calendar_external::get_calendar_access_information ( $courseid = 0 )

static

Convenience function to retrieve some permissions information for the given course calendar.

Parameters

int $courseid Course to check, empty for site.

Return values

array The access information

Exceptions

moodle_exception

Since: Moodle 3.7

◆ get_calendar_access_information_parameters()

static core_calendar_external::get_calendar_access_information_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters.

Since: Moodle 3.7

◆ get_calendar_access_information_returns()

static core_calendar_external::get_calendar_access_information_returns ( )

static

Returns description of method result value.

Return values

external_description.

Since: Moodle 3.7

◆ get_calendar_action_events_by_course()

static core_calendar_external::get_calendar_action_events_by_course	(	$courseid,
		$timesortfrom = `null`,
		$timesortto = `null`,
		$aftereventid = `0`,
		$limitnum = `20`
	)

static

Get calendar action events for the given course.

Since: Moodle 3.3

Parameters

int	$courseid	Only events in this course
null \| int	$timesortfrom	Events after this time (inclusive)
null \| int	$timesortto	Events before this time (inclusive)
null \| int	$aftereventid	Get events with ids greater than this one
int	$limitnum	Limit the number of results to this value

Return values

array

◆ get_calendar_action_events_by_course_parameters()

static core_calendar_external::get_calendar_action_events_by_course_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

◆ get_calendar_action_events_by_course_returns()

static core_calendar_external::get_calendar_action_events_by_course_returns ( )

static

Returns description of method result value.

Return values

external_description

◆ get_calendar_action_events_by_courses()

static core_calendar_external::get_calendar_action_events_by_courses	(	array	$courseids,
			$timesortfrom = `null`,
			$timesortto = `null`,
			$limitnum = `10`
	)

static

Get calendar action events for a given list of courses.

Since: Moodle 3.3

Parameters

array	$courseids	Only include events for these courses
null \| int	$timesortfrom	Events after this time (inclusive)
null \| int	$timesortto	Events before this time (inclusive)
int	$limitnum	Limit the number of results per course to this value

Return values

array

◆ get_calendar_action_events_by_courses_parameters()

static core_calendar_external::get_calendar_action_events_by_courses_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

◆ get_calendar_action_events_by_courses_returns()

static core_calendar_external::get_calendar_action_events_by_courses_returns ( )

static

Returns description of method result value.

Return values

external_description

◆ get_calendar_action_events_by_timesort()

static core_calendar_external::get_calendar_action_events_by_timesort	(	$timesortfrom = `0`,
		$timesortto = `null`,
		$aftereventid = `0`,
		$limitnum = `20`,
		$limittononsuspendedevents = `false`,
		$userid = `null`
	)

static

Get calendar action events based on the timesort value.

Since: Moodle 3.3

Parameters

null \| int	$timesortfrom	Events after this time (inclusive)
null \| int	$timesortto	Events before this time (inclusive)
null \| int	$aftereventid	Get events with ids greater than this one
int	$limitnum	Limit the number of results to this value
null \| int	$userid	The user id

Return values

array

◆ get_calendar_action_events_by_timesort_parameters()

static core_calendar_external::get_calendar_action_events_by_timesort_parameters ( )

static

Returns description of method parameters.

Since: Moodle 3.3

Return values

external_function_parameters

◆ get_calendar_action_events_by_timesort_returns()

static core_calendar_external::get_calendar_action_events_by_timesort_returns ( )

static

Returns description of method result value.

Since: Moodle 3.3

Return values

external_description

◆ get_calendar_day_view()

static core_calendar_external::get_calendar_day_view	(	$year,
		$month,
		$day,
		$courseid,
		$categoryid
	)

static

Get data for the daily calendar view.

Parameters

int	$year	The year to be shown
int	$month	The month to be shown
int	$day	The day to be shown
int	$courseid	The course to be included

Return values

array

◆ get_calendar_day_view_parameters()

static core_calendar_external::get_calendar_day_view_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

◆ get_calendar_day_view_returns()

static core_calendar_external::get_calendar_day_view_returns ( )

static

Returns description of method result value.

Return values

external_description

◆ get_calendar_event_by_id()

static core_calendar_external::get_calendar_event_by_id ( $eventid )

static

Get calendar event by id.

Parameters

int $eventid The calendar event id to be retrieved.

Return values

array Array of event details

◆ get_calendar_event_by_id_parameters()

static core_calendar_external::get_calendar_event_by_id_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

◆ get_calendar_event_by_id_returns()

static core_calendar_external::get_calendar_event_by_id_returns ( )

static

Returns description of method result value.

Return values

external_description

◆ get_calendar_events()

static core_calendar_external::get_calendar_events	(	$events = `array()`,
		$options = `array()`
	)

static

Get Calendar events.

Parameters

array	$events	A list of events
array	$options	various options

Return values

array Array of event details

Since: Moodle 2.5

◆ get_calendar_events_parameters()

static core_calendar_external::get_calendar_events_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 2.5

◆ get_calendar_events_returns()

static core_calendar_external::get_calendar_events_returns ( )

static

Returns description of method result value.

Return values

external_description

Since: Moodle 2.5

◆ get_calendar_monthly_view()

static core_calendar_external::get_calendar_monthly_view	(	$year,
		$month,
		$courseid,
		$categoryid,
		$includenavigation,
		$mini,
		$day
	)

static

Get data for the monthly calendar view.

Parameters

int	$year	The year to be shown
int	$month	The month to be shown
int	$courseid	The course to be included
int	$categoryid	The category to be included
bool	$includenavigation	Whether to include navigation
bool	$mini	Whether to return the mini month view or not
int	$day	The day we want to keep as the current day

Return values

array

◆ get_calendar_monthly_view_parameters()

static core_calendar_external::get_calendar_monthly_view_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

◆ get_calendar_monthly_view_returns()

static core_calendar_external::get_calendar_monthly_view_returns ( )

static

Returns description of method result value.

Return values

external_description

◆ get_calendar_upcoming_view()

static core_calendar_external::get_calendar_upcoming_view	(	$courseid,
		$categoryid
	)

static

Get data for the monthly calendar view.

Parameters

int	$courseid	The course to be included
int	$categoryid	The category to be included

Return values

array

◆ get_calendar_upcoming_view_parameters()

static core_calendar_external::get_calendar_upcoming_view_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

◆ get_calendar_upcoming_view_returns()

static core_calendar_external::get_calendar_upcoming_view_returns ( )

static

Returns description of method result value.

Return values

external_description

◆ get_context_from_params()

static external_api::get_context_from_params ( $param )

staticprotectedinherited

Get context from passed parameters.

The passed array must either contain a contextid or a combination of context level and instance id to fetch the context. For example, the context level can be "course" and instanceid can be courseid.

See context_helper::get_all_levels() for a list of valid context levels.

Parameters

array $param

Since: Moodle 2.6

Exceptions

invalid_parameter_exception

Return values

context

◆ get_context_parameters()

static external_api::get_context_parameters ( )

staticprotectedinherited

Returns a prepared structure to use a context parameters.

Return values

external_single_structure

Reimplemented in tool_lp\external, and core_competency\external.

◆ get_timestamps()

static core_calendar_external::get_timestamps ( $datetimes )

static

Convert the specified dates into unix timestamps.

Parameters

array $datetimes Array of arrays containing date time details, each in the format: ['year' => a, 'month' => b, 'day' => c, 'hour' => d (optional), 'minute' => e (optional), 'key' => 'x' (optional)]

Return values

array Provided array of dates converted to unix timestamps

Exceptions

moodle_exception If one or more of the dates provided does not convert to a valid timestamp.

◆ get_timestamps_parameters()

static core_calendar_external::get_timestamps_parameters ( )

static

Describes the parameters for get_timestamps.

Return values

external_function_parameters

◆ get_timestamps_returns()

static core_calendar_external::get_timestamps_returns ( )

static

Describes the timestamps return format.

Return values

external_single_structure

◆ set_context_restriction()

static external_api::set_context_restriction ( $context )

staticinherited

Set context restriction for all following subsequent function calls.

Parameters

stdClass $context the context restriction

Since: Moodle 2.0

◆ set_timeout()

static external_api::set_timeout ( $seconds = 360 )

staticinherited

This method has to be called before every operation that takes a longer time to finish!

Parameters

int $seconds max expected time the next operation needs

Since: Moodle 2.0

◆ submit_create_update_form()

static core_calendar_external::submit_create_update_form ( $formdata )

static

Handles the event form submission.

Parameters

string $formdata The event form data in a URI encoded param string

Return values

array The created or modified event

Exceptions

moodle_exception

◆ submit_create_update_form_parameters()

static core_calendar_external::submit_create_update_form_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters.

◆ submit_create_update_form_returns()

static core_calendar_external::submit_create_update_form_returns ( )

static

Returns description of method result value.

Return values

external_description.

◆ update_event_start_day()

static core_calendar_external::update_event_start_day	(	$eventid,
		$daytimestamp
	)

static

Change the start day for the given calendar event to the day that corresponds with the provided timestamp.

The timestamp only needs to be anytime within the desired day as only the date data is extracted from it.

The event's original time of day is maintained, only the date is shifted.

Parameters

int	$eventid	Id of event to be updated
int	$daytimestamp	Timestamp for the new start day

Return values

array

◆ update_event_start_day_parameters()

static core_calendar_external::update_event_start_day_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

◆ update_event_start_day_returns()

static core_calendar_external::update_event_start_day_returns ( )

static

Returns description of method result value.

Return values

external_description

◆ validate_context()

static external_api::validate_context ( $context )

staticinherited

Makes sure user may execute functions in this context.

Parameters

stdClass $context

Since: Moodle 2.0

◆ validate_parameters()

static external_api::validate_parameters	(	external_description	$description,
			$params
	)

staticinherited

Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown.

This is a simple recursive method which is intended to be called from each implementation method of external API.

Parameters

external_description	$description	description of parameters
mixed	$params	the actual parameters

Return values

mixed params with added defaults for optional items, invalid_parameters_exception thrown if any problem found

Since: Moodle 2.0

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

calendar/externallib.php

Static Public Member Functions

Static Protected Member Functions

Member Function Documentation

◆ call_external_function()

◆ clean_returnvalue()

◆ create_calendar_events()

◆ create_calendar_events_parameters()

◆ create_calendar_events_returns()

◆ delete_calendar_events()

◆ delete_calendar_events_parameters()

◆ delete_calendar_events_returns()

◆ external_function_info()

◆ get_allowed_event_types()

◆ get_allowed_event_types_parameters()

◆ get_allowed_event_types_returns()

◆ get_calendar_access_information()

◆ get_calendar_access_information_parameters()

◆ get_calendar_access_information_returns()

◆ get_calendar_action_events_by_course()

◆ get_calendar_action_events_by_course_parameters()

◆ get_calendar_action_events_by_course_returns()

◆ get_calendar_action_events_by_courses()

◆ get_calendar_action_events_by_courses_parameters()

◆ get_calendar_action_events_by_courses_returns()

◆ get_calendar_action_events_by_timesort()

◆ get_calendar_action_events_by_timesort_parameters()

◆ get_calendar_action_events_by_timesort_returns()

◆ get_calendar_day_view()

◆ get_calendar_day_view_parameters()

◆ get_calendar_day_view_returns()

◆ get_calendar_event_by_id()

◆ get_calendar_event_by_id_parameters()

◆ get_calendar_event_by_id_returns()

◆ get_calendar_events()

◆ get_calendar_events_parameters()

◆ get_calendar_events_returns()

◆ get_calendar_monthly_view()

◆ get_calendar_monthly_view_parameters()

◆ get_calendar_monthly_view_returns()

◆ get_calendar_upcoming_view()

◆ get_calendar_upcoming_view_parameters()

◆ get_calendar_upcoming_view_returns()

◆ get_context_from_params()

◆ get_context_parameters()

◆ get_timestamps()

◆ get_timestamps_parameters()

◆ get_timestamps_returns()

◆ set_context_restriction()

◆ set_timeout()

◆ submit_create_update_form()

◆ submit_create_update_form_parameters()

◆ submit_create_update_form_returns()

◆ update_event_start_day()

◆ update_event_start_day_parameters()

◆ update_event_start_day_returns()

◆ validate_context()

◆ validate_parameters()