Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
mod_h5pactivity\external\get_attempts Class Reference
Inheritance diagram for mod_h5pactivity\external\get_attempts:

Static Public Member Functions

static execute (int $h5pactivityid, ?array $userids=[])
 Return user attempts information in a h5p activity.
 
static execute_parameters ()
 Webservice parameters.
 
static execute_returns ()
 Describes the get_h5pactivity_access_information return value.
 
static export_user_attempts (report_attempts $report, int $userid)
 Export attempts data for a specific user.
 
static get_user_attempts_returns ()
 Describes the get_h5pactivity_access_information return value.
 

Member Function Documentation

◆ execute()

static mod_h5pactivity\external\get_attempts::execute ( int $h5pactivityid,
?array $userids = [] )
static

Return user attempts information in a h5p activity.

Exceptions
moodle_exceptionif the user cannot see the report
Parameters
int$h5pactivityidThe h5p activity id
int[] | null$useridsThe user ids (if no provided $USER will be used)
Return values
stdClassreport data

◆ execute_parameters()

static mod_h5pactivity\external\get_attempts::execute_parameters ( )
static

Webservice parameters.

Return values
external_function_parameters

◆ execute_returns()

static mod_h5pactivity\external\get_attempts::execute_returns ( )
static

Describes the get_h5pactivity_access_information return value.

Return values
external_single_structure

◆ export_user_attempts()

static mod_h5pactivity\external\get_attempts::export_user_attempts ( report_attempts $report,
int $userid )
static

Export attempts data for a specific user.

Parameters
report_attempts$reportthe report attempts object
int$useridthe user id
Return values
stdClass

◆ get_user_attempts_returns()

static mod_h5pactivity\external\get_attempts::get_user_attempts_returns ( )
static

Describes the get_h5pactivity_access_information return value.

Return values
external_single_structure

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