MDL-52709 tool_lp: Create C(R)UD events for competency frameworks

admin/tool/lp/classes/api.php

@@ -417,7 +417,11 @@ class api {
             $framework->set_taxonomies($record->taxonomies);
         }
 
-        $id = $framework->create();
+        $framework = $framework->create();
+
+        // Trigger a competency framework created event.
+        \tool_lp\event\competency_framework_created::create_from_framework($framework)->trigger();
+
         return $framework;
     }
 
@@ -444,7 +448,7 @@ class api {
             // Adding the suffix copy to the shortname.
             $framework->set_shortname(get_string('duplicateditemname', 'tool_lp', $framework->get_shortname()));
             $framework->set_id(0);
-            $framework->create();
+            $framework = $framework->create();
 
             // Array that match the old competencies ids with the new one to use when copying related competencies.
             $frameworkcompetency = competency::get_framework_tree($id);
@@ -483,6 +487,9 @@ class api {
             $transaction->rollback(new moodle_exception('Error while duplicating the competency framework.'));
         }
 
+        // Trigger a competency framework created event.
+        \tool_lp\event\competency_framework_created::create_from_framework($framework)->trigger();
+
         return $framework;
     }
 
@@ -497,6 +504,10 @@ class api {
     public static function delete_framework($id) {
         $framework = new competency_framework($id);
         require_capability('tool/lp:competencymanage', $framework->get_context());
+
+        // Trigger a competency framework deleted event.
+        \tool_lp\event\competency_framework_deleted::create_from_framework($framework)->trigger();
+
         return $framework->delete();
     }
 
@@ -520,6 +531,9 @@ class api {
             $framework->set_taxonomies($record->taxonomies);
         }
 
+        // Trigger a competency framework updated event.
+        \tool_lp\event\competency_framework_updated::create_from_framework($framework)->trigger();
+
         return $framework->update();
     }
 

admin/tool/lp/classes/event/competency_framework_created.php

@@ -0,0 +1,108 @@
+<?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/>.
+
+/**
+ * Competency framework created event.
+ *
+ * @package    tool_lp
+ * @copyright  2016 Serge Gauthier <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace tool_lp\event;
+
+use core\event\base;
+use tool_lp\competency_framework;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Competency framework created event class.
+ *
+ * @property-read array $other {
+ *      Extra information about event.
+ * }
+ *
+ * @package    tool_lp
+ * @since      Moodle 3.1
+ * @copyright  2016 Serge Gauthier <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class competency_framework_created extends base {
+
+    /**
+     * Convenience method to instantiate the event.
+     *
+     * @param competency_framework $framework The framework.
+     * @return self
+     */
+    public static final function create_from_framework(competency_framework $framework) {
+        if (!$framework->get_id()) {
+            throw new \coding_exception('The competency framework ID must be set.');
+        }
+        $event = static::create(array(
+            'contextid'  => $framework->get_contextid(),
+            'objectid' => $framework->get_id()
+        ));
+        return $event;
+    }
+
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventcompetencyframeworkcreated', 'tool_lp');
+    }
+
+    /**
+     * Returns non-localised description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "The user with id '$this->userid' created the competency framework with id '$this->objectid'.";
+    }
+
+    /**
+     * Returns relevant URL.
+     *
+     * @return \moodle_url
+     */
+    public function get_url() {
+        return new \moodle_url('/admin/tool/lp/editcompetencyframework.php',
+                               array('id' => $this->objectid, 'pagecontextid' => $this->contextid));
+    }
+
+    /**
+     * Initialise the event data.
+     */
+    protected function init() {
+        $this->data['objecttable'] = competency_framework::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;
+    }
+
+}

admin/tool/lp/classes/event/competency_framework_deleted.php

