Proyectos de Subversion Moodle

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
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 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
     * Return localised event name.
86
     *
87
     * @return string
88
     */
89
    public static function get_name() {
90
        return get_string('eventassessablesubmitted', 'mod_assign');
91
    }
92
 
93
    /**
94
     * Init method.
95
     *
96
     * @return void
97
     */
98
    protected function init() {
99
        $this->data['objecttable'] = 'assign_submission';
100
        $this->data['crud'] = 'u';
101
        $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
102
    }
103
 
104
    /**
105
     * Custom validation.
106
     *
107
     * @throws \coding_exception
108
     * @return void
109
     */
110
    protected function validate_data() {
111
        parent::validate_data();
112
 
113
        if (!isset($this->other['submission_editable'])) {
114
            throw new \coding_exception('The \'submission_editable\' value must be set in other.');
115
        }
116
    }
117
 
118
    public static function get_objectid_mapping() {
119
        return array('db' => 'assign_submission', 'restore' => 'submission');
120
    }
121
 
122
    public static function get_other_mapping() {
123
        // Nothing to map.
124
        return false;
125
    }
126
}