[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 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 assessable submitted 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 assessable submitted event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - bool submission_editable: is submission editable.
  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 assessable_submitted extends base {
  44      /**
  45       * Create instance of event.
  46       *
  47       * @since Moodle 2.7
  48       *
  49       * @param \assign $assign
  50       * @param \stdClass $submission
  51       * @param bool $editable
  52       * @return assessable_submitted
  53       */
  54      public static function create_from_submission(\assign $assign, \stdClass $submission, $editable) {
  55          global $USER;
  56  
  57          $data = array(
  58              'context' => $assign->get_context(),
  59              'objectid' => $submission->id,
  60              'other' => array(
  61                  'submission_editable' => $editable,
  62              ),
  63          );
  64          if (!empty($submission->userid) && ($submission->userid != $USER->id)) {
  65              $data['relateduserid'] = $submission->userid;
  66          }
  67          /** @var assessable_submitted $event */
  68          $event = self::create($data);
  69          $event->set_assign($assign);
  70          $event->add_record_snapshot('assign_submission', $submission);
  71          return $event;
  72      }
  73  
  74      /**
  75       * Returns description of what happened.
  76       *
  77       * @return string
  78       */
  79      public function get_description() {
  80          return "The user with id '$this->userid' has submitted the submission with id '$this->objectid' " .
  81              "for the assignment with course module id '$this->contextinstanceid'.";
  82      }
  83  
  84      /**
  85       * Legacy event data if get_legacy_eventname() is not empty.
  86       *
  87       * @return \stdClass
  88       */
  89      protected function get_legacy_eventdata() {
  90          $eventdata = new \stdClass();
  91          $eventdata->modulename = 'assign';
  92          $eventdata->cmid = $this->contextinstanceid;
  93          $eventdata->itemid = $this->objectid;
  94          $eventdata->courseid = $this->courseid;
  95          $eventdata->userid = $this->userid;
  96          $eventdata->params = array('submission_editable' => $this->other['submission_editable']);
  97          return $eventdata;
  98      }
  99  
 100      /**
 101       * Return the legacy event name.
 102       *
 103       * @return string
 104       */
 105      public static function get_legacy_eventname() {
 106          return 'assessable_submitted';
 107      }
 108  
 109      /**
 110       * Return localised event name.
 111       *
 112       * @return string
 113       */
 114      public static function get_name() {
 115          return get_string('eventassessablesubmitted', 'mod_assign');
 116      }
 117  
 118      /**
 119       * Init method.
 120       *
 121       * @return void
 122       */
 123      protected function init() {
 124          $this->data['objecttable'] = 'assign_submission';
 125          $this->data['crud'] = 'u';
 126          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
 127      }
 128  
 129      /**
 130       * Return legacy data for add_to_log().
 131       *
 132       * @return array
 133       */
 134      protected function get_legacy_logdata() {
 135          $submission = $this->get_record_snapshot('assign_submission', $this->objectid);
 136          $this->set_legacy_logdata('submit for grading', $this->assign->format_submission_for_log($submission));
 137          return parent::get_legacy_logdata();
 138      }
 139  
 140      /**
 141       * Custom validation.
 142       *
 143       * @throws \coding_exception
 144       * @return void
 145       */
 146      protected function validate_data() {
 147          parent::validate_data();
 148  
 149          if (!isset($this->other['submission_editable'])) {
 150              throw new \coding_exception('The \'submission_editable\' value must be set in other.');
 151          }
 152      }
 153  
 154      public static function get_objectid_mapping() {
 155          return array('db' => 'assign_submission', 'restore' => 'submission');
 156      }
 157  
 158      public static function get_other_mapping() {
 159          // Nothing to map.
 160          return false;
 161      }
 162  }