[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_choice answer submitted event.
  19   *
  20   * @package    mod_choice
  21   * @copyright  2013 Adrian Greeve <adrian@moodle.com>
  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 submitted event class.
  31   *
  32   * This event is deprecated in Moodle 3.2, it can no longer be triggered, do not
  33   * write event observers for it. This event can only be initiated during
  34   * restore from previous Moodle versions and appear in the logs.
  35   *
  36   * Event observers should listen to mod_choice\event\answer_created instead that
  37   * will be triggered once for each option selected
  38   *
  39   * @property-read array $other {
  40   *      Extra information about event.
  41   *
  42   *      - int choiceid: id of choice.
  43   *      - int optionid: (optional) id of option.
  44   * }
  45   *
  46   * @deprecated since 3.2
  47   * @package    mod_choice
  48   * @since      Moodle 2.6
  49   * @copyright  2013 Adrian Greeve <adrian@moodle.com>
  50   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  51   */
  52  class answer_submitted extends \core\event\base {
  53  
  54      /**
  55       * Returns description of what happened.
  56       *
  57       * @return string
  58       */
  59      public function get_description() {
  60          return "The user with id '$this->userid' made the choice with id '$this->objectid' in the choice activity
  61              with course module id '$this->contextinstanceid'.";
  62      }
  63  
  64      /**
  65       * Return legacy data for add_to_log().
  66       *
  67       * @return array
  68       */
  69      protected function get_legacy_logdata() {
  70          $legacylogdata = array($this->courseid,
  71              'choice',
  72              'choose',
  73              'view.php?id=' . $this->contextinstanceid,
  74              $this->other['choiceid'],
  75              $this->contextinstanceid);
  76  
  77          return $legacylogdata;
  78      }
  79  
  80      /**
  81       * Return localised event name.
  82       *
  83       * @return string
  84       */
  85      public static function get_name() {
  86          return get_string('eventanswersubmitted', 'mod_choice');
  87      }
  88  
  89      /**
  90       * Get URL related to the action
  91       *
  92       * @return \moodle_url
  93       */
  94      public function get_url() {
  95          return new \moodle_url('/mod/choice/view.php', array('id' => $this->contextinstanceid));
  96      }
  97  
  98      /**
  99       * Init method.
 100       *
 101       * @return void
 102       */
 103      protected function init() {
 104          // The objecttable here is wrong. We are submitting an answer, not a choice activity.
 105          // This also makes the description misleading as it states we made a choice with id
 106          // '$this->objectid' which just refers to the 'choice' table. The trigger for
 107          // this event should be triggered after we insert to the 'choice_answers' table.
 108          $this->data['crud'] = 'c';
 109          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
 110          $this->data['objecttable'] = 'choice';
 111      }
 112  
 113      /**
 114       * Custom validation.
 115       *
 116       * @throws \coding_exception
 117       * @return void
 118       */
 119      protected function validate_data() {
 120          parent::validate_data();
 121  
 122          debugging('Event \\mod_choice\event\\answer_submitted should not be used '
 123                  . 'any more for triggering new events and can only be initiated during restore. '
 124                  . 'For new events please use \\mod_choice\\event\\answer_created', DEBUG_DEVELOPER);
 125  
 126          if (!isset($this->other['choiceid'])) {
 127              throw new \coding_exception('The \'choiceid\' value must be set in other.');
 128          }
 129      }
 130  
 131      public static function get_objectid_mapping() {
 132          return array('db' => 'choice', 'restore' => 'choice');
 133      }
 134  
 135      public static function get_other_mapping() {
 136          $othermapped = array();
 137          $othermapped['choiceid'] = array('db' => 'choice', 'restore' => 'choice');
 138  
 139          // The 'optionid' is being passed as an array, so we can't map it. The event is
 140          // triggered each time a choice is answered, where it may be possible to select
 141          // multiple choices, so the value is converted to an array, which is then passed
 142          // to the event. Ideally this event should be triggered every time we insert to the
 143          // 'choice_answers' table so this will only be an int.
 144          $othermapped['optionid'] = \core\event\base::NOT_MAPPED;
 145  
 146          return $othermapped;
 147      }
 148  
 149      public static function is_deprecated() {
 150          return true;
 151      }
 152  }