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.
/mod/h5pactivity/classes/external/ -> get_results.php (source)

[Source view]

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

This is the external method for getting the information needed to present a results report.

Copyright: 2020 Ferran Recio <ferran@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 305 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

get_results:: (8 methods):
  execute_parameters()
  execute()
  export_attempt()
  export_result()
  execute_returns()
  get_attempt_returns()
  get_result_returns()
  get_answer_returns()


Class: get_results  - X-Ref

This is the external method for getting the information needed to present a results report.

execute_parameters()   X-Ref
Webservice parameters.

return: external_function_parameters

execute(int $h5pactivityid, array $attemptids = [])   X-Ref
Return user attempts results information in a h5p activity.

In case an empty array of attempt ids is passed, the method will load all
activity attempts from the current user.

param: int $h5pactivityid The h5p activity id
param: int[] $attemptids The attempt ids
return: stdClass report data

export_attempt(report_results $report)   X-Ref
Return a data object from an attempt.

param: report_results $report the attempt data
return: stdClass a WS compatible version of the attempt

export_result(stdClass $data)   X-Ref
Return a data object from a result.

param: stdClass $data the result data
return: stdClass a WS compatible version of the result

execute_returns()   X-Ref
Describes the get_h5pactivity_access_information return value.

return: external_single_structure

get_attempt_returns()   X-Ref
Return the external structure of an attempt

return: external_single_structure

get_result_returns()   X-Ref
Return the external structure of a result

return: external_single_structure

get_answer_returns(string $description, int $required = VALUE_REQUIRED)   X-Ref
Return the external structure of an answer or correctanswer

param: string $description the return description
param: int $required the return required value
return: external_single_structure