Moodle PHP Documentation 5.0
Moodle 5.0.1+ (Build: 20250711) (61af040cd5f)
mod_h5pactivity\local\report\participants Class Reference

Class H5P activity participants report. More...

Inheritance diagram for mod_h5pactivity\local\report\participants:
mod_h5pactivity\local\report

Public Member Functions

 __construct (manager $manager, $currentgroup=false)
 Create a new participants report.
 
 col_attempts (stdClass $user)
 Generate attempts count column, if any.
 
 col_fullname ($user)
 Generate the fullname column.
 
 col_score (stdClass $user)
 Generate score column.
 
 col_timemodified (stdClass $user)
 Generate attempt timemodified column, if any.
 
 get_attempt ()
 Return the report attempt object.
 
 get_user ()
 Return the report user record.
 
 print ()
 Print the report.
 
 print_headers ()
 Print headers.
 
 print_nothing_to_display ()
 Warning in case no user has the selected initials letters.
 

Public Attributes

global $CFG
 

Detailed Description

Class H5P activity participants report.

Since
Moodle 3.9

Constructor & Destructor Documentation

◆ __construct()

mod_h5pactivity\local\report\participants::__construct ( manager $manager,
$currentgroup = false )

Create a new participants report.

Parameters
manager$managerh5pactivitymanager object
int | bool$currentgroupFalse if groups not used, 0 for all groups, group id (int) to filter by specific group

Member Function Documentation

◆ col_attempts()

mod_h5pactivity\local\report\participants::col_attempts ( stdClass $user)

Generate attempts count column, if any.

Parameters
stdClass$userthe user record
Return values
string

◆ col_fullname()

mod_h5pactivity\local\report\participants::col_fullname ( $user)

Generate the fullname column.

Parameters
stdClass$user
Return values
string

◆ col_score()

mod_h5pactivity\local\report\participants::col_score ( stdClass $user)

Generate score column.

Parameters
stdClass$userthe user record
Return values
string

◆ col_timemodified()

mod_h5pactivity\local\report\participants::col_timemodified ( stdClass $user)

Generate attempt timemodified column, if any.

Parameters
stdClass$userthe user record
Return values
string

◆ get_attempt()

mod_h5pactivity\local\report\participants::get_attempt ( )

Return the report attempt object.

Participants report has no specific attempt.

Return values
attempt|nullthe attempt object or null

Implements mod_h5pactivity\local\report.

◆ get_user()

mod_h5pactivity\local\report\participants::get_user ( )

Return the report user record.

Participants report has no specific user.

Return values
stdClass|nulla user or null

Implements mod_h5pactivity\local\report.

◆ print()

mod_h5pactivity\local\report\participants::print ( )

Print the report.

Implements mod_h5pactivity\local\report.

◆ print_headers()

mod_h5pactivity\local\report\participants::print_headers ( )

Print headers.

Note: as per MDL-80754, we have to modify the header dynamically to display the total attempts in the column header.


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