Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Protected Attributes | List of all members
workshop_grading_report Class Reference

Renderable component containing all the data needed to display the grading report. More...

Inheritance diagram for workshop_grading_report:
renderable

Public Member Functions

 __construct (stdClass $data, stdClass $options)
 Grades in $data must be already rounded to the set number of decimals or must be null (in which later case, the [mod_workshop,nullgrade] string shall be displayed) More...
 
 export_data_for_external ()
 Prepare the data to be exported to a external system via Web Services. More...
 
 get_data ()
 
 get_options ()
 

Protected Attributes

stdClass $data
 returned by { More...
 
stdClass $options
 rendering options
 

Detailed Description

Renderable component containing all the data needed to display the grading report.

Constructor & Destructor Documentation

◆ __construct()

workshop_grading_report::__construct ( stdClass  $data,
stdClass  $options 
)

Grades in $data must be already rounded to the set number of decimals or must be null (in which later case, the [mod_workshop,nullgrade] string shall be displayed)

Parameters
stdClass$dataprepared by workshop::prepare_grading_report_data()
stdClass$optionsdisplay options (showauthornames, showreviewernames, sortby, sorthow, showsubmissiongrade, showgradinggrade)

Member Function Documentation

◆ export_data_for_external()

workshop_grading_report::export_data_for_external ( )

Prepare the data to be exported to a external system via Web Services.

This function applies extra capabilities checks.

Return values
stdClassthe data ready for external systems

◆ get_data()

workshop_grading_report::get_data ( )
Return values
stdClassgrading report data

◆ get_options()

workshop_grading_report::get_options ( )
Return values
stdClassrendering options

Member Data Documentation

◆ $data

stdClass workshop_grading_report::$data
protected

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