@@ -0,0 +1,101 @@
+<?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/>.
+
+/**
+ * Competency framework deleted event.
+ *
+ * @package    tool_lp
+ * @copyright  2016 Serge Gauthier
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace tool_lp\event;
+
+use core\event\base;
+use tool_lp\competency_framework;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Competency framework deleted event class.
+ *
+ * @property-read array $other {
+ *      Extra information about event.
+ * }
+ *
+ * @package    tool_lp
+ * @since      Moodle 3.1
+ * @copyright  2016 Serge Gauthier <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class competency_framework_deleted extends base {
+
+    /**
+     * Convenience method to instantiate the event.
+     *
+     * @param competency_framework $framework The framework.
+     * @return self
+     */
+    public static final function create_from_framework(competency_framework $framework) {
+        if (!$framework->get_id()) {
+            throw new \coding_exception('The competency framework ID must be set.');
+        }
+        $event = static::create(array(
+            'contextid'  => $framework->get_contextid(),
+            'objectid' => $framework->get_id()
+        ));
+        return $event;
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "The user with id '$this->userid' deleted the competency framework with id '$this->objectid'.";
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventcompetencyframeworkdeleted', 'tool_lp');
+    }
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init() {
+        $this->data['crud'] = 'd';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+        $this->data['objecttable'] = competency_framework::TABLE;;
+    }
+
+    /**
+     * 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;
+    }
+
+}

admin/tool/lp/classes/event/competency_framework_updated.php

@@ -0,0 +1,111 @@
+<?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/>.
+
+/**
+ * Competency framework updated event.
+ *
+ * @package    tool_lp
+ * @copyright  2016 Serge Gauthier <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace tool_lp\event;
+
+use core\event\base;
+use tool_lp\competency_framework;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Competency framework updated event class.
+ *
+ * @property-read array $other {
+ *      Extra information about event.
+ * }
+ *
+ * @package    tool_lp
+ * @since      Moodle 3.1
+ * @copyright  2016 Serge Gauthier <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class competency_framework_updated extends base {
+
+    /**
+     * Convenience method to instantiate the event.
+     *
+     * @param competency_framework $framework The framework.
+     * @return self
+     */
+    public static final function create_from_framework(competency_framework $framework) {
+        if (!$framework->get_id()) {
+            throw new \coding_exception('The competency framework ID must be set.');
+        }
+        $event = static::create(array(
+            'contextid'  => $framework->get_contextid(),
+            'objectid' => $framework->get_id()
+        ));
+        return $event;
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "The user with id '$this->userid' updated the competency framework with id '$this->objectid'.";
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventcompetencyframeworkupdated', 'tool_lp');
+    }
+
+    /**
+     * Get URL related to the action
+     *
+     * @return \moodle_url
+     */
+    public function get_url() {
+        return new \moodle_url('/admin/tool/lp/editcompetencyframework.php',
+                               array('id' => $this->objectid, 'pagecontextid' => $this->contextid));
+    }
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init() {
+        $this->data['crud'] = 'u';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+        $this->data['objecttable'] = competency_framework::TABLE;
+    }
+
+    /**
+     * 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;
+    }
+
+}

admin/tool/lp/lang/en/tool_lp.php

@@ -92,6 +92,9 @@ $string['edittemplate'] = 'Edit learning plan template';
 $string['editthisplan'] = 'Edit this learning plan';
 $string['editthisuserevidence'] = 'Edit this evidence';
 $string['edituserevidence'] = 'Edit evidence';
+$string['eventcompetencyframeworkcreated'] = 'Competency framework created.';
+$string['eventcompetencyframeworkdeleted'] = 'Competency framework deleted.';
+$string['eventcompetencyframeworkupdated'] = 'Competency framework updated.';
 $string['evidence'] = 'Evidence';
 $string['evidence_competencyrule'] = 'The rule of the competency was met.';
 $string['evidence_coursecompleted'] = 'The course \'{$a}\' was completed.';

admin/tool/lp/tests/event_test.php

@@ -0,0 +1,125 @@
+<?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/>.
+
+/**
+ * Event tests.
+ *
+ * @package    tool_lp
+ * @copyright  2016 Serge Gauthier <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+global $CFG;
+
+use tool_lp\api;
+
+/**
+ * Event tests.
+ *
+ * @package    tool_lp
+ * @copyright  2016 Serge Gauthier <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class tool_lp_event_testcase extends advanced_testcase {
+
+    /**
+     * Test the competency framework created event.
+     *
+     */
+    public function test_competency_framework_created() {
+        $this->resetAfterTest(true);
+        $this->setAdminUser();
+        $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
+
+        // Use DataGenerator to have a record framework with the right format.
+        $record = $lpg->create_framework()->to_record();
+        $record->id = 0;
+        $record->shortname = "New shortname";
+        $record->idnumber = "New idnumber";
+
+        // Trigger and capture the event.
+        $sink = $this->redirectEvents();
+        $framework = api::create_framework((object) $record);
+
+        // Get our event event.
+        $events = $sink->get_events();
+        $event = reset($events);
+
+        // Check that the event data is valid.
+        $this->assertInstanceOf('\tool_lp\event\competency_framework_created', $event);
+        $this->assertEquals($framework->get_id(), $event->objectid);
+        $this->assertEquals($framework->get_contextid(), $event->contextid);
+        $this->assertEventContextNotUsed($event);
+        $this->assertDebuggingNotCalled();
+    }
+
+    /**
+     * Test the competency framework deleted event.
+     *
+     */
+    public function test_competency_framework_deleted() {
+        $this->resetAfterTest(true);
+        $this->setAdminUser();
+        $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
+
+        $framework = $lpg->create_framework();
+
+        // Trigger and capture the event.
+        $sink = $this->redirectEvents();
+        api::delete_framework($framework->get_id());
+
+        // Get our event event.
+        $events = $sink->get_events();
+        $event = reset($events);
+
+        // Check that the event data is valid.
+        $this->assertInstanceOf('\tool_lp\event\competency_framework_deleted', $event);
+        $this->assertEquals($framework->get_id(), $event->objectid);
+        $this->assertEquals($framework->get_contextid(), $event->contextid);
+        $this->assertEventContextNotUsed($event);
+        $this->assertDebuggingNotCalled();
+    }
+
+    /**
+     * Test the competency framework updated event.
+     *
+     */
+    public function test_competency_framework_updated() {
+        $this->resetAfterTest(true);
+        $this->setAdminUser();
+        $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
+
+        $framework = $lpg->create_framework();
+
+        // Trigger and capture the event.
+        $sink = $this->redirectEvents();
+        $framework->set_shortname('Shortname modified');
+        api::update_framework($framework->to_record());
+
+        // Get our event event.
+        $events = $sink->get_events();
+        $event = reset($events);
+
+        // Check that the event data is valid.
+        $this->assertInstanceOf('\tool_lp\event\competency_framework_updated', $event);
+        $this->assertEquals($framework->get_id(), $event->objectid);
+        $this->assertEquals($framework->get_contextid(), $event->contextid);
+        $this->assertEventContextNotUsed($event);
+        $this->assertDebuggingNotCalled();
+    }
+
+}

admin/tool/lp/version.php

@@ -25,6 +25,6 @@
 defined('MOODLE_INTERNAL') || die();
 
 
-$plugin->version   = 2015111041; // The current plugin version (Date: YYYYMMDDXX).
+$plugin->version   = 2015111043; // The current plugin version (Date: YYYYMMDDXX).
 $plugin->requires  = 2014110400; // Requires this Moodle version.
 $plugin->component = 'tool_lp'; // Full name of the plugin (used for diagnostics).