| 1 | efrain | 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 statement accepted 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 statement accepted event class.
 | 
        
           |  |  | 31 |  *
 | 
        
           |  |  | 32 |  * @package    mod_assign
 | 
        
           |  |  | 33 |  * @since      Moodle 2.6
 | 
        
           |  |  | 34 |  * @copyright  2013 Frédéric Massart
 | 
        
           |  |  | 35 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 | 
        
           |  |  | 36 |  */
 | 
        
           |  |  | 37 | class statement_accepted extends base {
 | 
        
           |  |  | 38 |     /**
 | 
        
           |  |  | 39 |      * Flag for prevention of direct create() call.
 | 
        
           |  |  | 40 |      * @var bool
 | 
        
           |  |  | 41 |      */
 | 
        
           |  |  | 42 |     protected static $preventcreatecall = true;
 | 
        
           |  |  | 43 |   | 
        
           |  |  | 44 |     /**
 | 
        
           |  |  | 45 |      * Create instance of event.
 | 
        
           |  |  | 46 |      *
 | 
        
           |  |  | 47 |      * @since Moodle 2.7
 | 
        
           |  |  | 48 |      *
 | 
        
           |  |  | 49 |      * @param \assign $assign
 | 
        
           |  |  | 50 |      * @param \stdClass $submission
 | 
        
           |  |  | 51 |      * @return statement_accepted
 | 
        
           |  |  | 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 |         );
 | 
        
           |  |  | 58 |         self::$preventcreatecall = false;
 | 
        
           |  |  | 59 |         /** @var statement_accepted $event */
 | 
        
           |  |  | 60 |         $event = self::create($data);
 | 
        
           |  |  | 61 |         self::$preventcreatecall = true;
 | 
        
           |  |  | 62 |         $event->set_assign($assign);
 | 
        
           |  |  | 63 |         $event->add_record_snapshot('assign_submission', $submission);
 | 
        
           |  |  | 64 |         return $event;
 | 
        
           |  |  | 65 |     }
 | 
        
           |  |  | 66 |   | 
        
           |  |  | 67 |     /**
 | 
        
           |  |  | 68 |      * Returns description of what happened.
 | 
        
           |  |  | 69 |      *
 | 
        
           |  |  | 70 |      * @return string
 | 
        
           |  |  | 71 |      */
 | 
        
           |  |  | 72 |     public function get_description() {
 | 
        
           |  |  | 73 |         return "The user with id '$this->userid' has accepted the statement of the submission with id '$this->objectid' " .
 | 
        
           |  |  | 74 |             "for the assignment with course module id '$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('eventstatementaccepted', 'mod_assign');
 | 
        
           |  |  | 84 |     }
 | 
        
           |  |  | 85 |   | 
        
           |  |  | 86 |     /**
 | 
        
           |  |  | 87 |      * Init method.
 | 
        
           |  |  | 88 |      *
 | 
        
           |  |  | 89 |      * @return void
 | 
        
           |  |  | 90 |      */
 | 
        
           |  |  | 91 |     protected function init() {
 | 
        
           |  |  | 92 |         $this->data['crud'] = 'r';
 | 
        
           |  |  | 93 |         $this->data['edulevel'] = self::LEVEL_OTHER;
 | 
        
           |  |  | 94 |         $this->data['objecttable'] = 'assign_submission';
 | 
        
           |  |  | 95 |     }
 | 
        
           |  |  | 96 |   | 
        
           |  |  | 97 |     /**
 | 
        
           |  |  | 98 |      * Custom validation.
 | 
        
           |  |  | 99 |      *
 | 
        
           |  |  | 100 |      * @throws \coding_exception
 | 
        
           |  |  | 101 |      * @return void
 | 
        
           |  |  | 102 |      */
 | 
        
           |  |  | 103 |     protected function validate_data() {
 | 
        
           |  |  | 104 |         if (self::$preventcreatecall) {
 | 
        
           |  |  | 105 |             throw new \coding_exception('cannot call statement_accepted::create() directly, use statement_accepted::create_from_submission() instead.');
 | 
        
           |  |  | 106 |         }
 | 
        
           |  |  | 107 |   | 
        
           |  |  | 108 |         parent::validate_data();
 | 
        
           |  |  | 109 |     }
 | 
        
           |  |  | 110 |   | 
        
           |  |  | 111 |     public static function get_objectid_mapping() {
 | 
        
           |  |  | 112 |         return array('db' => 'assign_submission', 'restore' => 'submission');
 | 
        
           |  |  | 113 |     }
 | 
        
           |  |  | 114 | }
 |