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.

Rest API base class mapping rest api methods to endpoints with http methods, args and post body.

Copyright: 2017 Damyon Wiese
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 134 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

rest:: (2 methods):
  __construct()
  call()


Class: rest  - X-Ref

Rest API base class mapping rest api methods to endpoints with http methods, args and post body.

__construct(curl $curl)   X-Ref
Constructor.

param: curl $curl

call($functionname, $functionargs, $rawpost = false, $contenttype = false)   X-Ref
Call a function from the Api with a set of arguments and optional data.

param: string $functionname
param: array $functionargs
param: string $rawpost Optional param to include in the body of a post.
param: string $contenttype The MIME type for the request's Content-Type header.
return: string|stdClass