MDL-48142 core_badge: add badge awarded event
authorJames Ballard <jimbonda@gmail.com>
Fri, 7 Nov 2014 02:58:58 +0000 (13:58 +1100)
committerSimey Lameze <simey@moodle.com>
Tue, 17 Feb 2015 01:37:35 +0000 (09:37 +0800)
lang/en/badges.php
lib/badgeslib.php
lib/classes/event/badge_awarded.php [new file with mode: 0644]

index 21cf94e..ce03b75 100644 (file)
@@ -246,6 +246,7 @@ $string['error:requesttimeout'] = 'The connection request timed out before it co
 $string['error:requesterror'] = 'The connection request failed (error code {$a}).';
 $string['error:save'] = 'Cannot save the badge.';
 $string['error:userdeleted'] = '{$a->user} (This user no longer exists in {$a->site})';
+$string['eventbadgeawarded'] = 'Badge awarded';
 $string['evidence'] = 'Evidence';
 $string['existingrecipients'] = 'Existing badge recipients';
 $string['expired'] = 'Expired';
index 80b57ce..9e348be 100644 (file)
@@ -398,6 +398,12 @@ class badge {
         $result = $DB->insert_record('badge_issued', $issued, true);
 
         if ($result) {
+            // Trigger badge awarded event.
+            $context = context_system::instance();
+            $event = \core\event\badge_awarded::create(array('context' => $context, 'objectid' => $result,
+                'courseid' => $this->courseid ? $this->courseid : 0, 'relateduserid' => $userid));
+            $event->trigger();
+
             // Lock the badge, so that its criteria could not be changed any more.
             if ($this->status == BADGE_STATUS_ACTIVE) {
                 $this->set_status(BADGE_STATUS_ACTIVE_LOCKED);
diff --git a/lib/classes/event/badge_awarded.php b/lib/classes/event/badge_awarded.php
new file mode 100644 (file)
index 0000000..271d6f1
--- /dev/null
@@ -0,0 +1,72 @@
+<?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/>.
+
+/**
+ * Badge awarded event.
+ *
+ * @package    core
+ * @copyright  2014 James Ballard
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\event;
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Event triggered after a badge is awarded to a user.
+ *
+ * @package    core
+ * @since      Moodle 2.7
+ * @copyright  2014 James Ballard
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class badge_awarded extends base {
+
+    /**
+     * Set basic properties for the event.
+     */
+    protected function init() {
+        $this->data['objecttable'] = 'badge_issued';
+        $this->data['crud'] = 'c';
+        $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
+    }
+
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventbadgeawarded', 'badges');
+    }
+
+    /**
+     * Returns non-localised event description with id's for admin use only.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "The user with id '$this->userid' was awarded the badge with id '$this->objectid'.";
+    }
+
+    /**
+     * Returns relevant URL.
+     * @return \moodle_url
+     */
+    public function get_url() {
+        return null;
+    }
+}