[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 highscores viewed.
  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\highscores_viewed has been deprecated. Since the functionality no longer resides in the lesson module.',
  31          DEBUG_DEVELOPER);
  32  /**
  33   * The mod_lesson highscores viewed class.
  34   *
  35   * @package    mod_lesson
  36   * @since      Moodle 2.7
  37   * @copyright  2013 Mark Nelson <markn@moodle.com>
  38   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  39   */
  40  class highscores_viewed extends \core\event\base {
  41  
  42      /**
  43       * Set basic properties for the event.
  44       */
  45      protected function init() {
  46          $this->data['objecttable'] = 'lesson';
  47          $this->data['crud'] = 'r';
  48          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  49      }
  50  
  51      /**
  52       * Returns localised general event name.
  53       *
  54       * @return string
  55       */
  56      public static function get_name() {
  57          return get_string('eventhighscoresviewed', 'mod_lesson');
  58      }
  59  
  60      /**
  61       * Get URL related to the action.
  62       *
  63       * @return \moodle_url
  64       */
  65      public function get_url() {
  66          return new \moodle_url('/mod/lesson/highscores.php', array('id' => $this->contextinstanceid));
  67      }
  68  
  69      /**
  70       * Returns non-localised event description with id's for admin use only.
  71       *
  72       * @return string
  73       */
  74      public function get_description() {
  75          return "The user with id '$this->userid' viewed the highscores for the lesson activity with course module " .
  76              "id '$this->contextinstanceid'.";
  77      }
  78  
  79      /**
  80       * Replace add_to_log() statement.
  81       *
  82       * @return array of parameters to be passed to legacy add_to_log() function.
  83       */
  84      protected function get_legacy_logdata() {
  85          $lesson = $this->get_record_snapshot('lesson', $this->objectid);
  86  
  87          return array($this->courseid, 'lesson', 'view highscores', 'highscores.php?id=' . $this->contextinstanceid,
  88              $lesson->name, $this->contextinstanceid);
  89      }
  90  
  91      public static function get_objectid_mapping() {
  92          // The 'highscore' functionality was removed from core.
  93          return false;
  94      }
  95  
  96      public static function get_other_mapping() {
  97          // The 'highscore' functionality was removed from core.
  98          return false;
  99      }
 100  }