<?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/>.
/**
* Renderable that initialises the grading "app".
*
* @package mod_assign
* @copyright 2016 Damyon Wiese
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_assign\output;
defined('MOODLE_INTERNAL') || die();
use renderer_base;
use renderable;
use templatable;
use stdClass;
/**
* Grading app renderable.
*
* @package mod_assign
* @since Moodle 3.1
* @copyright 2016 Damyon Wiese
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class grading_app implements templatable, renderable {
/**
* @var $userid - The initial user id.
*/
public $userid = 0;
/**
* @var $groupid - The initial group id.
*/
public $groupid = 0;
/**
* @var $assignment - The assignment instance.
*/
public $assignment = null;
/**
> * @var array - List of user records with extra fields.
* Constructor for this renderable.
> */
*
> public $participants = [];
* @param int $userid The user we will open the grading app too.
>
* @param int $groupid If groups are enabled this is the current course group.
> /**
< * @param assign $assignment The assignment class
> * @param \assign $assignment The assignment class
*/
public function __construct($userid, $groupid, $assignment) {
$this->userid = $userid;
$this->groupid = $groupid;
$this->assignment = $assignment;
user_preference_allow_ajax_update('assign_filter', PARAM_ALPHA);
user_preference_allow_ajax_update('assign_workflowfilter', PARAM_ALPHA);
user_preference_allow_ajax_update('assign_markerfilter', PARAM_ALPHANUMEXT);
$this->participants = $assignment->list_participants_with_filter_status_and_group($groupid);
if (!$this->userid && count($this->participants)) {
$this->userid = reset($this->participants)->id;
}
}
/**
* Export this class data as a flat list for rendering in a template.
*
* @param renderer_base $output The current page renderer.
* @return stdClass - Flat list of exported data.
*/
public function export_for_template(renderer_base $output) {
global $CFG, $USER;
$export = new stdClass();
$export->userid = $this->userid;
$export->assignmentid = $this->assignment->get_instance()->id;
$export->cmid = $this->assignment->get_course_module()->id;
$export->contextid = $this->assignment->get_context()->id;
$export->groupid = $this->groupid;
$export->name = $this->assignment->get_context()->get_context_name(true, false, false);
$export->courseid = $this->assignment->get_course()->id;
$export->participants = array();
$export->filters = $this->assignment->get_filters();
$export->markingworkflowfilters = $this->assignment->get_marking_workflow_filters(true);
$export->hasmarkingworkflow = count($export->markingworkflowfilters) > 0;
$export->markingallocationfilters = $this->assignment->get_marking_allocation_filters(true);
$export->hasmarkingallocation = count($export->markingallocationfilters) > 0;
$num = 1;
foreach ($this->participants as $idx => $record) {
$user = new stdClass();
$user->id = $record->id;
$user->fullname = fullname($record);
$user->requiregrading = $record->requiregrading;
$user->grantedextension = $record->grantedextension;
$user->submitted = $record->submitted;
if (!empty($record->groupid)) {
$user->groupid = $record->groupid;
$user->groupname = $record->groupname;
}
if ($record->id == $this->userid) {
$export->index = $num;
$user->current = true;
}
$export->participants[] = $user;
$num++;
}
$feedbackplugins = $this->assignment->get_feedback_plugins();
$showreview = false;
foreach ($feedbackplugins as $plugin) {
if ($plugin->is_enabled() && $plugin->is_visible()) {
if ($plugin->supports_review_panel()) {
$showreview = true;
}
}
}
$export->actiongrading = 'grading';
$export->viewgrading = get_string('viewgrading', 'mod_assign');
$export->showreview = $showreview;
$time = time();
$export->count = count($export->participants);
$export->coursename = $this->assignment->get_course_context()->get_context_name(true, false, false);
$export->caneditsettings = has_capability('mod/assign:addinstance', $this->assignment->get_context());
$export->duedate = $this->assignment->get_instance()->duedate;
$export->duedatestr = userdate($this->assignment->get_instance()->duedate);
// Time remaining.
$due = '';
if ($export->duedate - $time <= 0) {
$due = get_string('assignmentisdue', 'assign');
} else {
$due = get_string('timeremainingcolon', 'assign', format_time($export->duedate - $time));
}
$export->timeremainingstr = $due;
if ($export->duedate < $time) {
$export->cutoffdate = $this->assignment->get_instance()->cutoffdate;
$cutoffdate = $export->cutoffdate;
if ($cutoffdate) {
if ($cutoffdate > $time) {
$late = get_string('latesubmissionsaccepted', 'assign', userdate($export->cutoffdate));
} else {
$late = get_string('nomoresubmissionsaccepted', 'assign');
}
$export->cutoffdatestr = $late;
}
}
$export->defaultsendnotifications = $this->assignment->get_instance()->sendstudentnotifications;
$export->rarrow = $output->rarrow();
$export->larrow = $output->larrow();
// List of identity fields to display (the user info will not contain any fields the user cannot view anyway).
// TODO Does not support custom user profile fields (MDL-70456).
$export->showuseridentity = implode(',', \core_user\fields::get_identity_fields(null, false));
$export->currentuserid = $USER->id;
$helpicon = new \help_icon('sendstudentnotifications', 'assign');
$export->helpicon = $helpicon->export_for_template($output);
return $export;
}
}