[Summary view]

Differences Between: [Versions 311 and 400] [Versions 311 and 401] [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_assign submission status updated event.
  19   *
  20   * @package    mod_assign
  21   * @copyright  2013 Frédéric Massart
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_assign\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The mod_assign submission status updated event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - string newstatus: status of submission.
  36   * }
  37   *
  38   * @package    mod_assign
  39   * @since      Moodle 2.6
  40   * @copyright  2013 Frédéric Massart
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class submission_status_updated extends base {
  44      /**
  45       * Create instance of event.
  46       *
  47       * @since Moodle 2.7
  48       *
  49       * @param \assign $assign
  50       * @param \stdClass $submission
  51       * @return submission_status_updated
  52       */
  53      public static function create_from_submission(\assign $assign, \stdClass $submission) {
  54          $data = array(
  55              'context' => $assign->get_context(),
  56              'objectid' => $submission->id,
  57              'relateduserid' => ($assign->get_instance()->teamsubmission) ? null : $submission->userid,
  58              'other' => array(
  59                  'newstatus' => $submission->status
  60              )
  61          );
  62          /** @var submission_status_updated $event */
  63          $event = self::create($data);
  64          $event->set_assign($assign);
  65          $event->add_record_snapshot('assign_submission', $submission);
  66          return $event;
  67      }
  68  
  69      /**
  70       * Returns description of what happened.
  71       *
  72       * @return string
  73       */
  74      public function get_description() {
  75          return "The user with id '$this->userid' has updated the status of the submission with id '$this->objectid' for " .
  76              "the assignment with course module id '$this->contextinstanceid' to the status '{$this->other['newstatus']}'.";
  77      }
  78  
  79      /**
  80       * Return localised event name.
  81       *
  82       * @return string
  83       */
  84      public static function get_name() {
  85          return get_string('eventsubmissionstatusupdated', 'mod_assign');
  86      }
  87  
  88      /**
  89       * Init method.
  90       *
  91       * @return void
  92       */
  93      protected function init() {
  94          $this->data['crud'] = 'u';
  95          $this->data['edulevel'] = self::LEVEL_TEACHING;
  96          $this->data['objecttable'] = 'assign_submission';
  97      }
  98  
  99      /**
 100       * Return legacy data for add_to_log().
 101       *
 102       * @return array
 103       */
 104      protected function get_legacy_logdata() {
 105          $submission = $this->get_record_snapshot('assign_submission', $this->objectid);
 106          $user = $this->get_record_snapshot('user', $submission->userid);
 107          $logmessage = get_string('reverttodraftforstudent', 'assign', array('id' => $user->id, 'fullname' => fullname($user)));
 108          $this->set_legacy_logdata('revert submission to draft', $logmessage);
 109          return parent::get_legacy_logdata();
 110      }
 111  
 112      /**
 113       * Custom validation.
 114       *
 115       * @throws \coding_exception
 116       */
 117      protected function validate_data() {
 118          parent::validate_data();
 119  
 120          if (!isset($this->other['newstatus'])) {
 121              throw new \coding_exception('The \'newstatus\' value must be set in other.');
 122          }
 123      }
 124  
 125      public static function get_objectid_mapping() {
 126          return array('db' => 'assign_submission', 'restore' => 'submission');
 127      }
 128  
 129      public static function get_other_mapping() {
 130          // Nothing to map.
 131          return false;
 132      }
 133  }