Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/webservice/rest/ -> lib.php (source)

[Source view]

Moodle REST library

Copyright: 2009 Jerome Mouneyrac
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 99 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

webservice_rest_client:: (3 methods):
  __construct()
  set_token()
  call()


Class: webservice_rest_client  - X-Ref

Moodle REST client

It has been implemented for unit testing purpose (all protocols have similar client)

__construct($serverurl, $token, $format = 'xml')   X-Ref
Constructor

param: string $serverurl a Moodle URL
param: string $token the token used to do the web service call
param: string $format returned value format: xml or json

set_token($token)   X-Ref
Set the token used to do the REST call

param: string $token the token used to do the web service call

call($functionname, $params)   X-Ref
Execute client WS request with token authentication

param: string $functionname the function name
param: array $params the parameters of the function
return: mixed