tool_policy\external Class Reference

Class external. More...

Inheritance diagram for tool_policy\external:

Static Public Member Functions
static	get_policy_version ($versionid, $behalfid=null)
	Fetch the details of a policy version.
static	get_policy_version_parameters ()
	Parameter description for get_policy_version_parameters().
static	get_policy_version_returns ()
	Parameter description for get_policy_version().
static	submit_accept_on_behalf ($jsonformdata)
	Submit the create group form.
static	submit_accept_on_behalf_parameters ()
	Describes the parameters for submit_create_group_form webservice.
static	submit_accept_on_behalf_returns ()
	Returns description of method result value.

Detailed Description

Class external.

The external API for the Policy tool.

Copyright

2018 Sara Arjona (sara@.nosp@m.mood.nosp@m.le.co.nosp@m.m)

License

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

Member Function Documentation

get_policy_version()

static tool_policy\external::get_policy_version ( $versionid, $behalfid = null )

static

Fetch the details of a policy version.

Parameters

int	$versionid	The policy version ID.
int	$behalfid	The id of user on whose behalf the user is viewing the policy.

Return values

array

Exceptions

coding_exception
dml_exception
invalid_parameter_exception
restricted_context_exception
moodle_exception

get_policy_version_parameters()

static tool_policy\external::get_policy_version_parameters ( )

static

Parameter description for get_policy_version_parameters().

Return values

external_function_parameters

get_policy_version_returns()

static tool_policy\external::get_policy_version_returns ( )

static

Parameter description for get_policy_version().

Return values

core_external\external_description

submit_accept_on_behalf()

static tool_policy\external::submit_accept_on_behalf ( $jsonformdata )

static

Submit the create group form.

Parameters

string

$jsonformdata

The data from the form, encoded as a json array.

Return values

int	new group id.

submit_accept_on_behalf_parameters()

static tool_policy\external::submit_accept_on_behalf_parameters ( )

static

Describes the parameters for submit_create_group_form webservice.

Return values

external_function_parameters

submit_accept_on_behalf_returns()

static tool_policy\external::submit_accept_on_behalf_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since

Moodle 3.0

---

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

• admin/tool/policy/classes/external.php