[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 criteria updated 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 criteria is updated to a badge.
  30   *
  31   *
  32   * @property-read array $other {
  33   *      Extra information about the event.
  34   *
  35   *      - int badgeid: The ID of the badge affected
  36   *
  37   * @package    core
  38   * @since      Moodle 3.2
  39   * @copyright  2016 Stephen Bourget
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class badge_criteria_updated extends base {
  43  
  44      /**
  45       * Set basic properties for the event.
  46       */
  47      protected function init() {
  48          $this->data['objecttable'] = 'badge_criteria';
  49          $this->data['crud'] = 'u';
  50          $this->data['edulevel'] = self::LEVEL_TEACHING;
  51      }
  52  
  53      /**
  54       * Returns localised general event name.
  55       *
  56       * @return string
  57       */
  58      public static function get_name() {
  59          return get_string('eventbadgecriteriaupdated', 'badges');
  60      }
  61  
  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 updated criteria to the badge with id '".$this->other['badgeid']."'.";
  69      }
  70  
  71      /**
  72       * Returns relevant URL.
  73       * @return \moodle_url
  74       */
  75      public function get_url() {
  76          return new \moodle_url('/badges/criteria.php', array('id' => $this->other['badgeid']));
  77      }
  78  
  79      /**
  80       * Custom validations.
  81       *
  82       * @throws \coding_exception
  83       * @return void
  84       */
  85      protected function validate_data() {
  86          parent::validate_data();
  87  
  88          if (!isset($this->objectid)) {
  89              throw new \coding_exception('The \'objectid\' must be set.');
  90          }
  91          if (!isset($this->other['badgeid'])) {
  92              throw new \coding_exception('The \'badgeid\' value must be set in other.');
  93          }
  94      }
  95  
  96      /**
  97       * Used for maping events on restore
  98       *
  99       * @return array
 100       */
 101      public static function get_objectid_mapping() {
 102          return array('db' => 'badge_criteria', 'restore' => 'badge_criteria');
 103      }
 104  
 105      /**
 106       * Used for maping events on restore
 107       *
 108       * @return bool
 109       */
 110      public static function get_other_mapping() {
 111          $othermapped = array();
 112          $othermapped['badgeid'] = array('db' => 'badge', 'restore' => 'badge');
 113          return $othermapped;
 114      }
 115  }