MDL-53700 competency: Migrating events to core

Leaving comments behind for now as it's a tricky one.

lib/classes/event/competency_template_created.php

@@ -0,0 +1,109 @@
+<?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/>.
+
+/**
+ * Template created event.
+ *
+ * @package    core_competency
+ * @copyright  2016 Serge Gauthier <serge.gauthier.2@umontreal.ca>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace core\event;
+
+use core\event\base;
+use core_competency\template;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Template created event class.
+ *
+ * @property-read array $other {
+ *      Extra information about event.
+ * }
+ *
+ * @package    core_competency
+ * @since      Moodle 3.1
+ * @copyright  2016 Serge Gauthier <serge.gauthier.2@umontreal.ca>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class competency_template_created extends base {
+
+    /**
+     * Convenience method to instantiate the event.
+     *
+     * @param template $template The template.
+     * @return self
+     */
+    public static final function create_from_template(template $template) {
+        if (!$template->get_id()) {
+            throw new \coding_exception('The template ID must be set.');
+        }
+        $event = static::create(array(
+            'contextid'  => $template->get_contextid(),
+            'objectid' => $template->get_id()
+        ));
+        $event->add_record_snapshot(template::TABLE, $template->to_record());
+        return $event;
+    }
+
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventtemplatecreated', 'tool_lp');
+    }
+
+    /**
+     * Returns non-localised description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "The user with id '$this->userid' created the template with id '$this->objectid'.";
+    }
+
+    /**
+     * Returns relevant URL.
+     *
+     * @return \moodle_url
+     */
+    public function get_url() {
+        return new \moodle_url('/admin/tool/lp/edittemplate.php',
+                               array('id' => $this->objectid, 'pagecontextid' => $this->contextid));
+    }
+
+    /**
+     * Initialise the event data.
+     */
+    protected function init() {
+        $this->data['objecttable'] = template::TABLE;
+        $this->data['crud'] = 'c';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Get_objectid_mapping method.
+     *
+     * @return string the name of the restore mapping the objectid links to
+     */
+    public static function get_objectid_mapping() {
+        return base::NOT_MAPPED;
+    }
+
+}