EDUCATIC
/
h5p-question-set
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Refactor initialization. Relates to: #HFP-200

ramdomize
Tom Arild Jakobsen 2016-11-11 12:58:21 +01:00
parent 7fa05df98b
commit 8e2935dd67
1 changed files with 206 additions and 213 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

213
js/questionset.js
View File

@ -135,6 +135,7 @@ H5P.QuestionSet = function (options, contentId, contentData) {
var up; var up;
var renderSolutions = false; var renderSolutions = false;
var showingSolutions = false; var showingSolutions = false;
var $template;
contentData = contentData || {}; contentData = contentData || {};
// Bring question set up to date when resuming // Bring question set up to date when resuming
@ -145,17 +146,22 @@ H5P.QuestionSet = function (options, contentId, contentData) {
questionOrder = contentData.previousState.order; questionOrder = contentData.previousState.order;
} }
// Create a pool of questions if necessary // Create a pool of questions if necessary
/** /**
* Randomizes questions in an array and updates an array containing their order * Randomizes questions in an array and updates an array containing their order
* @param {array} questions * @param {array} questions
* @param {array} questionOrder * @param {array} questionOrder
*
* @return {Object.<array, array>} questionOrdering * @return {Object.<array, array>} questionOrdering
*/ */
var randomizeQuestionOrdering = function (questions, questionOrder) { var randomizeQuestionOrdering = function (questions, questionOrder) {
// Save the original order of the questions in a multidimensional array [[question0,0],[question1,1]... // Save the original order of the questions in a multidimensional array [[question0,0],[question1,1]...
var questionOrdering = questions.map(function(questionInstance, index) { return [questionInstance, index] }); var questionOrdering = questions.map(function (questionInstance, index) {
return [questionInstance, index]
});
// Shuffle the multidimensional array // Shuffle the multidimensional array
questionOrdering = H5P.shuffleArray(questionOrdering); questionOrdering = H5P.shuffleArray(questionOrdering);
@ -184,94 +190,95 @@ H5P.QuestionSet = function (options, contentId, contentData) {
questions: questions, questions: questions,
questionOrder: newOrder questionOrder: newOrder
}; };
};
var cloneQuestionAndIndex = function (question, index) {
var result = H5P.cloneObject(question, true);
result.initialIndex = index;
return result;
};
var limitArrayToPoolSize = function(array, poolSize){
return array.slice(0, poolSize);
};
var initQuestions = function(questions, poolSize){
var result = questions.map(cloneQuestionAndIndex);
result = H5P.shuffleArray(questions);
result = limitArrayToPoolSize(result, poolSize);
return result;
};
var useQuestionPool = function(questions, poolSize){
return poolSize && poolSize < questions.length || poolSize > 0;
};
var createQuestionContainerDom = function(params, questions){
var clonedParams = H5P.cloneObject(params, true);
clonedParams.questions = questions;
return $(template.render(clonedParams));
};
var overrideBehaviourAndSettings = function(override, $template, instance) {
return function(question) {
if (override.showSolutionButton) {
question.params.behaviour.enableSolutionsButton = (override.showSolutionButton === 'on');
} }
// Create a pool (a subset) of questions if necessary if (override.retryButton) {
if (params.poolSize && params.poolSize < params.questions.length) { question.params.behaviour.enableRetry = (override.retryButton === 'on');
// If a previous pool exists, recreate it
if(contentData.previousState && contentData.previousState.poolOrder) {
poolOrder = contentData.previousState.poolOrder;
// Recreate the pool from the saved data
var pool = [];
for (var i = 0; i < poolOrder.length; i++) {
pool[i] = params.questions[poolOrder[i]];
} }
// Replace original questions with just the ones in the pool
params.questions = pool;
}
else { // Otherwise create a new pool
// Randomize and get the results
var poolResult = randomizeQuestionOrdering(params.questions, poolOrder);
var poolQuestions = poolResult.questions;
poolOrder = poolResult.questionOrder;
// Discard extra questions
poolQuestions = poolQuestions.slice(0, params.poolSize);
poolOrder = poolOrder.slice(0, params.poolSize);
// Replace original questions with just the ones in the pool
params.questions = poolQuestions;
}
}
// Create the html template for the question container
var $template = $(template.render(params));
// Set overrides for questions
var override;
if (params.override.showSolutionButton || params.override.retryButton) {
override = {};
if (params.override.showSolutionButton) {
// Force "Show solution" button to be on or off for all interactions
override.enableSolutionsButton =
(params.override.showSolutionButton === 'on' ? true : false);
}
if (params.override.retryButton) {
// Force "Retry" button to be on or off for all interactions
override.enableRetry =
(params.override.retryButton === 'on' ? true : false);
}
}
// Instantiate question instances
for (var i = 0; i < params.questions.length; i++) {
var question;
// If a previous order exists, use it
if (questionOrder !== undefined) {
question = params.questions[questionOrder[i]];
}
else {
// Use a generic order when initialzing for the first time
question = params.questions[i];
}
if (override) {
// Extend subcontent with the overrided settings.
$.extend(question.params.behaviour, override);
}
question.params = question.params || {};
question.params.overrideSettings = question.params.overrideSettings || {}; question.params.overrideSettings = question.params.overrideSettings || {};
question.params.overrideSettings.$confirmationDialogParent = $template.last(); question.params.overrideSettings.$confirmationDialogParent = $template.last();
question.params.overrideSettings.instance = this; question.params.overrideSettings.instance = instance;
var hasAnswers = contentData.previousState && contentData.previousState.answers;
var questionInstance = H5P.newRunnable(question, contentId, undefined, undefined, return params;
{ }
previousState: hasAnswers ? contentData.previousState.answers[i] : undefined, };
var getAnswersPreviousState = function(contentData, questionIndex){
if(contentData.previousState && contentData.previousState.answers){
return contentData.previousState.answers[questionIndex];
}
};
var createQuestionIntance = function(params, contentData){
return function(question, questionIndex){
var previousState = getAnswersPreviousState(contentData, questionIndex);
debugger;
var instance = H5P.newRunnable(question, contentId, undefined, undefined, {
previousState: previousState,
parent: self parent: self
}); });
questionInstance.on('resize', function () {
instance.on('resize', function () {
up = true; up = true;
self.trigger('resize'); self.trigger('resize');
}); });
questionInstances.push(questionInstance);
return instance;
} }
};
var init = function (params, previousState) {
var questions = params.questions;
if(previousState && previousState.questions){
questions = previousState.questions;
}
else if(useQuestionPool(questions, params.poolSize)) {
questions = initQuestions(questions, params.poolSize);
}
else if(params.randomQuestions){
questions = H5P.shuffleArray(questions);
}
// Create the html template for the question container
$template = createQuestionContainerDom(params, questions);
questions = questions.map(overrideBehaviourAndSettings(params.override, $template, self));
questionInstances = questions.map(createQuestionIntance(params, contentData));
// Randomize questions only on instantiation // Randomize questions only on instantiation
if (params.randomQuestions && contentData.previousState === undefined) { if (params.randomQuestions && contentData.previousState === undefined) {
@ -292,6 +299,9 @@ H5P.QuestionSet = function (options, contentId, contentData) {
questionInstances[i].trigger('resize'); questionInstances[i].trigger('resize');
} }
}); });
};
init(params, contentData.previousState);
// Update button state. // Update button state.
var _updateButtons = function () { var _updateButtons = function () {
@ -478,7 +488,7 @@ H5P.QuestionSet = function (options, contentId, contentData) {
rendered = false; rendered = false;
if (params.randomQuestions) { if (params.randomQuestions) {
randomizeQuestions(); renderRandomizedQuestions();
} }
}; };
@ -492,8 +502,7 @@ H5P.QuestionSet = function (options, contentId, contentData) {
/** /**
* Randomizes question instances * Randomizes question instances
*/ */
var randomizeQuestions = function () { var renderRandomizedQuestions = function () {
var result = randomizeQuestionOrdering(questionInstances, questionOrder); var result = randomizeQuestionOrdering(questionInstances, questionOrder);
questionInstances = result.questions; questionInstances = result.questions;
questionOrder = result.questionOrder; questionOrder = result.questionOrder;
@ -505,7 +514,6 @@ H5P.QuestionSet = function (options, contentId, contentData) {
// Reattach questions and their buttons in the new order // Reattach questions and their buttons in the new order
for (var i = 0; i < questionInstances.length; i++) { for (var i = 0; i < questionInstances.length; i++) {
var question = questionInstances[i]; var question = questionInstances[i];
// Make sure styles are not being added twice // Make sure styles are not being added twice
@ -513,39 +521,25 @@ H5P.QuestionSet = function (options, contentId, contentData) {
question.attach($('.question-container:eq(' + i + ')', $myDom)); question.attach($('.question-container:eq(' + i + ')', $myDom));
// toggle buttons
var isFirst = (i === 0);
var isLast = (i === questionInstances.length - 1);
toggleButtonsForQuestion(question, isFirst, isLast);
}
};
var toggleButtonsForQuestion = function(question, isFirst, isLast){
//Show buttons if necessary //Show buttons if necessary
if(questionInstances[questionInstances.length -1] === question question[isLast ? 'showButton' : 'hideButton']('finish');
&& question.hasButton('finish')) { question[!isLast ? 'showButton' : 'hideButton']('next');
question.showButton('finish');
}
if(questionInstances[questionInstances.length -1] !== question if (isFirst || params.disableBackwardsNavigation) {
&& question.hasButton('next')) {
question.showButton('next');
}
if(questionInstances[0] !== question
&& question.hasButton('prev')
&& !params.disableBackwardsNavigation) {
question.showButton('prev');
}
// Hide relevant buttons since the order has changed
if (questionInstances[0] === question) {
question.hideButton('prev'); question.hideButton('prev');
} }
else {
if (questionInstances[questionInstances.length-1] === question) { question.showButton('prev');
question.hideButton('next');
}
if (questionInstances[questionInstances.length-1] !== question) {
question.hideButton('finish');
}
}
} }
};
var moveQuestion = function (direction) { var moveQuestion = function (direction) {
if (params.disableBackwardsNavigation && !questionInstances[currentQuestion].getAnswerGiven()) { if (params.disableBackwardsNavigation && !questionInstances[currentQuestion].getAnswerGiven()) {
@ -915,7 +909,6 @@ H5P.QuestionSet = function (options, contentId, contentData) {
}); });
// Hide all but current question // Hide all but current question
_showQuestion(currentQuestion, true); _showQuestion(currentQuestion, true);