MDL-39954 assignment_online: Replacing old-style event_trigger

2013-08-12 17:35:29 +08:00
parent cbf4b0e6f6
commit 523698dc4c
3 changed files with 131 additions and 12 deletions
@@ -201,19 +201,20 @@ class assignment_online extends assignment_base {
        $this->update_grade($submission);
        $fs = get_file_storage();
        $files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $submission->id);
+
        // Let Moodle know that an assessable content was uploaded (eg for plagiarism detection)
-        $eventdata = new stdClass();
-        $eventdata->modulename   = 'assignment';
-        $eventdata->name         = 'update_submission';
-        $eventdata->cmid         = $this->cm->id;
-        $eventdata->itemid       = $update->id;
-        $eventdata->courseid     = $this->course->id;
-        $eventdata->userid       = $USER->id;
-        $eventdata->content      = trim(format_text($update->data1, $update->data2));
-        if ($files) {
-            $eventdata->pathnamehashes = array_keys($files);
-        }
-        events_trigger('assessable_content_uploaded', $eventdata);
+        $params = array(
+            'context' => $this->context,
+            'objectid' => $submission->id,
+            'other' => array(
+                'content' => trim(format_text($update->data1, $update->data2)),
+                'pathnamehashes' => array_keys($files),
+                'triggeredfrom' => 'update_submission'
+            )
+        );
+        $event = \assignment_online\event\assessable_uploaded::create($params);
+        $event->trigger();
+
        return $submission;
    }

@@ -0,0 +1,116 @@
+<?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/>.
+
+/**
+ * assignment_online assessable uploaded event.
+ *
+ * @package    assignment_online
+ * @copyright  2013 Frédéric Massart
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace assignment_online\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * assignment_online assessable uploaded event class.
+ *
+ * @package    assignment_online
+ * @copyright  2013 Frédéric Massart
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class assessable_uploaded extends \core\event\assessable_uploaded {
+
+    /**
+     * Returns localised description of what happened.
+     *
+     * @return \lang_string
+     */
+    public function get_description() {
+        return new \lang_string('event_assessable_uploaded_desc', 'assignment_online', $this->get_data());
+    }
+
+    /**
+     * Legacy event data if get_legacy_eventname() is not empty.
+     *
+     * @return stdClass
+     */
+    protected function get_legacy_eventdata() {
+        $eventdata = new \stdClass();
+        $eventdata->modulename = 'assignment';
+        $eventdata->name = $this->other['triggeredfrom'];
+        $eventdata->cmid = $this->context->instanceid;
+        $eventdata->itemid = $this->objectid;
+        $eventdata->courseid = $this->courseid;
+        $eventdata->userid = $this->userid;
+        $eventdata->content = $this->other['content'];
+        if ($this->other['pathnamehashes']) {
+            $eventdata->pathnamehashes = $this->other['pathnamehashes'];
+        }
+        return $eventdata;
+    }
+
+    /**
+     * Return the legacy event name.
+     *
+     * @return string
+     */
+    protected function get_legacy_eventname() {
+        return 'assessable_content_uploaded';
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return \lang_string
+     */
+    public static function get_name() {
+        return new \lang_string('event_assessable_uploaded', 'assignment_online');
+    }
+
+    /**
+     * Get URL related to the action.
+     *
+     * @return \moodle_url
+     */
+    public function get_url() {
+        return new \moodle_url('/mod/assignment/view.php', array('id' => $this->context->instanceid));
+    }
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init() {
+        parent::init();
+        $this->data['objecttable'] = 'assignment_submissions';
+    }
+
+    /**
+     * Custom validation
+     *
+     * @throws coding_exception
+     * @return void
+     */
+    protected function validate_data() {
+        parent::validate_data();
+        if (!isset($this->other['triggeredfrom'])) {
+            throw new coding_exception('triggeredfrom must be set in $other');
+        }
+    }
+}
@@ -23,4 +23,6 @@
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

+$string['event_assessable_uploaded'] = 'An online text has been uploaded.';
+$string['event_assessable_uploaded_desc'] = 'User {$a->userid} has saved an online text in submission {$a->objectid}.';
 $string['pluginname'] = 'Online';