[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_survey response submitted event.
  19   *
  20   * @package    mod_survey
  21   * @copyright  2014 Rajesh Taneja <rajesh@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_survey\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The mod_survey response submitted event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about the event.
  34   *
  35   *      - int surveyid: ID of survey for which response was submitted.
  36   * }
  37   *
  38   * @package    mod_survey
  39   * @since      Moodle 2.7
  40   * @copyright  2014 Rajesh Taneja <rajesh@moodle.com>
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class response_submitted extends \core\event\base {
  44  
  45      /**
  46       * Set basic properties for the event.
  47       */
  48      protected function init() {
  49          $this->data['crud'] = 'c';
  50          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  51      }
  52  
  53      /**
  54       * Return localised event name.
  55       *
  56       * @return string
  57       */
  58      public static function get_name() {
  59          return get_string('eventresponsesubmitted', 'mod_survey');
  60      }
  61  
  62      /**
  63       * Returns description of what happened.
  64       *
  65       * @return string
  66       */
  67      public function get_description() {
  68          return "The user with id '$this->userid' submitted a response for the survey with course module id '$this->contextinstanceid'.";
  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/survey/view.php", array('id' => $this->contextinstanceid));
  78      }
  79  
  80      /**
  81       * Return the legacy event log data.
  82       *
  83       * @return array
  84       */
  85      protected function get_legacy_logdata() {
  86          return array($this->courseid, "survey", "submit", "view.php?id=" . $this->contextinstanceid, $this->other['surveyid'],
  87                       $this->contextinstanceid);
  88      }
  89  
  90      /**
  91       * Custom validation.
  92       *
  93       * @throws \coding_exception
  94       * @return void
  95       */
  96      protected function validate_data() {
  97          parent::validate_data();
  98          if (empty($this->other['surveyid'])) {
  99              throw new \coding_exception('The \'surveyid\' value must be set in other.');
 100          }
 101      }
 102  
 103      public static function get_other_mapping() {
 104          $othermapped = array();
 105          $othermapped['surveyid'] = array('db' => 'survey', 'restore' => 'survey');
 106  
 107          return $othermapped;
 108      }
 109  }