MDL-70959 completion: Documentation improvements
[moodle.git] / question / flags.js
blobaa8dac16cc5c90914287ab2900576f20fab3b389
1 // This file is part of Moodle - http://moodle.org/
2 //
3 // Moodle is free software: you can redistribute it and/or modify
4 // it under the terms of the GNU General Public License as published by
5 // the Free Software Foundation, either version 3 of the License, or
6 // (at your option) any later version.
7 //
8 // Moodle is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 // GNU General Public License for more details.
13 // You should have received a copy of the GNU General Public License
14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 /**
17  * JavaScript library for dealing with the question flags.
18  *
19  * This script, and the YUI libraries that it needs, are inluded by
20  * the $PAGE->requires->js calls in question_get_html_head_contributions in lib/questionlib.php.
21  *
22  * @package    moodlecore
23  * @subpackage questionengine
24  * @copyright  2010 The Open University
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 M.core_question_flags = {
29     flagattributes: null,
30     actionurl: null,
31     flagtext: null,
32     listeners: [],
34     init: function(Y, actionurl, flagattributes, flagtext) {
35         M.core_question_flags.flagattributes = flagattributes;
36         M.core_question_flags.actionurl = actionurl;
37         M.core_question_flags.flagtext = flagtext;
39         Y.all('div.questionflag').each(function(flagdiv, i) {
40             var checkbox = flagdiv.one('input[type=checkbox]');
41             if (!checkbox) {
42                 return;
43             }
45             var input = Y.Node.create('<input type="hidden" class="questionflagvalue" />');
46             input.set('id', checkbox.get('id'));
47             input.set('name', checkbox.get('name'));
48             input.set('value', checkbox.get('checked') ? 1 : 0);
50             // Create an image input to replace the img tag.
51             var image = Y.Node.create('<input type="image" class="questionflagimage" />');
52             var flagtext = Y.Node.create('<span class="questionflagtext">.</span>');
53             M.core_question_flags.update_flag(input, image, flagtext);
55             checkbox.remove();
56             flagdiv.one('label').remove();
57             flagdiv.append(input);
58             flagdiv.append(image);
59             flagdiv.append(flagtext);
60         });
62         Y.delegate('click', function(e) {
63             var input = this.one('input.questionflagvalue');
64             input.set('value', 1 - input.get('value'));
65             M.core_question_flags.update_flag(input, this.one('input.questionflagimage'),
66                     this.one('span.questionflagtext'));
67             var postdata = this.one('input.questionflagpostdata').get('value') +
68                     input.get('value');
70             e.halt();
71             Y.io(M.core_question_flags.actionurl , {method: 'POST', 'data': postdata});
72             M.core_question_flags.fire_listeners(postdata);
73         }, document.body, 'div.questionflag');
74     },
76     update_flag: function(input, image, flagtext) {
77         var value = input.get('value');
78         image.setAttrs(M.core_question_flags.flagattributes[value]);
79         flagtext.replaceChild(flagtext.create(M.core_question_flags.flagtext[value]),
80                 flagtext.get('firstChild'));
81         flagtext.set('title', M.core_question_flags.flagattributes[value].title);
82     },
84     add_listener: function(listener) {
85         M.core_question_flags.listeners.push(listener);
86     },
88     fire_listeners: function(postdata) {
89         for (var i = 0; i < M.core_question_flags.listeners.length; i++) {
90             M.core_question_flags.listeners[i](
91                 postdata.match(/\bqubaid=(\d+)\b/)[1],
92                 postdata.match(/\bslot=(\d+)\b/)[1],
93                 postdata.match(/\bnewstate=(\d+)\b/)[1]
94             );
95         }
96     }