[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_choice answer deleted event.
  19   *
  20   * @package    mod_choice
  21   * @copyright  2016 Stephen Bourget
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_choice\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The mod_choice answer updated event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - int choiceid: id of choice.
  36   *      - int optionid: id of the option.
  37   * }
  38   *
  39   * @package    mod_choice
  40   * @since      Moodle 3.1
  41   * @copyright  2016 Stephen Bourget
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class answer_deleted extends \core\event\base {
  45  
  46      /**
  47       * Returns description of what happened.
  48       *
  49       * @return string
  50       */
  51      public function get_description() {
  52          return "The user with id '$this->userid' has deleted the option with id '" . $this->other['optionid'] . "' for the
  53              user with id '$this->relateduserid' from the choice activity with course module id '$this->contextinstanceid'.";
  54      }
  55  
  56      /**
  57       * Return localised event name.
  58       *
  59       * @return string
  60       */
  61      public static function get_name() {
  62          return get_string('eventanswerdeleted', 'mod_choice');
  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/choice/view.php', array('id' => $this->contextinstanceid));
  72      }
  73  
  74      /**
  75       * Init method.
  76       *
  77       * @return void
  78       */
  79      protected function init() {
  80          $this->data['objecttable'] = 'choice_answers';
  81          $this->data['crud'] = 'd';
  82          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  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->other['choiceid'])) {
  95              throw new \coding_exception('The \'choiceid\' value must be set in other.');
  96          }
  97  
  98          if (!isset($this->other['optionid'])) {
  99              throw new \coding_exception('The \'optionid\' value must be set in other.');
 100          }
 101      }
 102  
 103      public static function get_objectid_mapping() {
 104          return array('db' => 'choice_answers', 'restore' => \core\event\base::NOT_MAPPED);
 105      }
 106  
 107      public static function get_other_mapping() {
 108          $othermapped = array();
 109          $othermapped['choiceid'] = array('db' => 'choice', 'restore' => 'choice');
 110          $othermapped['optionid'] = array('db' => 'choice_options', 'restore' => 'choice_option');
 111  
 112          return $othermapped;
 113      }
 114  }