[Summary view]

Differences Between: [Versions 39 and 402] [Versions 39 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_workshop submission reassessed event.
  19   *
  20   * @package    mod_workshop
  21   * @copyright  2013 Adrian Greeve
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_workshop\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_workshop submission reassessed event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about the event.
  33   *
  34   *      - int submissionid: Submission ID.
  35   *      - int workshopid: (optional) Workshop ID.
  36   *      - float grade: (optional) Assessment grade.
  37   * }
  38   *
  39   * @package    mod_workshop
  40   * @since      Moodle 2.7
  41   * @copyright  2013 Adrian Greeve
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class submission_reassessed extends \core\event\base {
  45  
  46      /**
  47       * Init method.
  48       *
  49       * @return void
  50       */
  51      protected function init() {
  52          $this->data['crud'] = 'u';
  53          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  54          $this->data['objecttable'] = 'workshop_assessments';
  55      }
  56  
  57      /**
  58       * Returns description of what happened.
  59       *
  60       * @return string
  61       */
  62      public function get_description() {
  63          return "The user with id '$this->userid' reassessed the submission with id '$this->objectid' for the user with " .
  64              "id '$this->relateduserid' in the workshop with course module id '$this->contextinstanceid'.";
  65      }
  66  
  67      /**
  68       * Return the legacy event log data.
  69       *
  70       * @return array|null
  71       */
  72      protected function get_legacy_logdata() {
  73          return array($this->courseid, 'workshop', 'update assessment', 'assessment.php?asid=' . $this->objectid,
  74              $this->other['submissionid'], $this->contextinstanceid);
  75      }
  76  
  77      /**
  78       * Return localised event name.
  79       *
  80       * @return string
  81       */
  82      public static function get_name() {
  83          return get_string('eventsubmissionreassessed', 'mod_workshop');
  84      }
  85  
  86      /**
  87       * Get URL related to the action.
  88       *
  89       * @return \moodle_url
  90       */
  91      public function get_url() {
  92          return new \moodle_url('/mod/workshop/assessment.php?', array('asid' => $this->objectid));
  93      }
  94  
  95      /**
  96       * Custom validation.
  97       *
  98       * @throws \coding_exception
  99       * @return void
 100       */
 101      protected function validate_data() {
 102          parent::validate_data();
 103  
 104          if (!isset($this->relateduserid)) {
 105              throw new \coding_exception('The \'relateduserid\' must be set.');
 106          }
 107  
 108          if (!isset($this->other['submissionid'])) {
 109              throw new \coding_exception('The \'submissionid\' value must be set in other.');
 110          }
 111      }
 112  
 113      public static function get_objectid_mapping() {
 114          return array('db' => 'workshop_assessments', 'restore' => 'workshop_assessment');
 115      }
 116  
 117      public static function get_other_mapping() {
 118          $othermapped = array();
 119          $othermapped['submissionid'] = array('db' => 'workshop_submissions', 'restore' => 'workshop_submission');
 120          $othermapped['workshopid'] = array('db' => 'workshop', 'restore' => 'workshop');
 121  
 122          return $othermapped;
 123      }
 124  }