[Summary view]

Differences Between: [Versions 311 and 402] [Versions 311 and 403]

   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   * The mod_lesson highscore added event.
  19   *
  20   * @package    mod_lesson
  21   * @deprecated since Moodle 3.0
  22   * @copyright  2013 Mark Nelson <markn@moodle.com>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  24   */
  25  
  26  namespace mod_lesson\event;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  debugging('mod_lesson\event\highscore_added has been deprecated. Since the functionality no longer resides in the lesson module.',
  31          DEBUG_DEVELOPER);
  32  /**
  33   * The mod_lesson highscore added event class.
  34   *
  35   * @property-read array $other {
  36   *      Extra information about event.
  37   *
  38   *      - int lessonid: the id of the lesson in the lesson table.
  39   *      - string nickname: the user's nickname.
  40   * }
  41   *
  42   * @package    mod_lesson
  43   * @since      Moodle 2.7
  44   * @copyright  2013 Mark Nelson <markn@moodle.com>
  45   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  46   */
  47  
  48  class highscore_added extends \core\event\base {
  49  
  50      /**
  51       * Set basic properties for the event.
  52       */
  53      protected function init() {
  54          $this->data['objecttable'] = 'lesson_high_scores';
  55          $this->data['crud'] = 'c';
  56          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  57      }
  58  
  59      /**
  60       * Returns localised general event name.
  61       *
  62       * @return string
  63       */
  64      public static function get_name() {
  65          return get_string('eventhighscoreadded', 'mod_lesson');
  66      }
  67  
  68      /**
  69       * Get URL related to the action.
  70       *
  71       * @return \moodle_url
  72       */
  73      public function get_url() {
  74          return new \moodle_url('/mod/lesson/highscores.php', array('id' => $this->contextinstanceid));
  75      }
  76  
  77      /**
  78       * Returns non-localised event description with id's for admin use only.
  79       *
  80       * @return string
  81       */
  82      public function get_description() {
  83          return "The user with id '$this->userid' added a new highscore to the lesson activity with course module " .
  84              "id '$this->contextinstanceid'.";
  85      }
  86  
  87      /**
  88       * Replace add_to_log() statement.
  89       *
  90       * @return array of parameters to be passed to legacy add_to_log() function.
  91       */
  92      protected function get_legacy_logdata() {
  93          return array($this->courseid, 'lesson', 'update highscores', 'highscores.php?id=' . $this->contextinstanceid,
  94              $this->other['nickname'], $this->contextinstanceid);
  95      }
  96  
  97      /**
  98       * Custom validations.
  99       *
 100       * @throws \coding_exception when validation fails.
 101       * @return void
 102       */
 103      protected function validate_data() {
 104          parent::validate_data();
 105  
 106          if (!isset($this->other['lessonid'])) {
 107              throw new \coding_exception('The \'lessonid\' value must be set in other.');
 108          }
 109  
 110          if (!isset($this->other['nickname'])) {
 111              throw new \coding_exception('The \'nickname\' value must be set in other.');
 112          }
 113      }
 114  
 115      public static function get_objectid_mapping() {
 116          // The 'highscore' functionality was removed from core.
 117          return false;
 118      }
 119  
 120      public static function get_other_mapping() {
 121          // The 'highscore' functionality was removed from core.
 122          return false;
 123      }
 124  }