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_attempts.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 an attempts report.

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

Defines 1 class

get_attempts:: (7 methods):
  execute_parameters()
  execute()
  export_user_attempts()
  export_attempt()
  execute_returns()
  get_user_attempts_returns()
  get_attempt_returns()


Class: get_attempts  - X-Ref

This is the external method for getting the information needed to present an attempts report.

execute_parameters()   X-Ref
Webservice parameters.

return: external_function_parameters

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

param: int $h5pactivityid The h5p activity id
param: int[]|null $userids The user ids (if no provided $USER will be used)
return: stdClass report data

export_user_attempts(report_attempts $report, int $userid)   X-Ref
Export attempts data for a specific user.

param: report_attempts $report the report attempts object
param: int $userid the user id
return: stdClass

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

param: attempt $attempt the attempt object
return: stdClass a WS compatible version of the attempt

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

return: external_single_structure

get_user_attempts_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