[Summary view]

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 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_scorm attempt deleted event.
  19   *
  20   * @package    mod_scorm
  21   * @copyright  2013 onwards Ankit Agarwal
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_scorm\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_scorm attempt deleted event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event properties.
  33   *
  34   *      - int attemptid: Attempt id.
  35   * }
  36   *
  37   * @package    mod_scorm
  38   * @since      Moodle 2.7
  39   * @copyright  2013 onwards Ankit Agarwal
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class attempt_deleted extends \core\event\base {
  43  
  44      /**
  45       * Init method.
  46       */
  47      protected function init() {
  48          $this->data['crud'] = 'd';
  49          $this->data['edulevel'] = self::LEVEL_TEACHING;
  50      }
  51  
  52      /**
  53       * Returns non-localised description of what happened.
  54       *
  55       * @return string
  56       */
  57      public function get_description() {
  58          return "The user with id '$this->userid' deleted the attempt with id '{$this->other['attemptid']}' " .
  59              "for the scorm activity with course module id '$this->contextinstanceid'.";
  60      }
  61  
  62      /**
  63       * Returns localised general event name.
  64       *
  65       * @return string
  66       */
  67      public static function get_name() {
  68          return get_string('eventattemptdeleted', 'mod_scorm');
  69      }
  70  
  71      /**
  72       * Get URL related to the action
  73       *
  74       * @return \moodle_url
  75       */
  76      public function get_url() {
  77          return new \moodle_url('/mod/scorm/report.php', array('id' => $this->contextinstanceid));
  78      }
  79  
  80      /**
  81       * Custom validation.
  82       *
  83       * @throws \coding_exception
  84       * @return void
  85       */
  86      protected function validate_data() {
  87          parent::validate_data();
  88  
  89          if (empty($this->other['attemptid'])) {
  90              throw new \coding_exception('The \'attemptid\' must be set in other.');
  91          }
  92      }
  93  
  94      public static function get_other_mapping() {
  95          // Nothing to map.
  96          return false;
  97      }
  98  }