[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 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   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - int choiceid: id of choice.
  36   *      - int optionid: (optional) id of option.
  37   * }
  38   *
  39   * @package    mod_choice
  40   * @since      Moodle 2.6
  41   * @copyright  2013 Adrian Greeve <adrian@moodle.com>
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class answer_submitted 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' made the choice with id '$this->objectid' in the choice activity
  53              with course module id '$this->contextinstanceid'.";
  54      }
  55  
  56      /**
  57       * Return legacy data for add_to_log().
  58       *
  59       * @return array
  60       */
  61      protected function get_legacy_logdata() {
  62          $legacylogdata = array($this->courseid,
  63              'choice',
  64              'choose',
  65              'view.php?id=' . $this->contextinstanceid,
  66              $this->other['choiceid'],
  67              $this->contextinstanceid);
  68  
  69          return $legacylogdata;
  70      }
  71  
  72      /**
  73       * Return localised event name.
  74       *
  75       * @return string
  76       */
  77      public static function get_name() {
  78          return get_string('eventanswercreated', 'mod_choice');
  79      }
  80  
  81      /**
  82       * Get URL related to the action
  83       *
  84       * @return \moodle_url
  85       */
  86      public function get_url() {
  87          return new \moodle_url('/mod/choice/view.php', array('id' => $this->contextinstanceid));
  88      }
  89  
  90      /**
  91       * Init method.
  92       *
  93       * @return void
  94       */
  95      protected function init() {
  96          // The objecttable here is wrong. We are submitting an answer, not a choice activity.
  97          // This also makes the description misleading as it states we made a choice with id
  98          // '$this->objectid' which just refers to the 'choice' table. The trigger for
  99          // this event should be triggered after we insert to the 'choice_answers' table.
 100          $this->data['crud'] = 'c';
 101          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
 102          $this->data['objecttable'] = 'choice';
 103      }
 104  
 105      /**
 106       * Custom validation.
 107       *
 108       * @throws \coding_exception
 109       * @return void
 110       */
 111      protected function validate_data() {
 112          parent::validate_data();
 113  
 114          if (!isset($this->other['choiceid'])) {
 115              throw new \coding_exception('The \'choiceid\' value must be set in other.');
 116          }
 117      }
 118  
 119      public static function get_objectid_mapping() {
 120          return array('db' => 'choice', 'restore' => 'choice');
 121      }
 122  
 123      public static function get_other_mapping() {
 124          $othermapped = array();
 125          $othermapped['choiceid'] = array('db' => 'choice', 'restore' => 'choice');
 126  
 127          // The 'optionid' is being passed as an array, so we can't map it. The event is
 128          // triggered each time a choice is answered, where it may be possible to select
 129          // multiple choices, so the value is converted to an array, which is then passed
 130          // to the event. Ideally this event should be triggered every time we insert to the
 131          // 'choice_answers' table so this will only be an int.
 132          $othermapped['optionid'] = \core\event\base::NOT_MAPPED;
 133  
 134          return $othermapped;
 135      }
 136  }