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_choice answer submitted event.
19
 *
20
 * @package    mod_choice
21
 * @copyright  2013 Adrian Greeve <adrian@moodle.com>
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23
 */
24
 
25
namespace mod_choice\event;
26
 
27
defined('MOODLE_INTERNAL') || die();
28
 
29
/**
30
 * The mod_choice answer submitted event class.
31
 *
32
 * This event is deprecated in Moodle 3.2, it can no longer be triggered, do not
33
 * write event observers for it. This event can only be initiated during
34
 * restore from previous Moodle versions and appear in the logs.
35
 *
36
 * Event observers should listen to mod_choice\event\answer_created instead that
37
 * will be triggered once for each option selected
38
 *
39
 * @property-read array $other {
40
 *      Extra information about event.
41
 *
42
 *      - int choiceid: id of choice.
43
 *      - int optionid: (optional) id of option.
44
 * }
45
 *
46
 * @deprecated since 3.2
47
 * @package    mod_choice
48
 * @since      Moodle 2.6
49
 * @copyright  2013 Adrian Greeve <adrian@moodle.com>
50
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
51
 */
52
class answer_submitted extends \core\event\base {
53
 
54
    /**
55
     * Returns description of what happened.
56
     *
57
     * @return string
58
     */
59
    public function get_description() {
60
        return "The user with id '$this->userid' made the choice with id '$this->objectid' in the choice activity
61
            with course module id '$this->contextinstanceid'.";
62
    }
63
 
64
    /**
65
     * Return localised event name.
66
     *
67
     * @return string
68
     */
69
    public static function get_name() {
70
        return get_string('eventanswersubmitted', 'mod_choice');
71
    }
72
 
73
    /**
74
     * Get URL related to the action
75
     *
76
     * @return \moodle_url
77
     */
78
    public function get_url() {
79
        return new \moodle_url('/mod/choice/view.php', array('id' => $this->contextinstanceid));
80
    }
81
 
82
    /**
83
     * Init method.
84
     *
85
     * @return void
86
     */
87
    protected function init() {
88
        // The objecttable here is wrong. We are submitting an answer, not a choice activity.
89
        // This also makes the description misleading as it states we made a choice with id
90
        // '$this->objectid' which just refers to the 'choice' table. The trigger for
91
        // this event should be triggered after we insert to the 'choice_answers' table.
92
        $this->data['crud'] = 'c';
93
        $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
94
        $this->data['objecttable'] = 'choice';
95
    }
96
 
97
    /**
98
     * Custom validation.
99
     *
100
     * @throws \coding_exception
101
     * @return void
102
     */
103
    protected function validate_data() {
104
        parent::validate_data();
105
 
106
        debugging('Event \\mod_choice\event\\answer_submitted should not be used '
107
                . 'any more for triggering new events and can only be initiated during restore. '
108
                . 'For new events please use \\mod_choice\\event\\answer_created', DEBUG_DEVELOPER);
109
 
110
        if (!isset($this->other['choiceid'])) {
111
            throw new \coding_exception('The \'choiceid\' value must be set in other.');
112
        }
113
    }
114
 
115
    public static function get_objectid_mapping() {
116
        return array('db' => 'choice', 'restore' => 'choice');
117
    }
118
 
119
    public static function get_other_mapping() {
120
        $othermapped = array();
121
        $othermapped['choiceid'] = array('db' => 'choice', 'restore' => 'choice');
122
 
123
        // The 'optionid' is being passed as an array, so we can't map it. The event is
124
        // triggered each time a choice is answered, where it may be possible to select
125
        // multiple choices, so the value is converted to an array, which is then passed
126
        // to the event. Ideally this event should be triggered every time we insert to the
127
        // 'choice_answers' table so this will only be an int.
128
        $othermapped['optionid'] = \core\event\base::NOT_MAPPED;
129
 
130
        return $othermapped;
131
    }
132
 
133
    public static function is_deprecated() {
134
        return true;
135
    }
136
}