Commit 3d1331be authored by Frederic Massart's avatar Frederic Massart
Browse files

MDL-40055 mod_assign: Replace add_to_log 'lock submission'

parent 76e77b05
<?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/>.
/**
* mod_assign submission locked event.
*
* @package mod_assign
* @copyright 2013 Frédéric Massart
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_assign\event;
defined('MOODLE_INTERNAL') || die();
/**
* mod_assign submission locked event class.
*
* @package mod_assign
* @copyright 2013 Frédéric Massart
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class submission_locked extends \core\event\base {
/**
* Legacy log data.
*
* @var array
*/
protected $legacylogdata;
/**
* Returns description of what happened.
*
* @return string
*/
public function get_description() {
return "User {$this->userid} locked the submission for user {$this->relateduserid}.";
}
/**
* Return legacy data for add_to_log().
*
* @return array
*/
public function get_legacy_logdata() {
return $this->legacylogdata;
}
/**
* Return localised event name.
*
* @return \lang_string
*/
public static function get_name() {
return new \lang_string('event_submission_locked', 'mod_assign');
}
/**
* Get URL related to the action
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/mod/assign/view.php', array('id' => $this->context->instanceid));
}
/**
* Init method.
*
* @return void
*/
protected function init() {
$this->data['crud'] = 'u';
$this->data['level'] = 50; // TODO MDL-37658.
$this->data['objecttable'] = 'assign';
}
/**
* Sets the legacy event log data.
*
* @param stdClass $legacylogdata legacy log data.
* @return void
*/
public function set_legacy_logdata($legacylogdata) {
$this->legacylogdata = $legacylogdata;
}
/**
* Custom validation.
*
* @throws coding_exception
* @return void
*/
protected function validate_data() {
if (!isset($this->relateduserid)) {
throw new coding_exception('relateduserid is a mandatory property.');
}
}
}
......@@ -143,6 +143,7 @@ $string['editaction'] = 'Actions...';
$string['event_assessable_submitted'] = 'A submission has been submitted.';
$string['event_all_submissions_downloaded'] = 'All the submissions are being downloaded.';
$string['event_extension_granted'] = 'An extension has been granted.';
$string['event_submission_locked'] = 'The submissions have been locked for a user.';
$string['extensionduedate'] = 'Extension due date';
$string['extensionnotafterduedate'] = 'Extension date must be after the due date';
$string['extensionnotafterfromdate'] = 'Extension date must be after the allow submissions from date';
......
......@@ -5687,7 +5687,15 @@ class assign {
$logmessage = get_string('locksubmissionforstudent',
'assign',
array('id'=>$user->id, 'fullname'=>fullname($user)));
$this->add_to_log('lock submission', $logmessage);
$addtolog = $this->add_to_log('lock submission', $logmessage, '', true);
$params = array(
'context' => $this->context,
'objectid' => $flags->assignment,
'relateduserid' => $user->id
);
$event = \mod_assign\event\submission_locked::create($params);
$event->set_legacy_logdata($addtolog);
$event->trigger();
}
......
......@@ -255,6 +255,10 @@ class testable_assign extends assign {
return parent::process_add_attempt($userid);
}
public function testable_process_lock($userid = 0) {
return parent::process_lock($userid);
}
public function testable_submissions_open($userid = 0) {
return parent::submissions_open($userid);
}
......
......@@ -972,5 +972,38 @@ class mod_assign_locallib_testcase extends mod_assign_base_testcase {
$sink->close();
}
public function test_submission_locked_event() {
$this->editingteachers[0]->ignoresesskey = true;
$this->setUser($this->editingteachers[0]);
$assign = $this->create_instance();
$sink = $this->redirectEvents();
$assign->testable_process_lock($this->students[0]->id);
$events = $sink->get_events();
$this->assertCount(1, $events);
$event = reset($events);
$this->assertInstanceOf('\mod_assign\event\submission_locked', $event);
$this->assertEquals($assign->get_context(), $event->get_context());
$this->assertEquals($assign->get_instance()->id, $event->objectid);
$this->assertEquals($this->students[0]->id, $event->relateduserid);
$expected = array(
$assign->get_course()->id,
'assign',
'lock submission',
'view.php?id=' . $assign->get_course_module()->id,
get_string('locksubmissionforstudent', 'assign', array('id' => $this->students[0]->id,
'fullname' => fullname($this->students[0]))),
$assign->get_course_module()->id,
$this->editingteachers[0]->id
);
$this->assertEventLegacyLogData($expected, $event);
$sink->close();
// Revert to defaults.
$this->editingteachers[0]->ignoresesskey = false;
}
}
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment