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