Web Service functions for steps. More...

Inheritance diagram for tool_usertours\external\tour:

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	complete_tour ($tourid, $context, $pageurl, $stepid, $stepindex)
	Mark the specified tour as completed for the current user. More...

static	complete_tour_parameters ()
	The parameters for complete_tour. More...

static	complete_tour_returns ()
	The return configuration for complete_tour. More...

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

static	fetch_and_start_tour ($tourid, $context, $pageurl)
	Fetch the tour configuration for the specified tour. More...

static	fetch_and_start_tour_parameters ()
	The parameters for fetch_and_start_tour. More...

static	fetch_and_start_tour_returns ()
	The return configuration for fetch_and_start_tour. More...

static	reset_tour ($tourid, $context, $pageurl)
	Reset the specified tour for the current user. More...

static	reset_tour_parameters ()
	The parameters for reset_tour. More...

static	reset_tour_returns ()
	The return configuration for reset_tour. 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	step_shown ($tourid, $context, $pageurl, $stepid, $stepindex)
	Mark the specified toru step as shown for the current user. More...

static	step_shown_parameters ()
	The parameters for step_shown. More...

static	step_shown_returns ()
	The return configuration for step_shown. More...

static	step_structure_returns ()
	The standard return structure for a step. 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...

Detailed Description

Web Service functions for steps.

Copyright: 2016 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

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

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

◆ complete_tour()

static tool_usertours\external\tour::complete_tour	(	$tourid,
		$context,
		$pageurl,
		$stepid,
		$stepindex
	)

static

Mark the specified tour as completed for the current user.

Parameters

int	$tourid	The ID of the tour.
int	$context	The Context ID of the current page.
string	$pageurl	The path of the current page.
int	$stepid	The step id
int	$stepindex	The step index

Return values

array As described in complete_tour_returns

◆ complete_tour_parameters()

static tool_usertours\external\tour::complete_tour_parameters ( )

static

The parameters for complete_tour.

Return values

external_function_parameters

◆ complete_tour_returns()

static tool_usertours\external\tour::complete_tour_returns ( )

static

The return configuration for complete_tour.

Return values

external_single_structure

◆ 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

◆ fetch_and_start_tour()

static tool_usertours\external\tour::fetch_and_start_tour	(	$tourid,
		$context,
		$pageurl
	)

static

Fetch the tour configuration for the specified tour.

Parameters

int	$tourid	The ID of the tour to fetch.
int	$context	The Context ID of the current page.
string	$pageurl	The path of the current page.

Return values

array As described in fetch_and_start_tour_returns

◆ fetch_and_start_tour_parameters()

static tool_usertours\external\tour::fetch_and_start_tour_parameters ( )

static

The parameters for fetch_and_start_tour.

Return values

external_function_parameters

◆ fetch_and_start_tour_returns()

static tool_usertours\external\tour::fetch_and_start_tour_returns ( )

static

The return configuration for fetch_and_start_tour.

Return values

external_single_structure

◆ 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.

◆ reset_tour()

static tool_usertours\external\tour::reset_tour	(	$tourid,
		$context,
		$pageurl
	)

static

Reset the specified tour for the current user.

Parameters

int	$tourid	The ID of the tour.
int	$context	The Context ID of the current page.
string	$pageurl	The path of the current page requesting the reset.

Return values

array As described in reset_tour_returns

◆ reset_tour_parameters()

static tool_usertours\external\tour::reset_tour_parameters ( )

static

The parameters for reset_tour.

Return values

external_function_parameters

◆ reset_tour_returns()

static tool_usertours\external\tour::reset_tour_returns ( )

static

The return configuration for reset_tour.

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

◆ step_shown()

static tool_usertours\external\tour::step_shown	(	$tourid,
		$context,
		$pageurl,
		$stepid,
		$stepindex
	)

static

Mark the specified toru step as shown for the current user.

Parameters

int	$tourid	The ID of the tour.
int	$context	The Context ID of the current page.
string	$pageurl	The path of the current page.
int	$stepid	The step id
int	$stepindex	The step index

Return values

array As described in complete_tour_returns

◆ step_shown_parameters()

static tool_usertours\external\tour::step_shown_parameters ( )

static

The parameters for step_shown.

Return values

external_function_parameters

◆ step_shown_returns()

static tool_usertours\external\tour::step_shown_returns ( )

static

The return configuration for step_shown.

Return values

external_single_structure

◆ step_structure_returns()

static tool_usertours\external\tour::step_structure_returns ( )

static

The standard return structure for a step.

Return values

external_multiple_structure

◆ 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:

admin/tool/usertours/classes/external/tour.php

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ call_external_function()

◆ clean_returnvalue()

◆ complete_tour()

◆ complete_tour_parameters()

◆ complete_tour_returns()

◆ external_function_info()

◆ fetch_and_start_tour()

◆ fetch_and_start_tour_parameters()

◆ fetch_and_start_tour_returns()

◆ get_context_from_params()

◆ get_context_parameters()

◆ reset_tour()

◆ reset_tour_parameters()

◆ reset_tour_returns()

◆ set_context_restriction()

◆ set_timeout()

◆ step_shown()

◆ step_shown_parameters()

◆ step_shown_returns()

◆ step_structure_returns()

◆ validate_context()

◆ validate_parameters()