[Summary view]

Differences Between: [Versions 311 and 400] [Versions 311 and 401] [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_quiz question manually graded event.
  19   *
  20   * @package    core
  21   * @copyright  2014 Mark Nelson <markn@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace mod_quiz\event;
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_quiz question manually graded event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event.
  33   *
  34   *      - int quizid: the id of the quiz.
  35   *      - int attemptid: the id of the attempt.
  36   *      - int slot: the question number in the attempt.
  37   * }
  38   *
  39   * @package    core
  40   * @since      Moodle 2.7
  41   * @copyright  2014 Mark Nelson <markn@moodle.com>
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class question_manually_graded extends \core\event\base {
  45  
  46      /**
  47       * Init method.
  48       */
  49      protected function init() {
  50          $this->data['objecttable'] = 'question';
  51          $this->data['crud'] = 'c';
  52          $this->data['edulevel'] = self::LEVEL_TEACHING;
  53      }
  54  
  55      /**
  56       * Returns localised general event name.
  57       *
  58       * @return string
  59       */
  60      public static function get_name() {
  61          return get_string('eventquestionmanuallygraded', 'mod_quiz');
  62      }
  63  
  64      /**
  65       * Returns description of what happened.
  66       *
  67       * @return string
  68       */
  69      public function get_description() {
  70          return "The user with id '$this->userid' manually graded the question with id '$this->objectid' for the attempt " .
  71              "with id '{$this->other['attemptid']}' for the quiz with course module id '$this->contextinstanceid'.";
  72      }
  73  
  74      /**
  75       * Returns relevant URL.
  76       *
  77       * @return \moodle_url
  78       */
  79      public function get_url() {
  80          return new \moodle_url('/mod/quiz/comment.php', array('attempt' => $this->other['attemptid'],
  81              'slot' => $this->other['slot']));
  82      }
  83  
  84      /**
  85       * Return the legacy event log data.
  86       *
  87       * @return array
  88       */
  89      protected function get_legacy_logdata() {
  90          return array($this->courseid, 'quiz', 'manualgrade', 'comment.php?attempt=' . $this->other['attemptid'] .
  91              '&slot=' . $this->other['slot'], $this->other['quizid'], $this->contextinstanceid);
  92      }
  93  
  94      /**
  95       * Custom validation.
  96       *
  97       * @throws \coding_exception
  98       * @return void
  99       */
 100      protected function validate_data() {
 101          parent::validate_data();
 102  
 103          if (!isset($this->other['quizid'])) {
 104              throw new \coding_exception('The \'quizid\' value must be set in other.');
 105          }
 106  
 107          if (!isset($this->other['attemptid'])) {
 108              throw new \coding_exception('The \'attemptid\' value must be set in other.');
 109          }
 110  
 111          if (!isset($this->other['slot'])) {
 112              throw new \coding_exception('The \'slot\' value must be set in other.');
 113          }
 114      }
 115  
 116      public static function get_objectid_mapping() {
 117          return array('db' => 'question', 'restore' => 'question');
 118      }
 119  
 120      public static function get_other_mapping() {
 121          $othermapped = array();
 122          $othermapped['quizid'] = array('db' => 'quiz', 'restore' => 'quiz');
 123          $othermapped['attemptid'] = array('db' => 'quiz_attempts', 'restore' => 'quiz_attempt');
 124  
 125          return $othermapped;
 126      }
 127  }