tool_usertours\external\tour Class Reference

Inheritance diagram for tool_usertours\external\tour:

Static Public Member Functions
static	complete_tour ($tourid, $context, $pageurl, $stepid, $stepindex)
	Mark the specified tour as completed for the current user.
static	complete_tour_parameters ()
	The parameters for complete_tour.
static	complete_tour_returns ()
	The return configuration for complete_tour.
static	fetch_and_start_tour ($tourid, $context, $pageurl)
	Fetch the tour configuration for the specified tour.
static	fetch_and_start_tour_parameters ()
	The parameters for fetch_and_start_tour.
static	fetch_and_start_tour_returns ()
	The return configuration for fetch_and_start_tour.
static	reset_tour ($tourid, $context, $pageurl)
	Reset the specified tour for the current user.
static	reset_tour_parameters ()
	The parameters for reset_tour.
static	reset_tour_returns ()
	The return configuration for reset_tour.
static	step_shown ($tourid, $context, $pageurl, $stepid, $stepindex)
	Mark the specified toru step as shown for the current user.
static	step_shown_parameters ()
	The parameters for step_shown.
static	step_shown_returns ()
	The return configuration for step_shown.
static	step_structure_returns ()
	The standard return structure for a step.

Member Function Documentation

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

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

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

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

---

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

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