L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-55239 Badges: Additional events for badges

Browse Source
This commit is contained in:
Stephen Bourget
2016-08-11 21:16:35 -04:00
parent 6f302b17b9
commit 2ce8cf628f
7 changed files with 308 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/classes/event/badge_listing_viewed.php
+119
View File
@@ -0,0 +1,119 @@
<?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 listing viewed event.
*
* @package core
* @copyright 2016 Stephen Bourget
* @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 viewed.
*
* @property-read array $other {
* Extra information about the event.
*
* - int badgetype: the type of badge (BADGE_TYPE_SITE or BADGE_TYPE_COURSE).
* - int courseid: The ID of the course (Not required for BADGE_TYPE_SITE).
* }
*
* @package core
* @since Moodle 3.2
* @copyright 2016 Stephen Bourget
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class badge_listing_viewed extends base {
/**
* Set basic properties for the event.
*/
protected function init() {
$this->data['crud'] = 'r';
$this->data['edulevel'] = self::LEVEL_PARTICIPATING;
}
/**
* Returns localised general event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventbadgelistingviewed', 'badges');
}
/**
* Returns non-localised event description with id's for admin use only.
*
* @return string
*/
public function get_description() {
if ($this->other['badgetype'] == BADGE_TYPE_SITE) {
$return = "The user with id '$this->userid' has viewed the list of available badges for this site.";
} else {
$return = "The user with id '$this->userid' has viewed the list of available badges".
" for the course with the id '".$this->other['courseid']."'.";
}
return $return;
}
/**
* Returns relevant URL.
* @return \moodle_url
*/
public function get_url() {
if ($this->other['badgetype'] == BADGE_TYPE_SITE) {
$params = array('type' => $this->other['badgetype']);
} else {
$params = array('id' => $this->other['courseid'], 'type' => $this->other['badgetype']);
}
return new \moodle_url('/badges/view.php', $params );
}
/**
* Custom validations.
*
* @throws \coding_exception
* @return void
*/
protected function validate_data() {
parent::validate_data();
if (!isset($this->other['badgetype'])) {
throw new \coding_exception('The \'badgetype\' must be set in other.');
}
if ($this->other['badgetype'] == BADGE_TYPE_COURSE) {
if (!isset($this->other['courseid'])) {
throw new \coding_exception('The \'courseid\' must be set in other.');
}
}
}
/**
* Used for maping events on restore
*
* @return bool
*/
public static function get_other_mapping() {
$othermapped = array();
$othermapped['courseid'] = array('db' => 'course', 'restore' => 'course');
return $othermapped;
}
}
lib/classes/event/badge_viewed.php
+106
View File
@@ -0,0 +1,106 @@
<?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 viewed event.
*
* @package core
* @copyright 2016 Stephen Bourget
* @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 viewed.
*
* @property-read array $other {
* Extra information about the event.
*
* - int badgeid: the ID of the badge.
* - int badgehash: The UID of the awarded badge.
* }
*
* @package core
* @since Moodle 3.2
* @copyright 2016 Stephen Bourget
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class badge_viewed extends base {
/**
* Set basic properties for the event.
*/
protected function init() {
$this->data['crud'] = 'r';
$this->data['edulevel'] = self::LEVEL_PARTICIPATING;
}
/**
* Returns localised general event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventbadgeviewed', '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' has viewed the badge with the id '".$this->other['badgeid']."'.";
}
/**
* Returns relevant URL.
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/badges/badge.php', array('hash' => $this->other['badgehash']));
}
/**
* Custom validations.
*
* @throws \coding_exception
* @return void
*/
protected function validate_data() {
parent::validate_data();
if (!isset($this->other['badgeid'])) {
throw new \coding_exception('The \'badgeid\' must be set in other.');
}
if (!isset($this->other['badgehash'])) {
throw new \coding_exception('The \'badgehash\' must be set in other.');
}
}
/**
* Used for maping events on restore
*
* @return bool
*/
public static function get_other_mapping() {
$othermapped = array();
$othermapped['badgeid'] = array('db' => 'badge', 'restore' => 'badge');
return $othermapped;
}
}