<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* This file contains the definition for the grading table which subclassses easy_table
*
* @package mod_assign
* @copyright 2012 NetSpot {@link http://www.netspot.com.au}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir.'/tablelib.php');
require_once($CFG->libdir.'/gradelib.php');
require_once($CFG->dirroot.'/mod/assign/locallib.php');
/**
* Extends table_sql to provide a table of assignment submissions
*
* @package mod_assign
* @copyright 2012 NetSpot {@link http://www.netspot.com.au}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class assign_grading_table extends table_sql implements renderable {
/** @var assign $assignment */
private $assignment = null;
/** @var int $perpage */
private $perpage = 10;
/** @var int[] $pagingoptions Available pagination options */
private $pagingoptions = [10, 20, 50, 100];
/** @var int $rownum (global index of current row in table) */
private $rownum = -1;
/** @var renderer_base for getting output */
private $output = null;
/** @var stdClass gradinginfo */
private $gradinginfo = null;
/** @var int $tablemaxrows */
private $tablemaxrows = 10000;
/** @var boolean $quickgrading */
private $quickgrading = false;
/** @var boolean $hasgrantextension - Only do the capability check once for the entire table */
private $hasgrantextension = false;
/** @var boolean $hasgrade - Only do the capability check once for the entire table */
private $hasgrade = false;
/** @var array $groupsubmissions - A static cache of group submissions */
private $groupsubmissions = array();
/** @var array $submissiongroups - A static cache of submission groups */
private $submissiongroups = array();
/** @var array $plugincache - A cache of plugin lookups to match a column name to a plugin efficiently */
private $plugincache = array();
/** @var array $scale - A list of the keys and descriptions for the custom scale */
private $scale = null;
/** @var bool true if the user has this capability. Otherwise false. */
private $hasviewblind;
/**
* overridden constructor keeps a reference to the assignment class that is displaying this table
*
* @param assign $assignment The assignment class
* @param int $perpage how many per page
* @param string $filter The current filter
* @param int $rowoffset For showing a subsequent page of results
* @param bool $quickgrading Is this table wrapped in a quickgrading form?
* @param string $downloadfilename
*/
public function __construct(assign $assignment,
$perpage,
$filter,
$rowoffset,
$quickgrading,
$downloadfilename = null) {
global $CFG, $PAGE, $DB, $USER;
parent::__construct('mod_assign_grading-' . $assignment->get_context()->id);
$this->is_persistent(true);
$this->set_attribute('id', 'submissions');
$this->assignment = $assignment;
// Check permissions up front.
$this->hasgrantextension = has_capability('mod/assign:grantextension',
$this->assignment->get_context());
$this->hasgrade = $this->assignment->can_grade();
// Check if we have the elevated view capablities to see the blind details.
$this->hasviewblind = has_capability('mod/assign:viewblinddetails',
$this->assignment->get_context());
$this->perpage = $perpage;
$this->quickgrading = $quickgrading && $this->hasgrade;
$this->output = $PAGE->get_renderer('mod_assign');
$urlparams = array('action' => 'grading', 'id' => $assignment->get_course_module()->id);
$url = new moodle_url($CFG->wwwroot . '/mod/assign/view.php', $urlparams);
$this->define_baseurl($url);
// Do some business - then set the sql.
$currentgroup = groups_get_activity_group($assignment->get_course_module(), true);
if ($rowoffset) {
$this->rownum = $rowoffset - 1;
}
$userid = optional_param('userid', null, PARAM_INT);
$groupid = groups_get_course_group($assignment->get_course(), true);
// If the user ID is set, it indicates that a user has been selected. In this case, override the user search
// string with the full name of the selected user.
$usersearch = $userid ? fullname(\core_user::get_user($userid)) : optional_param('search', '', PARAM_NOTAGS);
$assignment->set_usersearch($userid, $groupid, $usersearch);
$users = array_keys( $assignment->list_participants($currentgroup, true));
if (count($users) == 0) {
// Insert a record that will never match to the sql is still valid.
$users[] = -1;
}
$params = array();
$params['assignmentid1'] = (int)$this->assignment->get_instance()->id;
$params['assignmentid2'] = (int)$this->assignment->get_instance()->id;
$params['assignmentid3'] = (int)$this->assignment->get_instance()->id;
$params['newstatus'] = ASSIGN_SUBMISSION_STATUS_NEW;
// TODO Does not support custom user profile fields (MDL-70456).
$userfieldsapi = \core_user\fields::for_identity($this->assignment->get_context(), false)->with_userpic();
$userfields = $userfieldsapi->get_sql('u', false, '', '', false)->selects;
$extrauserfields = $userfieldsapi->get_required_fields([\core_user\fields::PURPOSE_IDENTITY]);
$fields = $userfields . ', ';
$fields .= 'u.id as userid, ';
$fields .= 's.status as status, ';
$fields .= 's.id as submissionid, ';
$fields .= 's.timecreated as firstsubmission, ';
$fields .= "CASE WHEN status <> :newstatus THEN s.timemodified ELSE NULL END as timesubmitted, ";
$fields .= 's.attemptnumber as attemptnumber, ';
$fields .= 'g.id as gradeid, ';
$fields .= 'g.grade as grade, ';
$fields .= 'g.timemodified as timemarked, ';
$fields .= 'g.timecreated as firstmarked, ';
$fields .= 'uf.mailed as mailed, ';
$fields .= 'uf.locked as locked, ';
$fields .= 'uf.extensionduedate as extensionduedate, ';
$fields .= 'uf.workflowstate as workflowstate, ';
$fields .= 'uf.allocatedmarker as allocatedmarker';
$from = '{user} u
LEFT JOIN {assign_submission} s
ON u.id = s.userid
AND s.assignment = :assignmentid1
AND s.latest = 1 ';
// For group assignments, there can be a grade with no submission.
$from .= ' LEFT JOIN {assign_grades} g
ON g.assignment = :assignmentid2
AND u.id = g.userid
AND (g.attemptnumber = s.attemptnumber OR s.attemptnumber IS NULL) ';
$from .= 'LEFT JOIN {assign_user_flags} uf
ON u.id = uf.userid
AND uf.assignment = :assignmentid3 ';
if ($this->assignment->get_course()->relativedatesmode) {
$params['courseid1'] = $this->assignment->get_course()->id;
$from .= ' LEFT JOIN (
SELECT ue1.userid as enroluserid,
CASE WHEN MIN(ue1.timestart - c2.startdate) < 0 THEN 0 ELSE MIN(ue1.timestart - c2.startdate) END as enrolstartoffset
FROM {enrol} e1
JOIN {user_enrolments} ue1
ON (ue1.enrolid = e1.id AND ue1.status = 0)
JOIN {course} c2
ON c2.id = e1.courseid
WHERE e1.courseid = :courseid1 AND e1.status = 0
GROUP BY ue1.userid
) enroloffset
ON (enroloffset.enroluserid = u.id) ';
}
$hasoverrides = $this->assignment->has_overrides();
$inrelativedatesmode = $this->assignment->get_course()->relativedatesmode;
if ($hasoverrides) {
$params['assignmentid5'] = (int)$this->assignment->get_instance()->id;
$params['assignmentid6'] = (int)$this->assignment->get_instance()->id;
$params['assignmentid7'] = (int)$this->assignment->get_instance()->id;
$params['assignmentid8'] = (int)$this->assignment->get_instance()->id;
$params['assignmentid9'] = (int)$this->assignment->get_instance()->id;
list($userwhere1, $userparams1) = $DB->get_in_or_equal($users, SQL_PARAMS_NAMED, 'priorityuser');
list($userwhere2, $userparams2) = $DB->get_in_or_equal($users, SQL_PARAMS_NAMED, 'effectiveuser');
$userwhere1 = "WHERE u.id {$userwhere1}";
$userwhere2 = "WHERE u.id {$userwhere2}";
$params = array_merge($params, $userparams1);
$params = array_merge($params, $userparams2);
$fields .= ', priority.priority, ';
$fields .= 'effective.allowsubmissionsfromdate, ';
if ($inrelativedatesmode) {
// If the priority is less than the 9999999 constant value it means it's an override
// and we should use that value directly. Otherwise we need to apply the uesr's course
// start date offset.
$fields .= 'CASE WHEN priority.priority < 9999999 THEN effective.duedate ELSE' .
' effective.duedate + enroloffset.enrolstartoffset END as duedate, ';
} else {
$fields .= 'effective.duedate, ';
}
$fields .= 'effective.cutoffdate ';
$from .= ' LEFT JOIN (
SELECT merged.userid, min(merged.priority) priority FROM (
( SELECT u.id as userid, 9999999 AS priority
FROM {user} u '.$userwhere1.'
)
UNION
( SELECT uo.userid, 0 AS priority
FROM {assign_overrides} uo
WHERE uo.assignid = :assignmentid5
)
UNION
( SELECT gm.userid, go.sortorder AS priority
FROM {assign_overrides} go
JOIN {groups} g ON g.id = go.groupid
JOIN {groups_members} gm ON gm.groupid = g.id
WHERE go.assignid = :assignmentid6
)
) merged
GROUP BY merged.userid
) priority ON priority.userid = u.id
JOIN (
(SELECT 9999999 AS priority,
u.id AS userid,
a.allowsubmissionsfromdate,
a.duedate,
a.cutoffdate
FROM {user} u
JOIN {assign} a ON a.id = :assignmentid7
'.$userwhere2.'
)
UNION
(SELECT 0 AS priority,
uo.userid,
uo.allowsubmissionsfromdate,
uo.duedate,
uo.cutoffdate
FROM {assign_overrides} uo
WHERE uo.assignid = :assignmentid8
)
UNION
(SELECT go.sortorder AS priority,
gm.userid,
go.allowsubmissionsfromdate,
go.duedate,
go.cutoffdate
FROM {assign_overrides} go
JOIN {groups} g ON g.id = go.groupid
JOIN {groups_members} gm ON gm.groupid = g.id
WHERE go.assignid = :assignmentid9
)
) effective ON effective.priority = priority.priority AND effective.userid = priority.userid ';
} else if ($inrelativedatesmode) {
// In relative dates mode and when we don't have overrides, include the
// duedate, cutoffdate and allowsubmissionsfrom date anyway as this information is useful and can vary.
$params['assignmentid5'] = (int)$this->assignment->get_instance()->id;
$fields .= ', a.duedate + enroloffset.enrolstartoffset as duedate, ';
$fields .= 'a.allowsubmissionsfromdate, ';
$fields .= 'a.cutoffdate ';
$from .= 'JOIN {assign} a ON a.id = :assignmentid5 ';
}
if (!empty($this->assignment->get_instance()->blindmarking)) {
$from .= 'LEFT JOIN {assign_user_mapping} um
ON u.id = um.userid
AND um.assignment = :assignmentidblind ';
$params['assignmentidblind'] = (int)$this->assignment->get_instance()->id;
$fields .= ', um.id as recordid ';
}
$userparams3 = array();
$userindex = 0;
list($userwhere3, $userparams3) = $DB->get_in_or_equal($users, SQL_PARAMS_NAMED, 'user');
$where = 'u.id ' . $userwhere3;
$params = array_merge($params, $userparams3);
// The filters do not make sense when there are no submissions, so do not apply them.
if ($this->assignment->is_any_submission_plugin_enabled()) {
if ($filter == ASSIGN_FILTER_SUBMITTED) {
$where .= ' AND (s.timemodified IS NOT NULL AND
s.status = :submitted) ';
$params['submitted'] = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
} else if ($filter == ASSIGN_FILTER_NOT_SUBMITTED) {
$where .= ' AND (s.timemodified IS NULL OR s.status <> :submitted) ';
$params['submitted'] = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
} else if ($filter == ASSIGN_FILTER_REQUIRE_GRADING) {
$where .= ' AND (s.timemodified IS NOT NULL AND
s.status = :submitted AND
(s.timemodified >= g.timemodified OR g.timemodified IS NULL OR g.grade IS NULL';
// Assignment grade is set to the negative grade scale id when scales are used.
if ($this->assignment->get_instance()->grade < 0) {
// Scale grades are set to -1 when not graded.
$where .= ' OR g.grade = -1';
}
$where .= '))';
$params['submitted'] = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
} else if ($filter == ASSIGN_FILTER_GRANTED_EXTENSION) {
$where .= ' AND uf.extensionduedate > 0 ';
} else if (strpos($filter, ASSIGN_FILTER_SINGLE_USER) === 0) {
$userfilter = (int) array_pop(explode('=', $filter));
$where .= ' AND (u.id = :userid)';
$params['userid'] = $userfilter;
} else if ($filter == ASSIGN_FILTER_DRAFT) {
$where .= ' AND (s.timemodified IS NOT NULL AND
s.status = :draft) ';
$params['draft'] = ASSIGN_SUBMISSION_STATUS_DRAFT;
}
}
if ($this->assignment->get_instance()->markingworkflow &&
$this->assignment->get_instance()->markingallocation) {
if (has_capability('mod/assign:manageallocations', $this->assignment->get_context())) {
// Check to see if marker filter is set.
$markerfilter = (int)get_user_preferences('assign_markerfilter', '');
if (!empty($markerfilter)) {
if ($markerfilter == ASSIGN_MARKER_FILTER_NO_MARKER) {
$where .= ' AND (uf.allocatedmarker IS NULL OR uf.allocatedmarker = 0)';
} else {
$where .= ' AND uf.allocatedmarker = :markerid';
$params['markerid'] = $markerfilter;
}
}
}
}
if ($this->assignment->get_instance()->markingworkflow) {
$workflowstates = $this->assignment->get_marking_workflow_states_for_current_user();
if (!empty($workflowstates)) {
$workflowfilter = get_user_preferences('assign_workflowfilter', '');
if ($workflowfilter == ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED) {
$where .= ' AND (uf.workflowstate = :workflowstate OR uf.workflowstate IS NULL OR '.
$DB->sql_isempty('assign_user_flags', 'workflowstate', true, true).')';
$params['workflowstate'] = $workflowfilter;
} else if (array_key_exists($workflowfilter, $workflowstates)) {
$where .= ' AND uf.workflowstate = :workflowstate';
$params['workflowstate'] = $workflowfilter;
}
}
}
$this->set_sql($fields, $from, $where, $params);
if ($downloadfilename) {
$this->is_downloading('csv', $downloadfilename);
}
$columns = array();
$headers = array();
// Select.
if (!$this->is_downloading() && $this->hasgrade) {
$columns[] = 'select';
$headers[] = get_string('select') .
'<div class="selectall"><label class="accesshide" for="selectall">' . get_string('selectall') . '</label>
<input type="checkbox" id="selectall" name="selectall" title="' . get_string('selectall') . '"/></div>';
}
if ($this->hasviewblind || !$this->assignment->is_blind_marking()) {
if ($this->is_downloading()) {
$columns[] = 'recordid';
$headers[] = get_string('recordid', 'assign');
}
// Fullname.
$columns[] = 'fullname';
$headers[] = get_string('fullname');
// Participant # details if can view real identities.
if ($this->assignment->is_blind_marking()) {
if (!$this->is_downloading()) {
$columns[] = 'recordid';
$headers[] = get_string('recordid', 'assign');
}
}
foreach ($extrauserfields as $extrafield) {
$columns[] = $extrafield;
$headers[] = \core_user\fields::get_display_name($extrafield);
}
} else {
// Record ID.
$columns[] = 'recordid';
$headers[] = get_string('recordid', 'assign');
}
// Submission status.
$columns[] = 'status';
$headers[] = get_string('status', 'assign');
if ($hasoverrides || $inrelativedatesmode) {
// Allowsubmissionsfromdate.
$columns[] = 'allowsubmissionsfromdate';
$headers[] = get_string('allowsubmissionsfromdate', 'assign');
// Duedate.
$columns[] = 'duedate';
$headers[] = get_string('duedate', 'assign');
// Cutoffdate.
$columns[] = 'cutoffdate';
$headers[] = get_string('cutoffdate', 'assign');
}
// Team submission columns.
if ($assignment->get_instance()->teamsubmission) {
$columns[] = 'team';
$headers[] = get_string('submissionteam', 'assign');
}
// Allocated marker.
if ($this->assignment->get_instance()->markingworkflow &&
$this->assignment->get_instance()->markingallocation &&
has_capability('mod/assign:manageallocations', $this->assignment->get_context())) {
// Add a column for the allocated marker.
$columns[] = 'allocatedmarker';
$headers[] = get_string('marker', 'assign');
}
// Grade.
$columns[] = 'grade';
$headers[] = get_string('gradenoun');
if ($this->is_downloading()) {
$gradetype = $this->assignment->get_instance()->grade;
if ($gradetype > 0) {
$columns[] = 'grademax';
$headers[] = get_string('maxgrade', 'assign');
} else if ($gradetype < 0) {
// This is a custom scale.
$columns[] = 'scale';
$headers[] = get_string('scale', 'assign');
}
if ($this->assignment->get_instance()->markingworkflow) {
// Add a column for the marking workflow state.
$columns[] = 'workflowstate';
$headers[] = get_string('markingworkflowstate', 'assign');
}
// Add a column to show if this grade can be changed.
$columns[] = 'gradecanbechanged';
$headers[] = get_string('gradecanbechanged', 'assign');
}
// Submission plugins.
if ($assignment->is_any_submission_plugin_enabled()) {
$columns[] = 'timesubmitted';
$headers[] = get_string('lastmodifiedsubmission', 'assign');
foreach ($this->assignment->get_submission_plugins() as $plugin) {
if ($this->is_downloading()) {
if ($plugin->is_visible() && $plugin->is_enabled()) {
foreach ($plugin->get_editor_fields() as $field => $description) {
$index = 'plugin' . count($this->plugincache);
$this->plugincache[$index] = array($plugin, $field);
$columns[] = $index;
$headers[] = $plugin->get_name();
}
}
} else {
if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->has_user_summary()) {
$index = 'plugin' . count($this->plugincache);
$this->plugincache[$index] = array($plugin);
$columns[] = $index;
$headers[] = $plugin->get_name();
}
}
}
}
// Time marked.
$columns[] = 'timemarked';
$headers[] = get_string('lastmodifiedgrade', 'assign');
// Feedback plugins.
foreach ($this->assignment->get_feedback_plugins() as $plugin) {
if ($this->is_downloading()) {
if ($plugin->is_visible() && $plugin->is_enabled()) {
foreach ($plugin->get_editor_fields() as $field => $description) {
$index = 'plugin' . count($this->plugincache);
$this->plugincache[$index] = array($plugin, $field);
$columns[] = $index;
$headers[] = $description;
}
}
} else if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->has_user_summary()) {
$index = 'plugin' . count($this->plugincache);
$this->plugincache[$index] = array($plugin);
$columns[] = $index;
$headers[] = $plugin->get_name();
}
}
// Exclude 'Final grade' column in downloaded grading worksheets.
if (!$this->is_downloading()) {
// Final grade.
$columns[] = 'finalgrade';
$headers[] = get_string('finalgrade', 'grades');
}
// Load the grading info for all users.
$this->gradinginfo = grade_get_grades($this->assignment->get_course()->id,
'mod',
'assign',
$this->assignment->get_instance()->id,
$users);
if (!empty($CFG->enableoutcomes) && !empty($this->gradinginfo->outcomes)) {
$columns[] = 'outcomes';
$headers[] = get_string('outcomes', 'grades');
}
// Set the columns.
$this->define_columns($columns);
$this->define_headers($headers);
$this->column_class('fullname', 'username');
$this->column_class('status', 'status');
$this->column_class('grade', 'grade');
foreach ($extrauserfields as $extrafield) {
$this->column_class($extrafield, $extrafield);
}
$this->no_sorting('recordid');
$this->no_sorting('finalgrade');
$this->no_sorting('userid');
$this->no_sorting('select');
$this->no_sorting('outcomes');
if ($assignment->get_instance()->teamsubmission) {
$this->no_sorting('team');
}
$plugincolumnindex = 0;
foreach ($this->assignment->get_submission_plugins() as $plugin) {
if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->has_user_summary()) {
$submissionpluginindex = 'plugin' . $plugincolumnindex++;
$this->no_sorting($submissionpluginindex);
}
}
foreach ($this->assignment->get_feedback_plugins() as $plugin) {
if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->has_user_summary()) {
$feedbackpluginindex = 'plugin' . $plugincolumnindex++;
$this->no_sorting($feedbackpluginindex);
}
}
// When there is no data we still want the column headers printed in the csv file.
if ($this->is_downloading()) {
$this->start_output();
}
}
/**
* Before adding each row to the table make sure rownum is incremented.
*
* @param array $row row of data from db used to make one row of the table.
* @return array one row for the table
*/
public function format_row($row) {
if ($this->rownum < 0) {
$this->rownum = $this->currpage * $this->pagesize;
} else {
$this->rownum += 1;
}
return parent::format_row($row);
}
/**
* Add a column with an ID that uniquely identifies this user in this assignment.
*
* @param stdClass $row
* @return string
*/
public function col_recordid(stdClass $row) {
if (empty($row->recordid)) {
$row->recordid = $this->assignment->get_uniqueid_for_user($row->userid);
}
return get_string('hiddenuser', 'assign') . $row->recordid;
}
/**
* Add the userid to the row class so it can be updated via ajax.
*
* @param stdClass $row The row of data
* @return string The row class
*/
public function get_row_class($row) {
return 'user' . $row->userid;
}
/**
* Return the number of rows to display on a single page.
*
* @return int The number of rows per page
*/
public function get_rows_per_page() {
return $this->perpage;
}
/**
* list current marking workflow state
*
* @param stdClass $row
* @return string
*/
public function col_workflowstatus(stdClass $row) {
$o = '';
$gradingdisabled = $this->assignment->grading_disabled($row->id, true, $this->gradinginfo);
// The function in the assignment keeps a static cache of this list of states.
$workflowstates = $this->assignment->get_marking_workflow_states_for_current_user();
$workflowstate = $row->workflowstate;
if (empty($workflowstate)) {
$workflowstate = ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED;
}
if ($this->quickgrading && !$gradingdisabled) {
$notmarked = get_string('markingworkflowstatenotmarked', 'assign');
$name = 'quickgrade_' . $row->id . '_workflowstate';
if ($workflowstate !== ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED && !array_key_exists($workflowstate, $workflowstates)) {
$allworkflowstates = $this->assignment->get_all_marking_workflow_states();
$o .= html_writer::div($allworkflowstates[$workflowstate]);
} else {
$o .= html_writer::select($workflowstates, $name, $workflowstate, ['' => $notmarked]);
// Check if this user is a marker that can't manage allocations and doesn't have the marker column added.
if ($this->assignment->get_instance()->markingworkflow &&
$this->assignment->get_instance()->markingallocation &&
!has_capability('mod/assign:manageallocations', $this->assignment->get_context())) {
$name = 'quickgrade_' . $row->id . '_allocatedmarker';
$o .= html_writer::empty_tag('input', ['type' => 'hidden', 'name' => $name,
'value' => $row->allocatedmarker]);
}
}
} else {
$o .= $this->output->container(get_string('markingworkflowstate' . $workflowstate, 'assign'), $workflowstate);
}
return $o;
}
/**
* For download only - list current marking workflow state
*
* @param stdClass $row - The row of data
* @return string The current marking workflow state
*/
public function col_workflowstate($row) {
$state = $row->workflowstate;
if (empty($state)) {
$state = ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED;
}
return get_string('markingworkflowstate' . $state, 'assign');
}
/**
* list current marker
*
* @param stdClass $row - The row of data
* @return id the user->id of the marker.
*/
public function col_allocatedmarker(stdClass $row) {
static $markers = null;
static $markerlist = array();
if ($markers === null) {
list($sort, $params) = users_order_by_sql('u');
// Only enrolled users could be assigned as potential markers.
$markers = get_enrolled_users($this->assignment->get_context(), 'mod/assign:grade', 0, 'u.*', $sort);
$markerlist[0] = get_string('choosemarker', 'assign');
$viewfullnames = has_capability('moodle/site:viewfullnames', $this->assignment->get_context());
foreach ($markers as $marker) {
$markerlist[$marker->id] = fullname($marker, $viewfullnames);
}
}
if (empty($markerlist)) {
// TODO: add some form of notification here that no markers are available.
return '';
}
if ($this->is_downloading()) {
if (isset($markers[$row->allocatedmarker])) {
return fullname($markers[$row->allocatedmarker],
has_capability('moodle/site:viewfullnames', $this->assignment->get_context()));
} else {
return '';
}
}
if ($this->quickgrading && has_capability('mod/assign:manageallocations', $this->assignment->get_context()) &&
(empty($row->workflowstate) ||
$row->workflowstate == ASSIGN_MARKING_WORKFLOW_STATE_INMARKING ||
$row->workflowstate == ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED)) {
$name = 'quickgrade_' . $row->id . '_allocatedmarker';
return html_writer::select($markerlist, $name, $row->allocatedmarker, false);
} else if (!empty($row->allocatedmarker)) {
$output = '';
if ($this->quickgrading) { // Add hidden field for quickgrading page.
$name = 'quickgrade_' . $row->id . '_allocatedmarker';
$attributes = ['type' => 'hidden', 'name' => $name, 'value' => $row->allocatedmarker];
$output .= html_writer::empty_tag('input', $attributes);
}
$output .= $markerlist[$row->allocatedmarker];
return $output;
}
}
/**
* For download only - list all the valid options for this custom scale.
*
* @param stdClass $row - The row of data
* @return string A list of valid options for the current scale
*/
public function col_scale($row) {
global $DB;
if (empty($this->scale)) {
$dbparams = array('id' => -($this->assignment->get_instance()->grade));
$this->scale = $DB->get_record('scale', $dbparams);
}
if (!empty($this->scale->scale)) {
return implode("\n", explode(',', $this->scale->scale));
}
return '';
}
/**
* Display a grade with scales etc.
*
* @param string $grade
* @param boolean $editable
* @param int $userid The user id of the user this grade belongs to
* @param int $modified Timestamp showing when the grade was last modified
* @return string The formatted grade
*/
public function display_grade($grade, $editable, $userid, $modified) {
if ($this->is_downloading()) {
if ($this->assignment->get_instance()->grade >= 0) {
if ($grade == -1 || $grade === null) {
return '';
}
$gradeitem = $this->assignment->get_grade_item();
return format_float($grade, $gradeitem->get_decimals());
} else {
// This is a custom scale.
$scale = $this->assignment->display_grade($grade, false);
if ($scale == '-') {
$scale = '';
}
return $scale;
}
}
return $this->assignment->display_grade($grade, $editable, $userid, $modified);
}
/**
* Get the team info for this user.
*
* @param stdClass $row
* @return string The team name
*/
public function col_team(stdClass $row) {
$submission = false;
$group = false;
$this->get_group_and_submission($row->id, $group, $submission, -1);
if ($group) {
return format_string($group->name, true, ['context' => $this->assignment->get_context()]);
} else if ($this->assignment->get_instance()->preventsubmissionnotingroup) {
$usergroups = $this->assignment->get_all_groups($row->id);
if (count($usergroups) > 1) {
return get_string('multipleteamsgrader', 'assign');
} else {
return get_string('noteamgrader', 'assign');
}
}
return get_string('defaultteam', 'assign');
}
/**
* Use a static cache to try and reduce DB calls.
*
* @param int $userid The user id for this submission
* @param int $group The groupid (returned)
* @param stdClass|false $submission The stdClass submission or false (returned)
* @param int $attemptnumber Return a specific attempt number (-1 for latest)
*/
protected function get_group_and_submission($userid, &$group, &$submission, $attemptnumber) {
$group = false;
if (isset($this->submissiongroups[$userid])) {
$group = $this->submissiongroups[$userid];
} else {
$group = $this->assignment->get_submission_group($userid, false);
$this->submissiongroups[$userid] = $group;
}
$groupid = 0;
if ($group) {
$groupid = $group->id;
}
// Static cache is keyed by groupid and attemptnumber.
// We may need both the latest and previous attempt in the same page.
if (isset($this->groupsubmissions[$groupid . ':' . $attemptnumber])) {
$submission = $this->groupsubmissions[$groupid . ':' . $attemptnumber];
} else {
$submission = $this->assignment->get_group_submission($userid, $groupid, false, $attemptnumber);
$this->groupsubmissions[$groupid . ':' . $attemptnumber] = $submission;
}
}
/**
* Format a list of outcomes.
*
* @param stdClass $row
* @return string
*/
public function col_outcomes(stdClass $row) {
$outcomes = '';
foreach ($this->gradinginfo->outcomes as $index => $outcome) {
$options = make_grades_menu(-$outcome->scaleid);
$options[0] = get_string('nooutcome', 'grades');
if ($this->quickgrading && !($outcome->grades[$row->userid]->locked)) {
$select = '<select name="outcome_' . $index . '_' . $row->userid . '" class="quickgrade">';
foreach ($options as $optionindex => $optionvalue) {
$selected = '';
if ($outcome->grades[$row->userid]->grade == $optionindex) {
$selected = 'selected="selected"';
}
$select .= '<option value="' . $optionindex . '"' . $selected . '>' . $optionvalue . '</option>';
}
$select .= '</select>';
$outcomes .= $this->output->container($outcome->name . ': ' . $select, 'outcome');
} else {
$name = $outcome->name . ': ' . $options[$outcome->grades[$row->userid]->grade];
if ($this->is_downloading()) {
$outcomes .= $name;
} else {
$outcomes .= $this->output->container($name, 'outcome');
}
}
}
return $outcomes;
}
/**
* Format a user picture for display.
*
* @param stdClass $row
* @return string
* @deprecated since Moodle 4.5
* @todo Final deprecation in Moodle 6.0. See MDL-82336.
*/
#[\core\attribute\deprecated(
replacement: null,
since: '4.5',
reason: 'Picture column is merged with fullname column'
)]
public function col_picture(stdClass $row) {
\core\deprecation::emit_deprecation_if_present([$this, __FUNCTION__]);
return $this->output->user_picture($row);
}
/**
* Format a user record for display (link to profile).
*
* @param stdClass $row
* @return string
*/
public function col_fullname($row) {
if (!$this->is_downloading()) {
$courseid = $this->assignment->get_course()->id;
$fullname = $this->output->render(\core_user::get_profile_picture($row, null,
['courseid' => $courseid, 'includefullname' => true]));
} else {
$fullname = $this->assignment->fullname($row);
}
if (!$this->assignment->is_active_user($row->id)) {
$suspendedstring = get_string('userenrolmentsuspended', 'grades');
$fullname .= ' ' . $this->output->pix_icon('i/enrolmentsuspended', $suspendedstring);
$fullname = html_writer::tag('span', $fullname, array('class' => 'usersuspended'));
}
return $fullname;
}
/**
* Insert a checkbox for selecting the current row for batch operations.
*
* @param stdClass $row
* @return string
*/
public function col_select(stdClass $row) {
$selectcol = '<label class="accesshide" for="selectuser_' . $row->userid . '">';
$selectcol .= get_string('selectuser', 'assign', $this->assignment->fullname($row));
$selectcol .= '</label>';
$selectcol .= '<input type="checkbox"
class="ignoredirty"
id="selectuser_' . $row->userid . '"
name="selectedusers"
value="' . $row->userid . '"/>';
$selectcol .= '<input type="hidden"
name="grademodified_' . $row->userid . '"
value="' . $row->timemarked . '"/>';
$selectcol .= '<input type="hidden"
name="gradeattempt_' . $row->userid . '"
value="' . $row->attemptnumber . '"/>';
return $selectcol;
}
/**
* Return a users grades from the listing of all grade data for this assignment.
*
* @param int $userid
* @return mixed stdClass or false
*/
private function get_gradebook_data_for_user($userid) {
if (isset($this->gradinginfo->items[0]) && $this->gradinginfo->items[0]->grades[$userid]) {
return $this->gradinginfo->items[0]->grades[$userid];
}
return false;
}
/**
* Format a column of data for display.
*
* @param stdClass $row
* @return string
*/
public function col_gradecanbechanged(stdClass $row) {
$gradingdisabled = $this->assignment->grading_disabled($row->id, true, $this->gradinginfo);
if ($gradingdisabled) {
return get_string('no');
} else {
return get_string('yes');
}
}
/**
* Format a column of data for display
*
* @param stdClass $row
* @return string
*/
public function col_grademax(stdClass $row) {
if ($this->assignment->get_instance()->grade > 0) {
$gradeitem = $this->assignment->get_grade_item();
return format_float($this->assignment->get_instance()->grade, $gradeitem->get_decimals());
} else {
return '';
}
}
/**
* Format a column of data for display.
*
* @param stdClass $row
* @return string
*/
public function col_grade(stdClass $row): string {
$gradingdisabled = $this->assignment->grading_disabled($row->id, true, $this->gradinginfo);
$displaygrade = $this->display_grade($row->grade, $this->quickgrading && !$gradingdisabled, $row->userid, $row->timemarked);
if (!$this->is_downloading() && $this->hasgrade) {
$urlparams = [
'id' => $this->assignment->get_course_module()->id,
'rownum' => 0,
'action' => 'grader',
];
if ($this->assignment->is_blind_marking()) {
if (empty($row->recordid)) {
$row->recordid = $this->assignment->get_uniqueid_for_user($row->userid);
}
$urlparams['blindid'] = $row->recordid;
} else {
$urlparams['userid'] = $row->userid;
}
$url = new moodle_url('/mod/assign/view.php', $urlparams);
// The container with the grade information.
$gradecontainer = $this->output->container($displaygrade, 'w-100');
$menu = new action_menu();
$menu->set_owner_selector('.gradingtable-actionmenu');
$menu->set_boundary('window');
$menu->set_kebab_trigger(get_string('gradeactions', 'assign'));
$menu->set_additional_classes('ps-2 ms-auto');
// Prioritise the menu ahead of all other actions.
$menu->prioritise = true;
// Add the 'Grade' action item to the contextual menu.
$menu->add(new action_menu_link_secondary($url, null, get_string('gradeverb')));
// The contextual menu container.
$contextualmenucontainer = $this->output->container($this->output->render($menu), 'd-flex');
return $this->output->container($gradecontainer . $contextualmenucontainer, ['class' => 'd-flex']);
}
// The table data is being downloaded, or the user cannot grade; therefore, only the formatted grade for display
// is returned.
return $displaygrade;
}
/**
* Format a column of data for display.
*
* @param stdClass $row
* @return string
*/
public function col_finalgrade(stdClass $row) {
$o = '';
$grade = $this->get_gradebook_data_for_user($row->userid);
if ($grade) {
$o = $this->display_grade($grade->grade, false, $row->userid, $row->timemarked);
}
return $o;
}
/**
* Format a column of data for display.
*
* @param stdClass $row
* @return string
*/
public function col_timemarked(stdClass $row) {
$o = '-';
if ($row->timemarked && $row->grade !== null && $row->grade >= 0) {
$o = userdate($row->timemarked);
}
if ($row->timemarked && $this->is_downloading()) {
// Force it for downloads as it affects import.
$o = userdate($row->timemarked);
}
return $o;
}
/**
* Format a column of data for display.
*
* @param stdClass $row
* @return string
*/
public function col_timesubmitted(stdClass $row) {
$o = '-';
$group = false;
$submission = false;
$this->get_group_and_submission($row->id, $group, $submission, -1);
if ($submission && $submission->timemodified && $submission->status != ASSIGN_SUBMISSION_STATUS_NEW) {
$o = userdate($submission->timemodified);
} else if ($row->timesubmitted && $row->status != ASSIGN_SUBMISSION_STATUS_NEW) {
$o = userdate($row->timesubmitted);
}
return $o;
}
/**
* Format a column of data for display
*
* @param stdClass $row
* @return string
*/
public function col_status(stdClass $row) {
global $USER;
$o = '';
$instance = $this->assignment->get_instance($row->userid);
$timelimitenabled = get_config('assign', 'enabletimelimit');
$due = $instance->duedate;
if ($row->extensionduedate) {
$due = $row->extensionduedate;
} else if (!empty($row->duedate)) {
// The override due date.
$due = $row->duedate;
}
$group = false;
$submission = false;
if ($instance->teamsubmission) {
$this->get_group_and_submission($row->id, $group, $submission, -1);
}
if ($instance->teamsubmission && !$group && !$instance->preventsubmissionnotingroup) {
$group = true;
}
if ($group && $submission) {
$timesubmitted = $submission->timemodified;
$status = $submission->status;
} else {
$timesubmitted = $row->timesubmitted;
$status = $row->status;
}
$displaystatus = $status;
if ($displaystatus == 'new') {
$displaystatus = '';
}
// Generate the output for the submission contextual (action) menu.
$actionmenu = '';
if (!$this->is_downloading() && $this->hasgrade) {
$submissionsopen = $this->assignment->submissions_open(
userid: $row->id,
skipenrolled: true,
submission: $submission ? $submission : $row,
flags: $row,
gradinginfo: $this->gradinginfo
);
$caneditsubmission = $this->assignment->can_edit_submission($row->id, $USER->id);
$baseactionurl = new moodle_url('/mod/assign/view.php', [
'id' => $this->assignment->get_course_module()->id,
'userid' => $row->id,
'sesskey' => sesskey(),
'page' => $this->currpage,
]);
$menu = new action_menu();
$menu->set_owner_selector('.gradingtable-actionmenu');
$menu->set_boundary('window');
$menu->set_kebab_trigger(get_string('submissionactions', 'assign'));
$menu->set_additional_classes('ps-2 ms-auto');
// Prioritise the menu ahead of all other actions.
$menu->prioritise = true;
// Hide for offline assignments.
if ($this->assignment->is_any_submission_plugin_enabled()) {
if ($submissionsopen && $USER->id != $row->id && $caneditsubmission) {
// Edit submission action link.
$baseactionurl->param('action', 'editsubmission');
$description = get_string('editsubmission', 'assign');
$menu->add(new action_menu_link_secondary($baseactionurl, null, $description));
}
if (!$row->status || $row->status == ASSIGN_SUBMISSION_STATUS_DRAFT
|| !$this->assignment->get_instance()->submissiondrafts) {
// Allow/prevent submission changes action link.
$baseactionurl->param('action', $row->locked ? 'unlock' : 'lock');
$description = $row->locked ? get_string('allowsubmissionsshort', 'assign') :
get_string('preventsubmissionsshort', 'assign');
$menu->add(new action_menu_link_secondary($baseactionurl, null, $description));
}
}
if (($this->assignment->get_instance()->duedate || $this->assignment->get_instance()->cutoffdate) &&
$this->hasgrantextension) {
// Grant extension action link.
$baseactionurl->param('action', 'grantextension');
$description = get_string('grantextension', 'assign');
$menu->add(new action_menu_link_secondary($baseactionurl, null, $description));
}
if ($row->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED &&
$this->assignment->get_instance()->submissiondrafts) {
// Revert submission to draft action link.
$baseactionurl->param('action', 'reverttodraft');
$description = get_string('reverttodraftshort', 'assign');
$menu->add(new action_menu_link_secondary($baseactionurl, null, $description));
}
if ($row->status == ASSIGN_SUBMISSION_STATUS_DRAFT && $this->assignment->get_instance()->submissiondrafts &&
$caneditsubmission && $submissionsopen && $row->id != $USER->id) {
// Submit for grading action link.
$baseactionurl->param('action', 'submitotherforgrading');
$description = get_string('submitforgrading', 'assign');
$menu->add(new action_menu_link_secondary($baseactionurl, null, $description));
}
$ismanual = $this->assignment->get_instance()->attemptreopenmethod == ASSIGN_ATTEMPT_REOPEN_METHOD_MANUAL;
$hassubmission = !empty($row->status);
$notreopened = $hassubmission && $row->status != ASSIGN_SUBMISSION_STATUS_REOPENED;
$isunlimited = $this->assignment->get_instance()->maxattempts == ASSIGN_UNLIMITED_ATTEMPTS;
$hasattempts = $isunlimited || $row->attemptnumber < $this->assignment->get_instance()->maxattempts - 1;
if ($ismanual && $hassubmission && $notreopened && $hasattempts) {
// Allow another attempt action link.
$baseactionurl->param('action', 'addattempt');
$description = get_string('addattempt', 'assign');
$menu->add(new action_menu_link_secondary($baseactionurl, null, $description));
}
if ($this->assignment->is_any_submission_plugin_enabled()) {
if ($USER->id != $row->id && $caneditsubmission && !empty($row->status)) {
// Remove submission action link. This action link should be always placed as the last item
// within the contextual menu.
$baseactionurl->param('action', 'removesubmissionconfirm');
$description = get_string('removesubmission', 'assign');
$menu->add(new action_menu_link_secondary($baseactionurl, null, $description,
['class' => 'text-danger']));
}
}
$actionmenu = $this->output->render($menu);
}
$actionmenucontainer = $this->output->container($actionmenu, 'd-flex');
// Generate the output for the submission information.
$submissioninfo = '';
if ($this->assignment->is_any_submission_plugin_enabled()) {
$submissioninfo .= $this->output->container(get_string('submissionstatus_' . $displaystatus, 'assign'),
['class' => 'submissionstatus' . $displaystatus]);
if ($due && $timesubmitted > $due && $status != ASSIGN_SUBMISSION_STATUS_NEW) {
$usertime = format_time($timesubmitted - $due);
$latemessage = get_string('submittedlateshort',
'assign',
$usertime);
$submissioninfo .= $this->output->container($latemessage, 'latesubmission');
} else if ($timelimitenabled && $instance->timelimit && !empty($submission->timestarted)
&& ($timesubmitted - $submission->timestarted > $instance->timelimit)
&& $status != ASSIGN_SUBMISSION_STATUS_NEW) {
$usertime = format_time($timesubmitted - $submission->timestarted - $instance->timelimit);
$latemessage = get_string('submittedlateshort', 'assign', $usertime);
$submissioninfo .= $this->output->container($latemessage, 'latesubmission');
}
if ($row->locked) {
$lockedstr = get_string('submissionslockedshort', 'assign');
$submissioninfo .= $this->output->container($lockedstr, 'lockedsubmission');
}
// Add status of "grading" if markflow is not enabled.
if (!$instance->markingworkflow) {
if ($row->grade !== null && $row->grade >= 0) {
if ($row->timemarked < $row->timesubmitted) {
$submissioninfo .= $this->output->container(get_string('gradedfollowupsubmit', 'assign'), 'gradingreminder');
} else {
$submissioninfo .= $this->output->container(get_string('graded', 'assign'), 'submissiongraded');
}
} else if (!$timesubmitted || $status == ASSIGN_SUBMISSION_STATUS_NEW) {
$now = time();
if ($due && ($now > $due)) {
$overduestr = get_string('overdue', 'assign', format_time($now - $due));
$submissioninfo .= $this->output->container($overduestr, 'overduesubmission');
}
}
}
}
if ($instance->markingworkflow) {
$submissioninfo .= $this->col_workflowstatus($row);
}
if ($row->extensionduedate) {
$userdate = userdate($row->extensionduedate);
$extensionstr = get_string('userextensiondate', 'assign', $userdate);
$submissioninfo .= $this->output->container($extensionstr, 'extensiondate');
}
// The container with the submission information.
$submissoninfocontainer = $this->output->container($submissioninfo, 'submissioninfo w-100');
$o .= $this->output->container($submissoninfocontainer . $actionmenucontainer, 'd-flex');
if ($this->is_downloading()) {
$o = strip_tags(rtrim(str_replace('</div>', ' - ', $o), '- '));
}
return $o;
}
/**
* Format a column of data for display.
*
* @param stdClass $row
* @return string
*/
public function col_allowsubmissionsfromdate(stdClass $row) {
$o = '';
if ($row->allowsubmissionsfromdate) {
$userdate = userdate($row->allowsubmissionsfromdate);
$o = ($this->is_downloading()) ? $userdate : $this->output->container($userdate, 'allowsubmissionsfromdate');
}
return $o;
}
/**
* Format a column of data for display.
*
* @param stdClass $row
* @return string
*/
public function col_duedate(stdClass $row) {
$o = '';
if ($row->duedate) {
$userdate = userdate($row->duedate);
$o = ($this->is_downloading()) ? $userdate : $this->output->container($userdate, 'duedate');
}
return $o;
}
/**
* Format a column of data for display.
*
* @param stdClass $row
* @return string
*/
public function col_cutoffdate(stdClass $row) {
$o = '';
if ($row->cutoffdate) {
$userdate = userdate($row->cutoffdate);
$o = ($this->is_downloading()) ? $userdate : $this->output->container($userdate, 'cutoffdate');
}
return $o;
}
/**
* Format a column of data for display.
*
* @param stdClass $row
* @return string
* @deprecated since Moodle 4.5
* @todo Final deprecation in Moodle 6.0. See MDL-82336.
*/
#[\core\attribute\deprecated(
replacement: null,
since: '4.5',
reason: 'Userid column is merged with status and grade columns'
)]
public function col_userid(stdClass $row) {
global $USER;
\core\deprecation::emit_deprecation_if_present([$this, __FUNCTION__]);
$edit = '';
$actions = array();
$urlparams = array('id' => $this->assignment->get_course_module()->id,
'rownum' => 0,
'action' => 'grader');
if ($this->assignment->is_blind_marking()) {
if (empty($row->recordid)) {
$row->recordid = $this->assignment->get_uniqueid_for_user($row->userid);
}
$urlparams['blindid'] = $row->recordid;
} else {
$urlparams['userid'] = $row->userid;
}
$url = new moodle_url('/mod/assign/view.php', $urlparams);
$noimage = null;
if (!$row->grade) {
$description = get_string('gradeverb');
} else {
$description = get_string('updategrade', 'assign');
}
$actions['grade'] = new action_menu_link_secondary(
$url,
$noimage,
$description
);
// Everything we need is in the row.
$submission = $row;
$flags = $row;
if ($this->assignment->get_instance()->teamsubmission) {
// Use the cache for this.
$submission = false;
$group = false;
$this->get_group_and_submission($row->id, $group, $submission, -1);
}
$submissionsopen = $this->assignment->submissions_open($row->id,
true,
$submission,
$flags,
$this->gradinginfo);
$caneditsubmission = $this->assignment->can_edit_submission($row->id, $USER->id);
// Hide for offline assignments.
if ($this->assignment->is_any_submission_plugin_enabled()) {
if (!$row->status ||
$row->status == ASSIGN_SUBMISSION_STATUS_DRAFT ||
!$this->assignment->get_instance()->submissiondrafts) {
if (!$row->locked) {
$urlparams = array('id' => $this->assignment->get_course_module()->id,
'userid' => $row->id,
'action' => 'lock',
'sesskey' => sesskey(),
'page' => $this->currpage);
$url = new moodle_url('/mod/assign/view.php', $urlparams);
$description = get_string('preventsubmissionsshort', 'assign');
$actions['lock'] = new action_menu_link_secondary(
$url,
$noimage,
$description
);
} else {
$urlparams = array('id' => $this->assignment->get_course_module()->id,
'userid' => $row->id,
'action' => 'unlock',
'sesskey' => sesskey(),
'page' => $this->currpage);
$url = new moodle_url('/mod/assign/view.php', $urlparams);
$description = get_string('allowsubmissionsshort', 'assign');
$actions['unlock'] = new action_menu_link_secondary(
$url,
$noimage,
$description
);
}
}
if ($submissionsopen &&
$USER->id != $row->id &&
$caneditsubmission) {
$urlparams = array('id' => $this->assignment->get_course_module()->id,
'userid' => $row->id,
'action' => 'editsubmission',
'sesskey' => sesskey(),
'page' => $this->currpage);
$url = new moodle_url('/mod/assign/view.php', $urlparams);
$description = get_string('editsubmission', 'assign');
$actions['editsubmission'] = new action_menu_link_secondary(
$url,
$noimage,
$description
);
}
if ($USER->id != $row->id &&
$caneditsubmission &&
!empty($row->status)) {
$urlparams = array('id' => $this->assignment->get_course_module()->id,
'userid' => $row->id,
'action' => 'removesubmissionconfirm',
'sesskey' => sesskey(),
'page' => $this->currpage);
$url = new moodle_url('/mod/assign/view.php', $urlparams);
$description = get_string('removesubmission', 'assign');
$actions['removesubmission'] = new action_menu_link_secondary(
$url,
$noimage,
$description
);
}
}
if (($this->assignment->get_instance()->duedate ||
$this->assignment->get_instance()->cutoffdate) &&
$this->hasgrantextension) {
$urlparams = array('id' => $this->assignment->get_course_module()->id,
'userid' => $row->id,
'action' => 'grantextension',
'sesskey' => sesskey(),
'page' => $this->currpage);
$url = new moodle_url('/mod/assign/view.php', $urlparams);
$description = get_string('grantextension', 'assign');
$actions['grantextension'] = new action_menu_link_secondary(
$url,
$noimage,
$description
);
}
if ($row->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED &&
$this->assignment->get_instance()->submissiondrafts) {
$urlparams = array('id' => $this->assignment->get_course_module()->id,
'userid' => $row->id,
'action' => 'reverttodraft',
'sesskey' => sesskey(),
'page' => $this->currpage);
$url = new moodle_url('/mod/assign/view.php', $urlparams);
$description = get_string('reverttodraftshort', 'assign');
$actions['reverttodraft'] = new action_menu_link_secondary(
$url,
$noimage,
$description
);
}
if ($row->status == ASSIGN_SUBMISSION_STATUS_DRAFT &&
$this->assignment->get_instance()->submissiondrafts &&
$caneditsubmission &&
$submissionsopen &&
$row->id != $USER->id) {
$urlparams = array('id' => $this->assignment->get_course_module()->id,
'userid' => $row->id,
'action' => 'submitotherforgrading',
'sesskey' => sesskey(),
'page' => $this->currpage);
$url = new moodle_url('/mod/assign/view.php', $urlparams);
$description = get_string('submitforgrading', 'assign');
$actions['submitforgrading'] = new action_menu_link_secondary(
$url,
$noimage,
$description
);
}
$ismanual = $this->assignment->get_instance()->attemptreopenmethod == ASSIGN_ATTEMPT_REOPEN_METHOD_MANUAL;
$hassubmission = !empty($row->status);
$notreopened = $hassubmission && $row->status != ASSIGN_SUBMISSION_STATUS_REOPENED;
$isunlimited = $this->assignment->get_instance()->maxattempts == ASSIGN_UNLIMITED_ATTEMPTS;
$hasattempts = $isunlimited || $row->attemptnumber < $this->assignment->get_instance()->maxattempts - 1;
if ($ismanual && $hassubmission && $notreopened && $hasattempts) {
$urlparams = array('id' => $this->assignment->get_course_module()->id,
'userid' => $row->id,
'action' => 'addattempt',
'sesskey' => sesskey(),
'page' => $this->currpage);
$url = new moodle_url('/mod/assign/view.php', $urlparams);
$description = get_string('addattempt', 'assign');
$actions['addattempt'] = new action_menu_link_secondary(
$url,
$noimage,
$description
);
}
$menu = new action_menu();
$menu->set_owner_selector('.gradingtable-actionmenu');
$menu->set_boundary('window');
$menu->set_menu_trigger(get_string('edit'));
foreach ($actions as $action) {
$menu->add($action);
}
// Prioritise the menu ahead of all other actions.
$menu->prioritise = true;
$edit .= $this->output->render($menu);
return $edit;
}
/**
* Write the plugin summary with an optional link to view the full feedback/submission.
*
* @param assign_plugin $plugin Submission plugin or feedback plugin
* @param stdClass $item Submission or grade
* @param string $returnaction The return action to pass to the
* view_submission page (the current page)
* @param string $returnparams The return params to pass to the view_submission
* page (the current page)
* @return string The summary with an optional link
*/
private function format_plugin_summary_with_link(assign_plugin $plugin,
stdClass $item,
$returnaction,
$returnparams) {
$link = '';
$showviewlink = false;
$summary = $plugin->view_summary($item, $showviewlink);
$separator = '';
if ($showviewlink) {
$viewstr = get_string('view' . substr($plugin->get_subtype(), strlen('assign')), 'assign');
$icon = $this->output->pix_icon('t/viewdetails', $viewstr);
$urlparams = array('id' => $this->assignment->get_course_module()->id,
'sid' => $item->id,
'gid' => $item->id,
'plugin' => $plugin->get_type(),
'action' => 'viewplugin' . $plugin->get_subtype(),
'returnaction' => $returnaction,
'returnparams' => http_build_query($returnparams));
$url = new moodle_url('/mod/assign/view.php', $urlparams);
$link = $this->output->action_link($url, $icon);
$separator = $this->output->spacer(array(), true);
}
return $link . $separator . $summary;
}
/**
* Format the submission and feedback columns.
*
* @param string $colname The column name
* @param stdClass $row The submission row
* @return mixed string or NULL
*/
public function other_cols($colname, $row) {
// For extra user fields the result is already in $row.
if (empty($this->plugincache[$colname])) {
return parent::other_cols($colname, $row);
}
// This must be a plugin field.
$plugincache = $this->plugincache[$colname];
$plugin = $plugincache[0];
$field = null;
if (isset($plugincache[1])) {
$field = $plugincache[1];
}
if ($plugin->is_visible() && $plugin->is_enabled()) {
if ($plugin->get_subtype() == 'assignsubmission') {
if ($this->assignment->get_instance()->teamsubmission) {
$group = false;
$submission = false;
$this->get_group_and_submission($row->id, $group, $submission, -1);
if ($submission) {
if ($submission->status == ASSIGN_SUBMISSION_STATUS_REOPENED) {
// For a newly reopened submission - we want to show the previous submission in the table.
$this->get_group_and_submission($row->id, $group, $submission, $submission->attemptnumber-1);
}
if (isset($field)) {
return $plugin->get_editor_text($field, $submission->id);
}
return $this->format_plugin_summary_with_link($plugin,
$submission,
'grading',
array());
}
} else if ($row->submissionid) {
if ($row->status == ASSIGN_SUBMISSION_STATUS_REOPENED) {
// For a newly reopened submission - we want to show the previous submission in the table.
$submission = $this->assignment->get_user_submission($row->userid, false, $row->attemptnumber - 1);
} else {
$submission = new stdClass();
$submission->id = $row->submissionid;
$submission->timecreated = $row->firstsubmission;
$submission->timemodified = $row->timesubmitted;
$submission->assignment = $this->assignment->get_instance()->id;
$submission->userid = $row->userid;
$submission->attemptnumber = $row->attemptnumber;
}
// Field is used for only for import/export and refers the the fieldname for the text editor.
if (isset($field)) {
return $plugin->get_editor_text($field, $submission->id);
}
return $this->format_plugin_summary_with_link($plugin,
$submission,
'grading',
array());
}
} else {
$grade = null;
if (isset($field)) {
return $plugin->get_editor_text($field, $row->gradeid);
}
if ($row->gradeid) {
$grade = new stdClass();
$grade->id = $row->gradeid;
$grade->timecreated = $row->firstmarked;
$grade->timemodified = $row->timemarked;
$grade->assignment = $this->assignment->get_instance()->id;
$grade->userid = $row->userid;
$grade->grade = $row->grade;
$grade->mailed = $row->mailed;
$grade->attemptnumber = $row->attemptnumber;
}
if ($this->quickgrading && $plugin->supports_quickgrading()) {
return $plugin->get_quickgrading_html($row->userid, $grade);
} else if ($grade) {
return $this->format_plugin_summary_with_link($plugin,
$grade,
'grading',
array());
}
}
}
return '';
}
/**
* Using the current filtering and sorting - load all rows and return a single column from them.
*
* @param string $columnname The name of the raw column data
* @return array of data
*/
public function get_column_data($columnname) {
$this->setup();
$this->currpage = 0;
$this->query_db($this->tablemaxrows);
$result = array();
foreach ($this->rawdata as $row) {
$result[] = $row->$columnname;
}
return $result;
}
/**
* Return things to the renderer.
*
* @return string the assignment name
*/
public function get_assignment_name() {
return $this->assignment->get_instance()->name;
}
/**
* Return things to the renderer.
*
* @return int the course module id
*/
public function get_course_module_id() {
return $this->assignment->get_course_module()->id;
}
/**
* Return things to the renderer.
*
* @return int the course id
*/
public function get_course_id() {
return $this->assignment->get_course()->id;
}
/**
* Return things to the renderer.
*
* @return stdClass The course context
*/
public function get_course_context() {
return $this->assignment->get_course_context();
}
/**
* Return things to the renderer.
*
* @return bool Does this assignment accept submissions
*/
public function submissions_enabled() {
return $this->assignment->is_any_submission_plugin_enabled();
}
/**
* Return things to the renderer.
*
* @return bool Can this user view all grades (the gradebook)
*/
public function can_view_all_grades() {
$context = $this->assignment->get_course_context();
return has_capability('gradereport/grader:view', $context) &&
has_capability('moodle/grade:viewall', $context);
}
/**
* Always return a valid sort - even if the userid column is missing.
* @return array column name => SORT_... constant.
*/
public function get_sort_columns() {
$result = parent::get_sort_columns();
$assignment = $this->assignment->get_instance();
if (empty($assignment->blindmarking)) {
$result = array_merge($result, array('userid' => SORT_ASC));
} else {
$result = array_merge($result, [
'COALESCE(s.timecreated, ' . time() . ')' => SORT_ASC,
'COALESCE(s.id, ' . PHP_INT_MAX . ')' => SORT_ASC,
'um.id' => SORT_ASC,
]);
}
return $result;
}
/**
* Override the table show_hide_link to not show for select column.
*
* @param string $column the column name, index into various names.
* @param int $index numerical index of the column.
* @return string HTML fragment.
*/
protected function show_hide_link($column, $index) {
if ($index > 0 || !$this->hasgrade) {
return parent::show_hide_link($column, $index);
}
return '';
}
/**
* Overides setup to ensure it will only run a single time.
*/
public function setup() {
// Check if the setup function has been called before, we should not run it twice.
// If we do the sortorder of the table will be broken.
if (!empty($this->setup)) {
return;
}
parent::setup();
}
/**
* Returns the html for the paging bar.
*
* @return string
*/
public function get_paging_bar(): string {
global $OUTPUT;
if ($this->use_pages) {
$pagingbar = new paging_bar($this->totalrows, $this->currpage, $this->pagesize, $this->baseurl);
$pagingbar->pagevar = $this->request[TABLE_VAR_PAGE];
return $OUTPUT->render($pagingbar);
}
return '';
}
/**
* Returns the html for the paging selector.
*
* @return string
*/
public function get_paging_selector(): string {
global $OUTPUT;
if ($this->use_pages) {
$pagingoptions = [...$this->pagingoptions, $this->perpage]; // To make sure the actual page size is within the options.
$pagingoptions = array_unique($pagingoptions);
sort($pagingoptions);
$pagingoptions = array_combine($pagingoptions, $pagingoptions);
$maxperpage = get_config('assign', 'maxperpage');
if (isset($maxperpage) && $maxperpage != -1) {
// Remove any options that are greater than the maxperpage.
$pagingoptions = array_filter($pagingoptions, fn($value) => $value <= $maxperpage);
} else {
$pagingoptions[-1] = get_string('all');
}
$data = [
'baseurl' => $this->baseurl->out(false),
'options' => array_map(fn($key, $name): array => [
'name' => $name,
'value' => $key,
'selected' => $key == $this->perpage,
], array_keys($pagingoptions), $pagingoptions),
];
return $OUTPUT->render_from_template('mod_assign/grading_paging_selector', $data);
}
return '';
}
/**
* Finish the HTML output.
* This function is essentially a copy of the parent function except the paging bar not being rendered.
*
* @return void
*/
public function finish_html(): void {
if (!$this->started_output) {
// No data has been added to the table.
$this->print_nothing_to_display();
} else {
// Print empty rows to fill the table to the current pagesize.
// This is done so the header aria-controls attributes do not point to
// non-existent elements.
$emptyrow = array_fill(0, count($this->columns), '');
while ($this->currentrow < $this->pagesize) {
$this->print_row($emptyrow, 'emptyrow');
}
echo html_writer::end_tag('tbody');
echo html_writer::end_tag('table');
if ($this->responsive) {
echo html_writer::end_tag('div');
}
$this->wrap_html_finish();
if (in_array(TABLE_P_BOTTOM, $this->showdownloadbuttonsat)) {
echo $this->download_buttons();
}
// Render the dynamic table footer.
echo $this->get_dynamic_table_html_end();
}
}
/**
* Start the HTML output.
* This function is essentially a copy of the parent function except the paging bar not being rendered.
*
* @return void
*/
public function start_html(): void {
// Render the dynamic table header.
echo $this->get_dynamic_table_html_start();
// Render button to allow user to reset table preferences.
echo $this->render_reset_button();
// Do we need to print initial bars?
$this->print_initials_bar();
if (in_array(TABLE_P_TOP, $this->showdownloadbuttonsat)) {
echo $this->download_buttons();
}
$this->wrap_html_start();
// Start of main data table.
if ($this->responsive) {
echo html_writer::start_tag('div', ['class' => 'no-overflow']);
}
echo html_writer::start_tag('table', $this->attributes) . $this->render_caption();
}
}