MDL-40061 mod_data: replaced 'templates saved' add_to_log call with an event

This commit is contained in:
Mark Nelson 2014-02-10 22:24:52 -08:00
parent 3ac413b28e
commit 3909293faf
4 changed files with 138 additions and 1 deletions

View File

@ -0,0 +1,88 @@
<?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/>.
/**
* The mod_data template updated event.
*
* @property-read array $other {
* Extra information about event.
*
* @type int dataid the id of the data activity.
* }
*
* @package mod_data
* @copyright 2014 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_data\event;
defined('MOODLE_INTERNAL') || die();
class template_updated extends \core\event\base {
/**
* Init method.
*
* @return void
*/
protected function init() {
$this->data['crud'] = 'u';
$this->data['edulevel'] = self::LEVEL_OTHER;
}
/**
* Return localised event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventtemplateupdated', 'mod_data');
}
/**
* Returns description of what happened.
*
* @return string
*/
public function get_description() {
return 'The template for the database activity ' . $this->other['dataid'] . ' was updated by the user ' . $this->userid;
}
/**
* Get the legacy event log data.
*
* @return array
*/
public function get_legacy_logdata() {
return array($this->courseid, 'data', 'templates saved', 'templates.php?id=' . $this->contextinstanceid .
'&amp;d=' . $this->other['dataid'], $this->other['dataid'], $this->contextinstanceid);
}
/**
* Custom validation.
*
* @throws \coding_exception when validation does not pass.
* @return void
*/
protected function validate_data() {
parent::validate_data();
if (!isset($this->other['dataid'])) {
throw new \coding_exception('The dataid must be set in $other.');
}
}
}

View File

@ -124,6 +124,7 @@ $string['eventfielddeleted'] = 'Field deleted';
$string['eventfieldupdated'] = 'Field updated';
$string['eventrecordcreated'] = 'Record created';
$string['eventrecordupdated'] = 'Record updated';
$string['eventtemplateupdated'] = 'Template updated';
$string['eventtemplateviewed'] = 'Templates viewed';
$string['fileencoding'] = 'Encoding';
$string['entries'] = 'Entries';

View File

@ -144,7 +144,16 @@ if (($mytemplate = data_submitted()) && confirm_sesskey()) {
if (empty($disableeditor) && empty($enableeditor)) {
$DB->update_record('data', $newtemplate);
echo $OUTPUT->notification(get_string('templatesaved', 'data'), 'notifysuccess');
add_to_log($course->id, 'data', 'templates saved', "templates.php?id=$cm->id&amp;d=$data->id", $data->id, $cm->id);
// Trigger an event for saving the templates.
$event = \mod_data\event\template_updated::create(array(
'context' => $context,
'courseid' => $course->id,
'other' => array(
'dataid' => $data->id,
)
));
$event->trigger();
}
}
}

View File

@ -251,4 +251,43 @@ class mod_data_events_testcase extends advanced_testcase {
$data->id, $data->id, $data->cmid);
$this->assertEventLegacyLogData($expected, $event);
}
/**
* Test the template updated event.
*
* There is no external API for updating a template, so the unit test will simply create
* and trigger the event and ensure the legacy log data is returned as expected.
*/
public function test_template_updated() {
// Create a course we are going to add a data module to.
$course = $this->getDataGenerator()->create_course();
// The generator used to create a data module.
$generator = $this->getDataGenerator()->get_plugin_generator('mod_data');
// Create a data module.
$data = $generator->create_instance(array('course' => $course->id));
// Trigger an event for updating this record.
$event = \mod_data\event\template_updated::create(array(
'context' => context_module::instance($data->cmid),
'courseid' => $course->id,
'other' => array(
'dataid' => $data->id,
)
));
// Trigger and capture the event for updating the data record.
$sink = $this->redirectEvents();
$event->trigger();
$events = $sink->get_events();
$event = reset($events);
// Check that the event data is valid.
$this->assertInstanceOf('\mod_data\event\template_updated', $event);
$this->assertEquals(context_module::instance($data->cmid), $event->get_context());
$expected = array($course->id, 'data', 'templates saved', 'templates.php?id=' . $data->cmid . '&amp;d=' .
$data->id, $data->id, $data->cmid);
$this->assertEventLegacyLogData($expected, $event);
}
}