[Summary view]

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