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 graded 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
25namespace mod_assign\event;
26
27defined('MOODLE_INTERNAL') || die();
28
29/**
30 * The mod_assign submission graded 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 */
37class submission_graded 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 $grade
51     * @return submission_graded
52     */
53    public static function create_from_grade(\assign $assign, \stdClass $grade) {
54        $data = array(
55            'context' => $assign->get_context(),
56            'objectid' => $grade->id,
57            'relateduserid' => $grade->userid
58        );
59        self::$preventcreatecall = false;
60        /** @var submission_graded $event */
61        $event = self::create($data);
62        self::$preventcreatecall = true;
63        $event->set_assign($assign);
64        $event->add_record_snapshot('assign_grades', $grade);
65        return $event;
66    }
67
68    /**
69     * Returns description of what happened.
70     *
71     * @return string
72     */
73    public function get_description() {
74        return "The user with id '$this->userid' has graded the submission '$this->objectid' for the user with " .
75            "id '$this->relateduserid' for the assignment with course module id '$this->contextinstanceid'.";
76    }
77
78    /**
79     * Return localised event name.
80     *
81     * @return string
82     */
83    public static function get_name() {
84        return get_string('eventsubmissiongraded', 'mod_assign');
85    }
86
87    /**
88     * Init method.
89     *
90     * @return void
91     */
92    protected function init() {
93        $this->data['crud'] = 'u';
94        $this->data['edulevel'] = self::LEVEL_TEACHING;
95        $this->data['objecttable'] = 'assign_grades';
96    }
97
98    /**
99     * Return legacy data for add_to_log().
100     *
101     * @return array
102     */
103    protected function get_legacy_logdata() {
104        $grade = $this->get_record_snapshot('assign_grades', $this->objectid);
105        $this->set_legacy_logdata('grade submission', $this->assign->format_grade_for_log($grade));
106        return parent::get_legacy_logdata();
107    }
108
109    /**
110     * Custom validation.
111     *
112     * @throws \coding_exception
113     * @return void
114     */
115    protected function validate_data() {
116        if (self::$preventcreatecall) {
117            throw new \coding_exception('cannot call submission_graded::create() directly, use submission_graded::create_from_grade() instead.');
118        }
119
120        parent::validate_data();
121
122        if (!isset($this->relateduserid)) {
123            throw new \coding_exception('The \'relateduserid\' must be set.');
124        }
125    }
126
127    public static function get_objectid_mapping() {
128        return array('db' => 'assign_grades', 'restore' => 'grade');
129    }
130}
131