[Summary view]

   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/>.
  16  
  17  /**
  18   * Badge created 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   */
  24  
  25  namespace core\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * Event triggered after a badge is created.
  30   *
  31   * @package    core
  32   * @since      Moodle 3.2
  33   * @copyright  2016 Stephen Bourget
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class badge_created extends base {
  37  
  38      /**
  39       * Set basic properties for the event.
  40       */
  41      protected function init() {
  42          $this->data['objecttable'] = 'badge';
  43          $this->data['crud'] = 'c';
  44          $this->data['edulevel'] = self::LEVEL_TEACHING;
  45      }
  46  
  47      /**
  48       * Returns localised general event name.
  49       *
  50       * @return string
  51       */
  52      public static function get_name() {
  53          return get_string('eventbadgecreated', 'badges');
  54      }
  55  
  56      /**
  57       * Returns non-localised event description with id's for admin use only.
  58       *
  59       * @return string
  60       */
  61      public function get_description() {
  62          return "The user with id '$this->userid' has created the badge with id '$this->objectid'.";
  63      }
  64  
  65      /**
  66       * Returns relevant URL.
  67       * @return \moodle_url
  68       */
  69      public function get_url() {
  70          return new \moodle_url('/badges/overview.php', array('id' => $this->objectid));
  71      }
  72  
  73      /**
  74       * Custom validations.
  75       *
  76       * @throws \coding_exception
  77       * @return void
  78       */
  79      protected function validate_data() {
  80          parent::validate_data();
  81  
  82          if (!isset($this->objectid)) {
  83              throw new \coding_exception('The \'objectid\' must be set.');
  84          }
  85      }
  86  
  87      /**
  88       * Used for maping events on restore
  89       * @return array
  90       */
  91      public static function get_objectid_mapping() {
  92          return array('db' => 'badge', 'restore' => 'badge');
  93      }
  94  
  95  }
  96