mirror of
https://github.com/moodle/moodle.git
synced 2025-08-05 00:46:50 +02:00
a69f81f0d3
The approach is that we have a new JavaScript function M.mod_quiz.resource_toolbox.reorganise_edit_page which, after a ajax action, fixes up everything like page breaks, page and question numbers, that might now be wrong. We call that function instead of reloading the page. Also, there are a lot more Behat tests to verify this works correctly. AMOS BEGIN MOV [joinpages,mod_quiz],[removepagebreak,mod_quiz] MOV [splitpages,mod_quiz],[addpagebreak,mod_quiz] AMOS END
347 lines
11 KiB
JavaScript
347 lines
11 KiB
JavaScript
YUI.add('moodle-mod_quiz-util-slot', function (Y, NAME) {
|
|
|
|
/**
|
|
* A collection of utility classes for use with slots.
|
|
*
|
|
* @module moodle-mod_quiz-util
|
|
* @submodule moodle-mod_quiz-util-slot
|
|
*/
|
|
|
|
Y.namespace('Moodle.mod_quiz.util.slot');
|
|
|
|
/**
|
|
* A collection of utility classes for use with slots.
|
|
*
|
|
* @class Moodle.mod_quiz.util.slot
|
|
* @static
|
|
*/
|
|
Y.Moodle.mod_quiz.util.slot = {
|
|
CSS: {
|
|
SLOT : 'slot',
|
|
QUESTIONTYPEDESCRIPTION : 'qtype_description'
|
|
},
|
|
CONSTANTS: {
|
|
SLOTIDPREFIX : 'slot-',
|
|
QUESTION : M.util.get_string('question', 'moodle')
|
|
},
|
|
SELECTORS: {
|
|
SLOT: 'li.slot',
|
|
INSTANCENAME: '.instancename',
|
|
NUMBER: 'span.slotnumber',
|
|
PAGECONTENT : 'div#page-content',
|
|
PAGEBREAK : 'span.page_split_join_wrapper',
|
|
ICON : 'img.smallicon',
|
|
QUESTIONTYPEDESCRIPTION : '.qtype_description',
|
|
SECTIONUL : 'ul.section'
|
|
},
|
|
|
|
/**
|
|
* Retrieve the slot item from one of it's child Nodes.
|
|
*
|
|
* @method getSlotFromComponent
|
|
* @param slotcomponent {Node} The component Node.
|
|
* @return {Node|null} The Slot Node.
|
|
*/
|
|
getSlotFromComponent: function(slotcomponent) {
|
|
return Y.one(slotcomponent).ancestor(this.SELECTORS.SLOT, true);
|
|
},
|
|
|
|
/**
|
|
* Determines the slot ID for the provided slot.
|
|
*
|
|
* @method getId
|
|
* @param slot {Node} The slot to find an ID for.
|
|
* @return {Number|false} The ID of the slot in question or false if no ID was found.
|
|
*/
|
|
getId: function(slot) {
|
|
// We perform a simple substitution operation to get the ID.
|
|
var id = slot.get('id').replace(
|
|
this.CONSTANTS.SLOTIDPREFIX, '');
|
|
|
|
// Attempt to validate the ID.
|
|
id = parseInt(id, 10);
|
|
if (typeof id === 'number' && isFinite(id)) {
|
|
return id;
|
|
}
|
|
return false;
|
|
},
|
|
|
|
/**
|
|
* Determines the slot name for the provided slot.
|
|
*
|
|
* @method getName
|
|
* @param slot {Node} The slot to find a name for.
|
|
* @return {string|false} The name of the slot in question or false if no ID was found.
|
|
*/
|
|
getName: function(slot) {
|
|
var instance = slot.one(this.SELECTORS.INSTANCENAME);
|
|
if (instance) {
|
|
return instance.get('firstChild').get('data');
|
|
}
|
|
return null;
|
|
},
|
|
|
|
/**
|
|
* Determines the slot number for the provided slot.
|
|
*
|
|
* @method getNumber
|
|
* @param slot {Node} The slot to find the number for.
|
|
* @return {Number|false} The number of the slot in question or false if no number was found.
|
|
*/
|
|
getNumber: function(slot) {
|
|
if (!slot) {
|
|
return false;
|
|
}
|
|
// We perform a simple substitution operation to get the number.
|
|
var number = slot.one(this.SELECTORS.NUMBER).get('text').replace(
|
|
this.CONSTANTS.QUESTION, '');
|
|
// Attempt to validate the ID.
|
|
number = parseInt(number, 10);
|
|
if (typeof number === 'number' && isFinite(number)) {
|
|
return number;
|
|
}
|
|
return false;
|
|
},
|
|
|
|
/**
|
|
* Updates the slot number for the provided slot.
|
|
*
|
|
* @method setNumber
|
|
* @param slot {Node} The slot to update the number for.
|
|
* @return void
|
|
*/
|
|
setNumber: function(slot, number) {
|
|
var numbernode = slot.one(this.SELECTORS.NUMBER);
|
|
numbernode.setHTML('<span class="accesshide">' + this.CONSTANTS.QUESTION + '</span> ' + number);
|
|
},
|
|
|
|
/**
|
|
* Returns a list of all slot elements on the page.
|
|
*
|
|
* @method getSlots
|
|
* @return {node[]} An array containing slot nodes.
|
|
*/
|
|
getSlots: function() {
|
|
return Y.all(this.SELECTORS.PAGECONTENT + ' ' + this.SELECTORS.SECTIONUL + ' ' + this.SELECTORS.SLOT);
|
|
},
|
|
|
|
/**
|
|
* Returns a list of all slot elements on the page that have numbers. Excudes description questions.
|
|
*
|
|
* @method getSlots
|
|
* @return {node[]} An array containing slot nodes.
|
|
*/
|
|
getNumberedSlots: function() {
|
|
var selector = this.SELECTORS.PAGECONTENT + ' ' + this.SELECTORS.SECTIONUL;
|
|
selector += ' ' + this.SELECTORS.SLOT + ':not(' + this.SELECTORS.QUESTIONTYPEDESCRIPTION + ')';
|
|
return Y.all(selector);
|
|
},
|
|
|
|
/**
|
|
* Returns the previous slot to the given slot.
|
|
*
|
|
* @method getPrevious
|
|
* @param slot Slot node
|
|
* @return {node|false} The previous slot node or false.
|
|
*/
|
|
getPrevious: function(slot) {
|
|
return slot.previous(this.SELECTORS.SLOT);
|
|
},
|
|
|
|
/**
|
|
* Returns the previous numbered slot to the given slot.
|
|
*
|
|
* Ignores slots containing description question types.
|
|
*
|
|
* @method getPrevious
|
|
* @param slot Slot node
|
|
* @return {node|false} The previous slot node or false.
|
|
*/
|
|
getPreviousNumbered: function(slot) {
|
|
return slot.previous(this.SELECTORS.SLOT + ':not(' + this.SELECTORS.QUESTIONTYPEDESCRIPTION + ')');
|
|
},
|
|
|
|
/**
|
|
* Reset the order of the numbers given to each slot.
|
|
*
|
|
* @method reorderSlots
|
|
* @return void
|
|
*/
|
|
reorderSlots: function() {
|
|
// Get list of slot nodes.
|
|
var slots = this.getSlots();
|
|
// Loop through slots incrementing the number each time.
|
|
slots.each(function(slot) {
|
|
|
|
if (!Y.Moodle.mod_quiz.util.page.getPageFromSlot(slot)) {
|
|
// Move the next page to the front.
|
|
var nextpage = slot.next(Y.Moodle.mod_quiz.util.page.SELECTORS.PAGE);
|
|
slot.swap(nextpage);
|
|
}
|
|
|
|
var previousSlot = this.getPreviousNumbered(slot);
|
|
previousslotnumber = 0;
|
|
if (slot.hasClass(this.CSS.QUESTIONTYPEDESCRIPTION)) {
|
|
return;
|
|
}
|
|
|
|
if (previousSlot) {
|
|
previousslotnumber = this.getNumber(previousSlot);
|
|
}
|
|
|
|
// Set slot number.
|
|
this.setNumber(slot, previousslotnumber + 1);
|
|
}, this);
|
|
},
|
|
|
|
/**
|
|
* Remove a slot and related elements from the list of slots.
|
|
*
|
|
* @method remove
|
|
* @param slot Slot node
|
|
* @return void
|
|
*/
|
|
remove: function(slot) {
|
|
var page = Y.Moodle.mod_quiz.util.page.getPageFromSlot(slot);
|
|
slot.remove();
|
|
// Is the page empty.
|
|
if (!Y.Moodle.mod_quiz.util.page.isEmpty(page)) {
|
|
return;
|
|
}
|
|
// If so remove it. Including add menu and page break.
|
|
Y.Moodle.mod_quiz.util.page.remove(page);
|
|
},
|
|
|
|
/**
|
|
* Returns a list of all page break elements on the page.
|
|
*
|
|
* @method getPageBreaks
|
|
* @return {node[]} An array containing page break nodes.
|
|
*/
|
|
getPageBreaks: function() {
|
|
var selector = this.SELECTORS.PAGECONTENT + ' ' + this.SELECTORS.SECTIONUL;
|
|
selector += ' ' + this.SELECTORS.SLOT + this.SELECTORS.PAGEBREAK;
|
|
return Y.all(selector);
|
|
},
|
|
|
|
/**
|
|
* Retrieve the page break element item from the given slot.
|
|
*
|
|
* @method getPageBreak
|
|
* @param slot Slot node
|
|
* @return {Node|null} The Page Break Node.
|
|
*/
|
|
getPageBreak: function(slot) {
|
|
return Y.one(slot).one(this.SELECTORS.PAGEBREAK);
|
|
},
|
|
|
|
/**
|
|
* Add a page break and related elements to the list of slots.
|
|
*
|
|
* @method addPageBreak
|
|
* @param beforenode Int | Node | HTMLElement | String to add
|
|
* @return pagebreak PageBreak node
|
|
*/
|
|
addPageBreak: function(slot) {
|
|
var nodetext = M.mod_quiz.resource_toolbox.get('config').addpageiconhtml;
|
|
nodetext = nodetext.replace('%%SLOT%%', this.getNumber(slot));
|
|
var pagebreak = Y.Node.create(nodetext);
|
|
slot.one('div').insert(pagebreak, 'after');
|
|
return pagebreak;
|
|
},
|
|
|
|
/**
|
|
* Remove a pagebreak from the given slot.
|
|
*
|
|
* @method removePageBreak
|
|
* @param slot Slot node
|
|
* @return boolean
|
|
*/
|
|
removePageBreak: function(slot) {
|
|
var pagebreak = this.getPageBreak(slot);
|
|
if (!pagebreak) {
|
|
return false;
|
|
}
|
|
pagebreak.remove();
|
|
return true;
|
|
},
|
|
|
|
/**
|
|
* Reorder each pagebreak by iterating through each related slot.
|
|
*
|
|
* @method reorderPageBreaks
|
|
* @return void
|
|
*/
|
|
reorderPageBreaks: function() {
|
|
// Get list of slot nodes.
|
|
var slots = this.getSlots(), slotnumber = 0;
|
|
// Loop through slots incrementing the number each time.
|
|
slots.each (function(slot, key) {
|
|
slotnumber++;
|
|
var pagebreak = this.getPageBreak(slot);
|
|
// Last slot won't have a page break.
|
|
if (!pagebreak && key === slots.size() - 1) {
|
|
return;
|
|
}
|
|
|
|
// No pagebreak and not last slot. Add one.
|
|
if (!pagebreak && key !== slots.size() - 1) {
|
|
pagebreak = this.addPageBreak(slot);
|
|
}
|
|
|
|
// Remove last page break if there is one.
|
|
if (pagebreak && key === slots.size() - 1) {
|
|
this.removePageBreak(slot);
|
|
}
|
|
|
|
// Get page break anchor element.
|
|
var pagebreaklink = pagebreak.get('childNodes').item(0);
|
|
|
|
// Get the correct title.
|
|
var nextactivity = slot.next('li.activity');
|
|
|
|
var titlename = '', action = '', uri = M.cfg.wwwroot;
|
|
var iconsrc = uri + '/theme/image.php?theme=clean&component=core';
|
|
// IE8 can't handle svg images.
|
|
if (Y.one('body.ie8')) {
|
|
iconsrc += '&svg=e%2F0';
|
|
}
|
|
if (Y.Moodle.mod_quiz.util.page.isPage(nextactivity)) {
|
|
action = titlename = 'removepagebreak';
|
|
iconsrc += '&image=e%2Fremove_page_break';
|
|
} else {
|
|
action = titlename = 'addpagebreak';
|
|
iconsrc += '&image=e%2Finsert_page_break';
|
|
}
|
|
var title = M.util.get_string(titlename, 'quiz');
|
|
|
|
// Update the link and image titles
|
|
pagebreaklink.set('title', title);
|
|
pagebreaklink.setData('action', action);
|
|
// Update the image title.
|
|
var icon = pagebreaklink.one(this.SELECTORS.ICON);
|
|
icon.set('title', title);
|
|
|
|
// Update the image src.
|
|
icon.set('src', iconsrc);
|
|
|
|
// Get anchor url parameters as an associative array.
|
|
var params = Y.QueryString.parse(pagebreaklink.get('href'));
|
|
// Update slot number.
|
|
params.slot = slotnumber;
|
|
// Create the new url.
|
|
var newurl = '';
|
|
for (var index in params) {
|
|
if (newurl.length) {
|
|
newurl += "&";
|
|
}
|
|
newurl += index + "=" + params[index];
|
|
}
|
|
// Update the anchor.
|
|
pagebreaklink.set('href', newurl);
|
|
}, this);
|
|
}
|
|
};
|
|
|
|
|
|
}, '@VERSION@', {"requires": ["node", "moodle-mod_quiz-util-base"]});
|