Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | List of all members
assign_course_index_summary Class Reference

Renderable course index summary. More...

Inheritance diagram for assign_course_index_summary:
renderable

Public Member Functions

 __construct ($usesections, $courseformatname)
 constructor More...
 
 add_assign_info ($cmid, $cmname, $sectionname, $timedue, $submissioninfo, $gradeinfo)
 Add a row of data to display on the course index page. More...
 

Public Attributes

array $assignments = array()
 assignments - A list of course module info and submission counts or statuses
 
string $courseformatname = ''
 courseformat - The current course format name
 
boolean $usesections = false
 usesections - Does this course format support sections?
 

Detailed Description

Renderable course index summary.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

assign_course_index_summary::__construct (   $usesections,
  $courseformatname 
)

constructor

Parameters
boolean$usesections- True if this course format uses sections
string$courseformatname- The id of this course format

Member Function Documentation

◆ add_assign_info()

assign_course_index_summary::add_assign_info (   $cmid,
  $cmname,
  $sectionname,
  $timedue,
  $submissioninfo,
  $gradeinfo 
)

Add a row of data to display on the course index page.

Parameters
int$cmid- The course module id for generating a link
string$cmname- The course module name for generating a link
string$sectionname- The name of the course section (only if $usesections is true)
int$timedue- The due date for the assignment - may be 0 if no duedate
string$submissioninfo- A string with either the number of submitted assignments, or the status of the current users submission depending on capabilities.
string$gradeinfo- The current users grade if they have been graded and it is not hidden.

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