Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/lib/xapi/classes/external/ -> post_statement.php (source)

[Source view]

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

This is the external API for generic xAPI handling.

Copyright: 2020 Ferran Recio
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 178 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

post_statement:: (6 methods):
  execute_parameters()
  execute()
  execute_returns()
  validate_component()
  get_statements_from_json()
  check_statements_users()


Class: post_statement  - X-Ref

This is the external API for generic xAPI handling.

execute_parameters()   X-Ref
Parameters for execute

return: external_function_parameters

execute(string $component, string $requestjson)   X-Ref
Process a statement post request.

return: bool[] storing acceptance of every statement
param: string $component component name (frankenstyle)
param: string $requestjson json object with all the statements to post

execute_returns()   X-Ref
Return for execute.


validate_component(string $component)   X-Ref
Check component name.

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

param: string $component component name

get_statements_from_json(string $requestjson)   X-Ref
Convert mulitple types of statement request into an array of statements.

return: statement[] array of statements
param: string $requestjson json encoded statements structure

check_statements_users(array $statements, handler $handler)   X-Ref
Check that $USER is actor in all statements.

return: bool if $USER is actor in all statements
param: statement[] $statements array of statements
param: handler $handler specific xAPI handler