[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_quiz attempt deleted event.
  19   *
  20   * @package    mod_quiz
  21   * @copyright  2014 Mark Nelson <[email protected]>
  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 attempt deleted event class.
  30   *
  31   * @package    mod_quiz
  32   * @since      Moodle 2.7
  33   * @copyright  2014 Mark Nelson <[email protected]>
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class attempt_deleted extends \core\event\base {
  37  
  38      /**
  39       * Init method.
  40       */
  41      protected function init() {
  42          $this->data['objecttable'] = 'quiz_attempts';
  43          $this->data['crud'] = 'd';
  44          $this->data['edulevel'] = self::LEVEL_TEACHING;
  45      }
  46  
  47      /**
  48       * Returns localised general event name.
  49       *
  50       * @return string
  51       */
  52      public static function get_name() {
  53          return get_string('eventattemptdeleted', 'mod_quiz');
  54      }
  55  
  56      /**
  57       * Returns description of what happened.
  58       *
  59       * @return string
  60       */
  61      public function get_description() {
  62          return "The user with id '$this->userid' deleted the attempt with id '$this->objectid' belonging to the quiz " .
  63              "with course module id '$this->contextinstanceid' for the user with id '$this->relateduserid'.";
  64      }
  65  
  66      /**
  67       * Returns relevant URL.
  68       *
  69       * @return \moodle_url
  70       */
  71      public function get_url() {
  72          return new \moodle_url('/mod/quiz/report.php', array('id' => $this->contextinstanceid));
  73      }
  74  
  75      /**
  76       * Return the legacy event log data.
  77       *
  78       * @return array
  79       */
  80      protected function get_legacy_logdata() {
  81          return array($this->courseid, 'quiz', 'delete attempt', 'report.php?id=' . $this->contextinstanceid,
  82              $this->objectid, $this->contextinstanceid);
  83      }
  84  
  85      /**
  86       * Custom validation.
  87       *
  88       * @throws \coding_exception
  89       * @return void
  90       */
  91      protected function validate_data() {
  92          parent::validate_data();
  93  
  94          if (!isset($this->relateduserid)) {
  95              throw new \coding_exception('The \'relateduserid\' must be set.');
  96          }
  97  
  98          if (!isset($this->other['quizid'])) {
  99              throw new \coding_exception('The \'quizid\' value must be set in other.');
 100          }
 101      }
 102  }