[Summary view]

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