Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
core_courseformat\external\get_state Class Reference
Inheritance diagram for core_courseformat\external\get_state:

Static Public Member Functions

static execute (int $courseid)
 This method will load all course, sections and cm states needed to initialize the frontend course editor module.
 
static execute_parameters ()
 Webservice parameters.
 
static execute_returns ()
 Webservice returns.
 

Member Function Documentation

◆ execute()

static core_courseformat\external\get_state::execute ( int $courseid)
static

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

◆ execute_parameters()

static core_courseformat\external\get_state::execute_parameters ( )
static

Webservice parameters.

Return values
external_function_parameters

◆ execute_returns()

static core_courseformat\external\get_state::execute_returns ( )
static

Webservice returns.

Return values
external_value

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