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.

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

This is the external method to return the information needed to list all enrolled user attempts.

Copyright: 2020 Ilya Tregubov <ilya@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 314 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: get_user_attempts  - X-Ref

This is the external method to return the information needed to list all enrolled user attempts.

execute_parameters()   X-Ref
Webservice parameters.

return: external_function_parameters

execute(int $h5pactivityid, $sortorder = 'id ASC', ?int $page = 0,?int $perpage = 0, $firstinitial = '', $lastinitial = '')   X-Ref
Return user attempts information in a h5p activity.

param: int $h5pactivityid The h5p activity id
param: int $sortorder The sort order
param: int $page page number
param: int $perpage items per page
param: int $firstinitial Users whose first name starts with $firstinitial
param: int $lastinitial Users whose last name starts with $lastinitial
return: stdClass report data

get_active_users(manager $manager,string $userfields = 'u.*',string $sortorder = '',int $limitfrom = 0,int $limitnum = 0)   X-Ref
Generate the active users list

param: manager $manager the h5pactivity manager
param: string $userfields the user fields to get
param: string $sortorder the SQL sortorder
param: int $limitfrom SQL limit from
param: int $limitnum SQL limit num

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

param: report $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_user_attempt_returns()   X-Ref
Return the external structure of an attempt.

return: external_single_structure