Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 401 and 402] [Versions 401 and 403]

This file contains the definition for the renderable classes for the assignment

Copyright: 2012 NetSpot {@link http://www.netspot.com.au}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 788 lines (31 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 14 classes

assign_submit_for_grading_page:: (1 method):
  __construct()

assign_gradingmessage:: (1 method):
  __construct()

assign_form:: (1 method):
  __construct()

assign_user_summary:: (1 method):
  __construct()

assign_feedback_plugin_feedback:: (1 method):
  __construct()

assign_submission_plugin_submission:: (1 method):
  __construct()

assign_feedback_status:: (1 method):
  __construct()

assign_submission_status_compact:: (0 methods):

assign_attempt_history:: (1 method):
  __construct()

assign_attempt_history_chooser:: (2 methods):
  __construct()
  export_for_template()

assign_plugin_header:: (1 method):
  __construct()

assign_grading_summary:: (1 method):
  __construct()

assign_course_index_summary:: (2 methods):
  __construct()
  add_assign_info()

assign_files:: (2 methods):
  __construct()
  preprocess()


Class: assign_submit_for_grading_page  - X-Ref

This class wraps the submit for grading confirmation page

__construct($notifications, $coursemoduleid, $confirmform)   X-Ref
Constructor

param: string $notifications - Any mesages to display
param: int $coursemoduleid
param: moodleform $confirmform

Class: assign_gradingmessage  - X-Ref

Implements a renderable message notification

__construct($heading, $message, $coursemoduleid, $gradingerror = false, $page = null)   X-Ref
Constructor

param: string $heading This is the heading to display
param: string $message This is the message to display
param: bool $gradingerror Set to true to display the message as an error.
param: int $coursemoduleid
param: int $page This is the current quick grading page

Class: assign_form  - X-Ref

Implements a renderable grading options form

__construct($classname, moodleform $form, $jsinitfunction = '')   X-Ref
Constructor

param: string $classname This is the class name for the container div
param: moodleform $form This is the moodleform
param: string $jsinitfunction This is an optional js function to add to the page requires

Class: assign_user_summary  - X-Ref

Implements a renderable user summary

__construct(stdClass $user,$courseid,$viewfullnames,$blindmarking,$uniqueidforuser,$extrauserfields,$suspendeduser = false)   X-Ref
Constructor

param: stdClass $user
param: int $courseid
param: bool $viewfullnames
param: bool $blindmarking
param: int $uniqueidforuser
param: array $extrauserfields
param: bool $suspendeduser

Class: assign_feedback_plugin_feedback  - X-Ref

Implements a renderable feedback plugin feedback

__construct(assign_feedback_plugin $plugin,stdClass $grade,$view,$coursemoduleid,$returnaction,$returnparams)   X-Ref
Feedback for a single plugin

param: assign_feedback_plugin $plugin
param: stdClass $grade
param: string $view one of feedback_plugin::SUMMARY or feedback_plugin::FULL
param: int $coursemoduleid
param: string $returnaction The action required to return to this page
param: array $returnparams The params required to return to this page

Class: assign_submission_plugin_submission  - X-Ref

Implements a renderable submission plugin submission

__construct(assign_submission_plugin $plugin,stdClass $submission,$view,$coursemoduleid,$returnaction,$returnparams)   X-Ref
Constructor

param: assign_submission_plugin $plugin
param: stdClass $submission
param: string $view one of submission_plugin::SUMMARY, submission_plugin::FULL
param: int $coursemoduleid - the course module id
param: string $returnaction The action to return to the current page
param: array $returnparams The params to return to the current page

Class: assign_feedback_status  - X-Ref

Renderable feedback status

__construct($gradefordisplay,$gradeddate,$grader,$feedbackplugins,$grade,$coursemoduleid,$returnaction,$returnparams,$canviewfullnames,$gradingcontrollergrade = '')   X-Ref
Constructor

param: string $gradefordisplay
param: mixed $gradeddate
param: mixed $grader
param: array $feedbackplugins
param: mixed $grade
param: int $coursemoduleid
param: string $returnaction The action required to return to this page
param: array $returnparams The list of params required to return to this page
param: bool $canviewfullnames
param: string $gradingcontrollergrade The grade information rendered by a grade controller

Class: assign_submission_status_compact  - X-Ref

Renderable submission status

Class: assign_attempt_history  - X-Ref

Used to output the attempt history for a particular assignment.

__construct($submissions,$grades,$submissionplugins,$feedbackplugins,$coursemoduleid,$returnaction,$returnparams,$cangrade,$useridlistid,$rownum)   X-Ref
Constructor

param: array $submissions
param: array $grades
param: array $submissionplugins
param: array $feedbackplugins
param: int $coursemoduleid
param: string $returnaction
param: array $returnparams
param: bool $cangrade
param: int $useridlistid
param: int $rownum

Class: assign_attempt_history_chooser  - X-Ref

Used to output the attempt history chooser for a particular assignment.

__construct($submissions,$grades,$coursemoduleid,$userid)   X-Ref
Constructor

param: array $submissions
param: array $grades
param: int $coursemoduleid
param: int $userid

export_for_template(renderer_base $output)   X-Ref
Function to export the renderer data in a format that is suitable for a
mustache template.

param: renderer_base $output Used to do a final render of any components that need to be rendered for export.
return: stdClass|array

Class: assign_plugin_header  - X-Ref

Renderable header related to an individual subplugin

__construct(assign_plugin $plugin)   X-Ref
Header for a single plugin

param: assign_plugin $plugin

Class: assign_grading_summary  - X-Ref

Renderable grading summary

__construct($participantcount,$submissiondraftsenabled,$submissiondraftscount,$submissionsenabled,$submissionssubmittedcount,$cutoffdate,$duedate,$timelimit,$coursemoduleid,$submissionsneedgradingcount,$teamsubmission,$warnofungroupedusers,$courserelativedatesmode,$coursestartdate,$cangrade = true,$isvisible = true,cm_info $cm = null)   X-Ref
constructor

param: int $participantcount
param: bool $submissiondraftsenabled
param: int $submissiondraftscount
param: bool $submissionsenabled
param: int $submissionssubmittedcount
param: int $cutoffdate
param: int $duedate
param: int $timelimit
param: int $coursemoduleid
param: int $submissionsneedgradingcount
param: bool $teamsubmission
param: string $warnofungroupedusers
param: bool $courserelativedatesmode true if the course is using relative dates, false otherwise.
param: int $coursestartdate unix timestamp representation of the course start date.
param: bool $cangrade
param: bool $isvisible
param: cm_info|null $cm The course module object.

Class: assign_course_index_summary  - X-Ref

Renderable course index summary

__construct($usesections, $courseformatname)   X-Ref
constructor

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

add_assign_info($cmid, $cmname, $sectionname, $timedue, $submissioninfo, $gradeinfo, $cangrade = false)   X-Ref
Add a row of data to display on the course index page

param: int $cmid - The course module id for generating a link
param: string $cmname - The course module name for generating a link
param: string $sectionname - The name of the course section (only if $usesections is true)
param: int $timedue - The due date for the assignment - may be 0 if no duedate
param: string $submissioninfo - A string with either the number of submitted assignments, or the
param: string $gradeinfo - The current users grade if they have been graded and it is not hidden.
param: bool cangrade - Does this user have grade capability?

Class: assign_files  - X-Ref

An assign file class that extends rendererable class and is used by the assign module.

__construct(context $context, $sid, $filearea, $component, $course = null, $cm = null)   X-Ref
The constructor

param: context $context
param: int $sid
param: string $filearea
param: string $component
param: stdClass $course
param: stdClass $cm

preprocess($dir, $filearea, $component)   X-Ref
Preprocessing the file list to add the portfolio links if required.

param: array $dir
param: string $filearea
param: string $component
return: void