MDL-55239 Badges: Additional events for badges
[moodle.git] / lib / classes / event / badge_viewed.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Badge viewed event.
19  *
20  * @package    core
21  * @copyright  2016 Stephen Bourget
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core\event;
26 defined('MOODLE_INTERNAL') || die();
28 /**
29  * Event triggered after a badge is viewed.
30  *
31  * @property-read array $other {
32  *      Extra information about the event.
33  *
34  *      - int badgeid: the ID of the badge.
35  *      - int badgehash: The UID of the awarded badge.
36  * }
37  *
38  * @package    core
39  * @since      Moodle 3.2
40  * @copyright  2016 Stephen Bourget
41  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42  */
43 class badge_viewed extends base {
45     /**
46      * Set basic properties for the event.
47      */
48     protected function init() {
49         $this->data['crud'] = 'r';
50         $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
51     }
53     /**
54      * Returns localised general event name.
55      *
56      * @return string
57      */
58     public static function get_name() {
59         return get_string('eventbadgeviewed', 'badges');
60     }
62     /**
63      * Returns non-localised event description with id's for admin use only.
64      *
65      * @return string
66      */
67     public function get_description() {
68         return "The user with id '$this->userid' has viewed the badge with the id '".$this->other['badgeid']."'.";
69     }
71     /**
72      * Returns relevant URL.
73      * @return \moodle_url
74      */
75     public function get_url() {
76         return new \moodle_url('/badges/badge.php', array('hash' => $this->other['badgehash']));
77     }
79     /**
80      * Custom validations.
81      *
82      * @throws \coding_exception
83      * @return void
84      */
85     protected function validate_data() {
86         parent::validate_data();
88         if (!isset($this->other['badgeid'])) {
89             throw new \coding_exception('The \'badgeid\' must be set in other.');
90         }
91         if (!isset($this->other['badgehash'])) {
92             throw new \coding_exception('The \'badgehash\' must be set in other.');
93         }
94     }
96     /**
97      * Used for maping events on restore
98      *
99      * @return bool
100      */
101     public static function get_other_mapping() {
102         $othermapped = array();
103         $othermapped['badgeid'] = array('db' => 'badge', 'restore' => 'badge');
104         return $othermapped;
105     }