Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
core_xapi\external\post_statement Class Reference

This is the external API for generic xAPI handling. More...

Inheritance diagram for core_xapi\external\post_statement:

Static Public Member Functions

static execute (string $component, string $requestjson)
 Process a statement post request.
 
static execute_parameters ()
 Parameters for execute.
 
static execute_returns ()
 Return for execute.
 

Static Protected Member Functions

static validate_component (string $component)
 Check component name.
 

Detailed Description

This is the external API for generic xAPI handling.

Since
Moodle 3.9
License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ execute()

static core_xapi\external\post_statement::execute ( string $component,
string $requestjson )
static

Process a statement post request.

Parameters
string$componentcomponent name (frankenstyle)
string$requestjsonjson object with all the statements to post
Return values
bool[]storing acceptance of every statement

◆ execute_parameters()

static core_xapi\external\post_statement::execute_parameters ( )
static

Parameters for execute.

Return values
external_function_parameters

◆ validate_component()

static core_xapi\external\post_statement::validate_component ( string $component)
staticprotected

Check component name.

Note: this function is separated mainly for testing purposes to be overridden to fake components.

Exceptions
xapi_exceptionif component is not available
Parameters
string$componentcomponent name

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