See Release Notes
Long Term Support Release
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 submission form viewed event. 19 * 20 * @package mod_assign 21 * @copyright 2014 Mark Nelson <markn@moodle.com> 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 form viewed event class. 31 * 32 * @property-read array $other { 33 * Extra information about event. 34 * 35 * - int assignid: the id of the assignment. 36 * } 37 * 38 * @package mod_assign 39 * @since Moodle 2.7 40 * @copyright 2014 Mark Nelson <markn@moodle.com> 41 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 42 */ 43 class submission_form_viewed extends base { 44 /** 45 * Flag for prevention of direct create() call. 46 * @var bool 47 */ 48 protected static $preventcreatecall = true; 49 50 /** 51 * Create instance of event. 52 * 53 * @param \assign $assign 54 * @param \stdClass $user 55 * @return submission_form_viewed 56 */ 57 public static function create_from_user(\assign $assign, \stdClass $user) { 58 $data = array( 59 'relateduserid' => $user->id, 60 'context' => $assign->get_context(), 61 'other' => array( 62 'assignid' => $assign->get_instance()->id, 63 ), 64 ); 65 self::$preventcreatecall = false; 66 /** @var submission_form_viewed $event */ 67 $event = self::create($data); 68 self::$preventcreatecall = true; 69 $event->set_assign($assign); 70 $event->add_record_snapshot('user', $user); 71 return $event; 72 } 73 74 /** 75 * Init method. 76 */ 77 protected function init() { 78 $this->data['crud'] = 'r'; 79 $this->data['edulevel'] = self::LEVEL_OTHER; 80 } 81 82 /** 83 * Returns localised general event name. 84 * 85 * @return string 86 */ 87 public static function get_name() { 88 return get_string('eventsubmissionformviewed', 'mod_assign'); 89 } 90 91 /** 92 * Returns description of what happened. 93 * 94 * @return string 95 */ 96 public function get_description() { 97 if ($this->userid != $this->relateduserid) { 98 return "The user with id '$this->userid' viewed the submission form for the user with id '$this->relateduserid' " . 99 "for the assignment with course module id '$this->contextinstanceid'."; 100 } 101 102 return "The user with id '$this->userid' viewed their submission for the assignment with course module id " . 103 "'$this->contextinstanceid'."; 104 } 105 106 /** 107 * Return legacy data for add_to_log(). 108 * 109 * @return array 110 */ 111 protected function get_legacy_logdata() { 112 if ($this->relateduserid == $this->userid) { 113 $title = get_string('editsubmission', 'assign'); 114 } else { 115 $user = $this->get_record_snapshot('user', $this->relateduserid); 116 $title = get_string('editsubmissionother', 'assign', fullname($user)); 117 } 118 $this->set_legacy_logdata('view submit assignment form', $title); 119 return parent::get_legacy_logdata(); 120 } 121 122 /** 123 * Custom validation. 124 * 125 * @throws \coding_exception 126 */ 127 protected function validate_data() { 128 if (self::$preventcreatecall) { 129 throw new \coding_exception('cannot call submission_form_viewed::create() directly, use submission_form_viewed::create_from_user() instead.'); 130 } 131 132 parent::validate_data(); 133 134 if (!isset($this->relateduserid)) { 135 throw new \coding_exception('The \'relateduserid\' must be set.'); 136 } 137 138 if (!isset($this->other['assignid'])) { 139 throw new \coding_exception('The \'assignid\' value must be set in other.'); 140 } 141 } 142 143 public static function get_other_mapping() { 144 $othermapped = array(); 145 $othermapped['assignid'] = array('db' => 'assign', 'restore' => 'assign'); 146 147 return $othermapped; 148 } 149 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body