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.
/course/format/classes/external/ -> get_state.php (source)

[Source view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

(no description)

File Size: 132 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

get_state:: (3 methods):
  execute_parameters()
  execute()
  execute_returns()


Class: get_state  - X-Ref

Class for exporting a course state.

execute_parameters()   X-Ref
Webservice parameters.

return: external_function_parameters

execute(int $courseid)   X-Ref
This method will load all course, sections and cm states needed to initialize the frontend
course editor module. The state data of every individual course, section and cm is
build using the specifics "state" output components.

By default, the states are generated by:
- core_courseformat\output\state\course
- core_courseformat\output\state\section
- core_courseformat\output\state\cm

As the other main course outputs, format plugins can override those output components
to send more information to the frontend course editor. These extended classes should
be located in format_XXX\output\courseformat\state\course, format_XXX\output\courseformat\state\section
or format_XXX\output\courseformat\state\cm.

param: int $courseid the course id
return: string Course state in JSON

execute_returns()   X-Ref
Webservice returns.

return: external_value