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 submission unlocked 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 submission unlocked 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 submission_unlocked 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 $user
51
     * @return submission_unlocked
52
     */
53
    public static function create_from_user(\assign $assign, \stdClass $user) {
54
        $data = array(
55
            'context' => $assign->get_context(),
56
            'objectid' => $assign->get_instance()->id,
57
            'relateduserid' => $user->id,
58
        );
59
        self::$preventcreatecall = false;
60
        /** @var submission_unlocked $event */
61
        $event = self::create($data);
62
        self::$preventcreatecall = true;
63
        $event->set_assign($assign);
64
        $event->add_record_snapshot('user', $user);
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' unlocked the submission for the user with id '$this->relateduserid' " .
75
            "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('eventsubmissionunlocked', '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';
96
    }
97
 
98
    /**
99
     * Custom validation.
100
     *
101
     * @throws \coding_exception
102
     */
103
    protected function validate_data() {
104
        if (self::$preventcreatecall) {
105
            throw new \coding_exception('cannot call submission_unlocked::create() directly, use submission_unlocked::create_from_user() instead.');
106
        }
107
 
108
        parent::validate_data();
109
 
110
        if (!isset($this->relateduserid)) {
111
            throw new \coding_exception('The \'relateduserid\' must be set.');
112
        }
113
    }
114
 
115
    public static function get_objectid_mapping() {
116
        return array('db' => 'assign', 'restore' => 'assign');
117
    }
118
}