all_submissions_downloaded.php 3.44 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
18
 * The mod_assign all submissions downloaded event.
19
20
21
22
23
24
25
26
27
28
29
 *
 * @package    mod_assign
 * @copyright  2013 Frédéric Massart
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace mod_assign\event;

defined('MOODLE_INTERNAL') || die();

/**
30
 * The mod_assign all submissions downloaded event class.
31
32
 *
 * @package    mod_assign
33
 * @since      Moodle 2.6
34
35
36
 * @copyright  2013 Frédéric Massart
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
37
class all_submissions_downloaded extends base {
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
    /**
     * Flag for prevention of direct create() call.
     * @var bool
     */
    protected static $preventcreatecall = true;

    /**
     * Create instance of event.
     *
     * @since Moodle 2.7
     *
     * @param \assign $assign
     * @return all_submissions_downloaded
     */
    public static function create_from_assign(\assign $assign) {
        $data = array(
            'context' => $assign->get_context(),
            'objectid' => $assign->get_instance()->id
        );
        self::$preventcreatecall = false;
        /** @var submission_graded $event */
        $event = self::create($data);
        self::$preventcreatecall = true;
61
        $event->set_assign($assign);
62
63
64
        return $event;
    }

65
66
67
68
69
70
    /**
     * Returns description of what happened.
     *
     * @return string
     */
    public function get_description() {
71
        return "The user with id '$this->userid' has downloaded all the submissions for the assignment " .
72
            "with course module id '$this->contextinstanceid'.";
73
74
75
76
77
    }

    /**
     * Return localised event name.
     *
78
     * @return string
79
80
     */
    public static function get_name() {
81
        return get_string('eventallsubmissionsdownloaded', 'mod_assign');
82
83
84
85
86
87
88
89
90
    }

    /**
     * Init method.
     *
     * @return void
     */
    protected function init() {
        $this->data['crud'] = 'r';
91
        $this->data['edulevel'] = self::LEVEL_TEACHING;
92
93
        $this->data['objecttable'] = 'assign';
    }
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

    /**
     * Return legacy data for add_to_log().
     *
     * @return array
     */
    protected function get_legacy_logdata() {
        $this->set_legacy_logdata('download all submissions', get_string('downloadall', 'assign'));
        return parent::get_legacy_logdata();
    }

    /**
     * Custom validation.
     *
     * @throws \coding_exception
     * @return void
     */
    protected function validate_data() {
        if (self::$preventcreatecall) {
            throw new \coding_exception('cannot call all_submissions_downloaded::create() directly, use all_submissions_downloaded::create_from_assign() instead.');
        }

        parent::validate_data();
    }
118
119
120
121

    public static function get_objectid_mapping() {
        return array('db' => 'assign', 'restore' => 'assign');
    }
122
}