Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/admin/tool/policy/classes/ -> external.php (source)

[Source view]

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]

Class containing the external API functions functions for the Policy tool.

Copyright: 2018 Sara Arjona (sara@moodle.com)
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 189 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

external:: (6 methods):
  get_policy_version_parameters()
  get_policy_version()
  get_policy_version_returns()
  submit_accept_on_behalf_parameters()
  submit_accept_on_behalf()
  submit_accept_on_behalf_returns()


Class: external  - X-Ref

Class external.

The external API for the Policy tool.

get_policy_version_parameters()   X-Ref
Parameter description for get_policy_version_parameters().

return: external_function_parameters

get_policy_version($versionid, $behalfid = null)   X-Ref
Fetch the details of a policy version.

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

get_policy_version_returns()   X-Ref
Parameter description for get_policy_version().

return: \core_external\external_description

submit_accept_on_behalf_parameters()   X-Ref
Describes the parameters for submit_create_group_form webservice.

return: external_function_parameters

submit_accept_on_behalf($jsonformdata)   X-Ref
Submit the create group form.

param: string $jsonformdata The data from the form, encoded as a json array.
return: int new group id.

submit_accept_on_behalf_returns()   X-Ref
Returns description of method result value.

return: \core_external\external_description