report_insights\external Class Reference

This is the external API for this component. More...

Inheritance diagram for report_insights\external:

Static Public Member Functions
static	action_executed (string $actionname, array $predictionids)
	Stores an action executed over a group of predictions.
static	action_executed_parameters ()
	action_executed parameters.
static	action_executed_returns ()
	action_executed return
static	set_fixed_prediction ($predictionid)
	Flags a prediction as fixed so no need to display it any more.
static	set_fixed_prediction_is_deprecated ()
	Deprecated in favour of action_executed.
static	set_fixed_prediction_parameters ()
	set_fixed_prediction parameters.
static	set_fixed_prediction_returns ()
	set_fixed_prediction return
static	set_notuseful_prediction ($predictionid)
	Flags a prediction as fixed so no need to display it any more.
static	set_notuseful_prediction_is_deprecated ()
	Deprecated in favour of action_executed.
static	set_notuseful_prediction_parameters ()
	set_notuseful_prediction parameters.
static	set_notuseful_prediction_returns ()
	set_notuseful_prediction return

Static Protected Member Functions
static	validate_prediction ($predictionid)
	Validates access to the prediction and returns it.

Detailed Description

This is the external API for this component.

Copyright

2017 David Monllao

License

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

Member Function Documentation

action_executed()

static report_insights\external::action_executed ( string $actionname, array $predictionids )

static

Stores an action executed over a group of predictions.

Parameters

string	$actionname
array	$predictionids

Return values

array

an array of warnings and a boolean

Since

Moodle 3.8

action_executed_parameters()

static report_insights\external::action_executed_parameters ( )

static

action_executed parameters.

Return values

external_function_parameters

Since

Moodle 3.8

action_executed_returns()

static report_insights\external::action_executed_returns ( )

static

action_executed return

Return values

core_external\external_description

Since

Moodle 3.8

set_fixed_prediction()

static report_insights\external::set_fixed_prediction ( $predictionid )

static

Flags a prediction as fixed so no need to display it any more.

Parameters

int

$predictionid

Return values

array

an array of warnings and a boolean

Since

Moodle 3.4

set_fixed_prediction_parameters()

static report_insights\external::set_fixed_prediction_parameters ( )

static

set_fixed_prediction parameters.

Return values

external_function_parameters

Since

Moodle 3.4

set_fixed_prediction_returns()

static report_insights\external::set_fixed_prediction_returns ( )

static

set_fixed_prediction return

Return values

core_external\external_description

Since

Moodle 3.4

set_notuseful_prediction()

static report_insights\external::set_notuseful_prediction ( $predictionid )

static

Flags a prediction as fixed so no need to display it any more.

Parameters

int

$predictionid

Return values

array

an array of warnings and a boolean

Since

Moodle 3.4

set_notuseful_prediction_parameters()

static report_insights\external::set_notuseful_prediction_parameters ( )

static

set_notuseful_prediction parameters.

Return values

external_function_parameters

Since

Moodle 3.4

set_notuseful_prediction_returns()

static report_insights\external::set_notuseful_prediction_returns ( )

static

set_notuseful_prediction return

Return values

core_external\external_description

Since

Moodle 3.4

validate_prediction()

static report_insights\external::validate_prediction ( $predictionid )

staticprotected

Validates access to the prediction and returns it.

Parameters

int

$predictionid

Return values

array

array($model, $prediction, $context)

---

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

• report/insights/classes/external.php