Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250706) (a6b17d8f6bd)
assign_course_index_summary Class Reference

Renderable course index summary. More...

Inheritance diagram for assign_course_index_summary:

Public Member Functions

since __construct ($usesections, $courseformatname)
 
since add_assign_info ($cmid, $cmname, $sectionname, $timedue, $submissioninfo, $gradeinfo, $cangrade=false)
 

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?
 
since : '5.0'
 constructor
 
since : '5.0'
 Add a row of data to display on the course index page.
 
since mdl: '<a class="el" href="https: reason: 'The assign_course_index_summary class is not used anymore.'
 

Detailed Description

Renderable course index summary.

Deprecated
since Moodle 5.0 (MDL-83888).
Todo
MDL-84429 Final deprecation in Moodle 6.0.
License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Data Documentation

◆ __pad0__

since assign_course_index_summary::__pad0__

constructor

Deprecated
since Moodle 5.0 (MDL-83888).
Todo
MDL-84429 Final deprecation in Moodle 6.0.
Parameters
boolean$usesections- True if this course format uses sections
string$courseformatname- The id of this course format

◆ __pad1__

since assign_course_index_summary::__pad1__

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

Deprecated
since Moodle 5.0 (MDL-83888).
Todo
MDL-84429 Final deprecation in Moodle 6.0.
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.
boolcangrade - Does this user have grade capability?

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