Merge branch 'build4-issue#3' Fixed #3

Author: innershell

README.md

@@ -2,7 +2,7 @@
     Contributors: innershell
     Tags: triage, form, forms, custom form, form builder, survey, survey builder, questionnaire, questionnaire builder, quiz, quiz builder, exam, exam builder, test, test builder, planner, planning, screening
     Requires at least: 5.0
-    Tested up to: 5.1.1
+    Tested up to: 5.2.2
     Requires PHP: 7.2
     Stable tag: trunk
     License: GPL2 or later
@@ -70,6 +70,9 @@ None yet.
 4. The submissions dashboard to capture feedback for machine learning.
 
 # Changelog
+## 6.0 (Abort Algorithm)
+- Bug fixes.
+
 ## 5.1 (Show Answers on Questions Page)
 - Show/hide answers in the questions listing page (admin only).
 - Hyperlink from the answer to the next question to ask.

controllers/quizzes.php

@@ -130,7 +130,9 @@ static function display($quiz_id) {
 		 include(CHAINED_PATH."/views/display-quiz.html.php");
 	}
 
-	// answer a question or complete the quiz
+	/**************************************************************************
+	 * FUNCTION: Answer the question or complete the quiz.
+	 **************************************************************************/
 	static function answer_question() {
 		global $wpdb, $user_ID;
 		$_quiz = new ChainedQuizQuiz();
@@ -165,32 +167,26 @@ static function answer_question() {
 					break;
 		}
 
-
-
-/* 		if ($question->qtype == 'text') {
-			$answer = @$_POST['answers'];
-			$answer_text = @$_POST['answer_texts'];
-		} elseif ($question->qtype == 'checkbox') {
-			$answer = @$_POST['answers'];
-		} else {
-			$answer = @$_POST['answer'];
-		} */
-
 		// Check to make sure answer is provided.
 		if(empty($answer)) $answer = 0;
 		$answer = esc_sql($answer);
 
 		// Convert multiple answers into an array. Text and checkbox answers will arrive as an array.
-		/** Might be able to avoid this code if radio buttons are named as an array in the form input. */
 		if(!is_array($answer)) $answer = array($answer);
 		if (!is_array($answer_text)) $answer_text = array($answer_text);
 
 		// calculate points
 		$points = $_question->calculate_points($question, $answer);
 		echo $points."|CHAINEDQUIZ|";
+		$total_points = $points + floatval($_POST['points']); // Points for the whole algorithm.
 
 		// figure out next question
-		$next_question = $_question->next($question, $answer);
+		if ($question->abort_enabled && $total_points >= $question->points_abort_min && $total_points <= $question->points_abort_max) {
+			// Abort criteria met. Let's abort the Algorithm and finish it.
+			$next_question = null;
+		} else {
+			$next_question = $_question->next($question, $answer);
+		}
 
 		// Store the answer
 		if(!empty($_SESSION['chained_completion_id'])) {
@@ -229,9 +225,8 @@ static function answer_question() {
 			include(CHAINED_PATH."/views/display-quiz.html.php");
 		}
 		else {
-			 // add to points
-			 $points += floatval($_POST['points']);
-			 echo $_quiz->finalize($quiz, $points); // if none, submit the quiz
+			// if none, submit the quiz
+			 echo $_quiz->finalize($quiz, $total_points); 
 		}	 		
 	}
 }

models/basic.php

@@ -39,6 +39,9 @@ static function install($update = false) {
 					`qtype` VARCHAR(20) NOT NULL DEFAULT '',
 					`soap_type` VARCHAR(1) DEFAULT '',
 					`rank` INT UNSIGNED NOT NULL DEFAULT 0,
+					`abort_enabled` TINYINT UNSIGNED NOT NULL DEFAULT 0,
+					`points_abort_min` DECIMAL(8,2) NOT NULL DEFAULT '0.00',
+					`points_abort_max` DECIMAL(8,2) NOT NULL DEFAULT '0.00',
 					`autocontinue` TINYINT UNSIGNED NOT NULL DEFAULT 0,
 					`sort_order` INT UNSIGNED NOT NULL DEFAULT 0,
 					`accept_comments` TINYINT UNSIGNED NOT NULL DEFAULT 0,
@@ -129,10 +132,13 @@ static function install($update = false) {
 		}
 
 		$current_version = get_option('chained_version');
-		error_log("Current 'chained_version' = ".$current_version);
 
 		/** PERFORM VERSION-SPECIFIC UPGRADES HERE **/
-		if ($current_version < '2.2') {
+		if ($current_version == '') {
+			// If we did not perform this check, all the version checks below are valid (for some reason).
+			return;
+		}
+		elseif ($current_version < '2.2') {
 			update_option('chained_delete_data', 'no');
 		} elseif ($current_version < '4.0') {
 			update_option('chained_debug_mode', 'off');
@@ -141,11 +147,14 @@ static function install($update = false) {
 			$wpdb->query("ALTER TABLE ".CHAINED_RESULTS." ADD COLUMN objective TEXT AFTER subjective;");
 			$wpdb->query("ALTER TABLE ".CHAINED_RESULTS." ADD COLUMN assessment TEXT AFTER objective;");
 			$wpdb->query("ALTER TABLE ".CHAINED_RESULTS." ADD COLUMN plan TEXT AFTER assessment;");
+		} elseif ($current_version < '6.0') {
+			$wpdb->query("ALTER TABLE ".CHAINED_QUESTIONS." ADD COLUMN abort_enabled TINYINT NOT NULL DEFAULT 0 AFTER rank;");
+			$wpdb->query("ALTER TABLE ".CHAINED_QUESTIONS." ADD COLUMN points_abort_min DECIMAL(8,2) NOT NULL DEFAULT '0.00' AFTER abort_enabled;");
+			$wpdb->query("ALTER TABLE ".CHAINED_QUESTIONS." ADD COLUMN points_abort_max DECIMAL(8,2) NOT NULL DEFAULT '0.00' AFTER points_abort_min;");
 		}
 
 		// Set the current plugin version number.
-		update_option('chained_version', '5.1');
-		// exit;
+		update_option('chained_version', '6.0');
 	}
 
 	// main menu
@@ -176,7 +185,7 @@ static function scripts() {
 				'chained-common',
 				CHAINED_URL.'js/common.js',
 				false,
-				'5.1',
+				'6.0',
 				false
 		);
 		wp_enqueue_script("chained-common");

models/question.php

@@ -23,10 +23,12 @@ function add($vars) {
 		$sort_order++;	 
 
 		$result = $wpdb->query($wpdb->prepare("INSERT INTO ".CHAINED_QUESTIONS." SET
-			quiz_id=%d, question=%s, qtype=%s, soap_type=%s, rank=%d, title=%s, autocontinue=%d, sort_order=%d, 
-			accept_comments=%d, accept_comments_label=%s", 
-			intval($vars['quiz_id']), $vars['question'], $vars['qtype'], $vars['soap_type'], intval(@$vars['rank']), $vars['title'], 
-			intval(@$vars['autocontinue']), $sort_order, $accept_comments, $accept_comments_label));
+			quiz_id=%d, question=%s, qtype=%s, soap_type=%s, rank=%d, 
+			abort_enabled=%d, points_abort_min=%f, points_abort_max=%f, 
+			title=%s, autocontinue=%d, sort_order=%d, accept_comments=%d, accept_comments_label=%s", 
+			intval($vars['quiz_id']), $vars['question'], $vars['qtype'], $vars['soap_type'], intval(@$vars['rank']), 
+			$vars['abort_enabled'], $vars['points_abort_min'], $vars['points_abort_max'], 
+			$vars['title'], intval(@$vars['autocontinue']), $sort_order, $accept_comments, $accept_comments_label));
 
 		if($result === false) throw new Exception(__('DB Error', 'chained'));
 		return $wpdb->insert_id;	
@@ -49,9 +51,12 @@ function save($vars, $id) {
 		$accept_comments_label = sanitize_text_field($vars['accept_comments_label']);
 
 		$result = $wpdb->query($wpdb->prepare("UPDATE ".CHAINED_QUESTIONS." SET
-			question=%s, qtype=%s, soap_type=%s, title=%s, autocontinue=%d, accept_comments=%d, accept_comments_label=%s WHERE id=%d", 
-			$vars['question'], $vars['qtype'], $vars['soap_type'], $vars['title'], intval(@$vars['autocontinue']), 
-			$accept_comments, $accept_comments_label, $id));
+			question=%s, qtype=%s, soap_type=%s, title=%s, 
+			abort_enabled=%d, points_abort_min=%f, points_abort_max=%f, 
+			autocontinue=%d, accept_comments=%d, accept_comments_label=%s WHERE id=%d", 
+			$vars['question'], $vars['qtype'], $vars['soap_type'], $vars['title'], 
+			$vars['abort_enabled'], $vars['points_abort_min'], $vars['points_abort_max'], 
+			intval(@$vars['autocontinue']), $accept_comments, $accept_comments_label, $id));
 
 
 		if($result === false) throw new Exception(__('DB Error', 'chained'));
@@ -269,13 +274,7 @@ function next($question, $answer) {
 		else {
 			if(!empty($answer)) $answer_ids[] = $answer;
 		} 
-		
-		// Remove any answers that are non numeric.
-		/* SHOULD NOT BE NEEDED ANYMORE BECAUSE TEXT ANSWERS ARE NUMERIC TOO. */
-		// $answer_ids = chained_int_array($answer_ids);  /* THIS WAS A BUG BEFORE WITH CHECKBOXES */
-		// if(empty($answer_ids)) $answer_ids = array(0);
-
-		
+				
 		/** Build a questions queue to follow-up until all questions have been asked.
 		 *  1. Find follow-up questions and sort by order to be asked.
 		 *  2. Ask the first follow-up question in the list.
@@ -319,7 +318,6 @@ function next($question, $answer) {
 		// Now sort queue to figure out what's the next question and put the remaining questions into the session queue.
 		asort($goto);											// Sort the array values from smallest to largest sort_order.
 		$goto = array_flip($goto);								// [goto, sort_order] > [sort_order, goto].
-		error_log("Queue=[" . implode(",", $goto) . "]");		// Convert the array into CSV.
 		$key = array_shift($goto);								// Pop the first goto value.
 		$_SESSION['chained_goto_queue'] = array_flip($goto);	// [sort_order, goto] > [goto, sort_order].
 

models/quiz.php

@@ -160,7 +160,7 @@ function finalize($quiz, $points) {
 
 		if ($email_content_method == 'attach') {
 			// Write to file.
-			$file = plugin_dir_path( __DIR__ ) . '/output_files/'.$completion_id.'.html'; 
+			$file = plugin_dir_path( __DIR__ ) . 'output_files/'.$completion_id.'.html'; 
 			$open = fopen( $file, "a" ); // Open the file for writing (a) only.
 			$write = fputs( $open, $email_output ); 
 			fclose( $open );
@@ -396,8 +396,9 @@ function answers_table($completion_id) {
 	/**************************************************************************
 	 * FUNCTION: Builds a SOAP note using the user's answers and question config.
 	 **************************************************************************/
-	function soap_note($completion_id, $result) {
-		global $wpdb;		
+	function soap_note($completion_id, $_result) {
+		global $wpdb;
+		$result = $_result;
 		$_question = new ChainedQuizQuestion();
 		$debug_mode = get_option('chained_debug_mode');
 		$output = '';

models/result.php

@@ -74,7 +74,6 @@ function calculate($quiz, $points) {
 			if(floatval($result->points_bottom) <= $points and $points <= floatval($result->points_top)) return $result;
     	}	
 
-		error_log("result.php:calculate() - Returning NULL.");
 		return null; // in case of nothing found
 
 	}

readme upgrade to 5.1.txt readme upgrade to 6.0.txtreadme upgrade to 5.1.txt renamed to readme upgrade to 6.0.txt

@@ -1 +1 @@
-// These are the changes that need to be done when upgrading the plugin from 5.0 to 5.1.
+// These are the changes that need to be done when upgrading the plugin from 5.1 to 6.0.

readme.txt

@@ -2,7 +2,7 @@
 Contributors: innershell
 Tags: triage, form, forms, custom form, form builder, survey, survey builder, questionnaire, questionnaire builder, quiz, quiz builder, exam, exam builder, test, test builder, planner, planning, screening
 Requires at least: 5.0
-Tested up to: 5.1.1
+Tested up to: 5.2.2
 Requires PHP: 7.2
 Stable tag: trunk
 License: GPL2 or later
@@ -63,6 +63,9 @@ None yet.
 1. The submissions dashboard to capture feedback for machine learning.
 
 == Changelog ==
+= 6.0 (Abort Algorithm) =
+- Bug fixes.
+
 = 5.1 (Show Answers on Questions Page) =
 - Show/hide answers in the questions listing page (admin only).
 - Hyperlink from the answer to the next question to ask.

views/question.html.php

@@ -9,16 +9,17 @@
 		</p>
 
 		<form method="post" onsubmit="return chainedQuizValidate(this);">
-			<p><label><?php _e('Question Title', 'chained')?></label> <input type="text" name="title" size="40" value="<?php echo @$question->title?>"></p>
-			<p><label><?php _e('Question Contents', 'chained')?></label> <?php echo wp_editor(stripslashes(@$question->question), 'question', array('textarea_rows' => 3))?></p>
+			<p><label><?php _e('Question Title:', 'chained')?></label> <input type="text" name="title" size="40" value="<?php echo @$question->title?>"></p>
+			<p><label><?php _e('Question Contents:', 'chained')?></label> <?php echo wp_editor(stripslashes(@$question->question), 'question', array('textarea_rows' => 3))?></p>
 
+			<!-- SOAP NOTE TYPE -->
 			<h3><?php _e('SOAP Note Type', 'chained')?></h3>
 				<input type="radio" name="soap_type" value="n" <?php if(!empty($question->id) and $question->soap_type == 'n') echo 'checked'?>>None<br>
 				<input type="radio" name="soap_type" value="s" <?php if(!empty($question->id) and $question->soap_type == 's') echo 'checked'?>>Subjective<br>
 				<input type="radio" name="soap_type" value="o" <?php if(!empty($question->id) and $question->soap_type == 'o') echo 'checked'?>>Objective<br>				
 
+			<!-- QUESTION TYPE -->
 			<h3><?php _e('Question Type', 'chained')?></h3>
-
 			<p><label><select name="qtype" onchange="this.value == 'radio' ? jQuery('#chainedAutoContinue').show() : jQuery('#chainedAutoContinue').hide();">
 				<option value="none" <?php if(!empty($question->id) and $question->qtype == 'none') echo 'selected'?>><?php _e('None (no answer required)','chained')?></option>
 				<option value="radio" <?php if(!empty($question->id) and $question->qtype == 'radio') echo 'selected'?>><?php _e('Radio Buttons (choose one answer)','chained')?></option>
@@ -27,15 +28,29 @@
 				<option value="text" <?php if(!empty($question->id) and $question->qtype == 'text') echo 'selected'?>><?php _e('Text Box (multiple lines of text)','chained')?></option>
 				<option value="date" <?php if(!empty($question->id) and $question->qtype == 'date') echo 'selected'?>><?php _e('Date (calendar to pick date)','chained')?></option>
 			</select>
+
+			<!-- QUESTION BEHAVIOUR -->
+			<h3><?php _e('Question Behavior', 'chained')?></h3>
+			<!-- Abort -->
+			<h4><?php _e('Abort', 'chained')?></h4>
+			<p><?php _e('Stops and finishes the Algorithm if points (so far) are within the Abort Min/Max. range.', 'chained');?></p>
+			<p><input type="checkbox" name="abort_enabled" value="1" <?php if(!empty($question->abort_enabled)) echo 'checked'?>> <?php _e('Enable abort?', 'chained');?></p>
+			<p><?php _e('Abort Min. Points:', 'chained')?> <input type="text" size="4" name="points_abort_min" value="<?php echo $question->points_abort_min?>">&nbsp;&nbsp;&nbsp;
+			<?php _e('Abort Max. Points:', 'chained')?> <input type="text" size="4" name="points_abort_max" value="<?php echo $question->points_abort_max?>"></p>			
+			<!-- Autocontinue -->
+			<span id="chainedAutoContinue" style="display:<?php echo (empty($question->id) or $question->qtype == 'radio') ? 'inline' : 'none';?>">
+			<h4><?php _e('Autocontinue', 'chained')?></h4>
+			<p><?php _e('Automatically continue to the next Question when a choice is selected.', 'chained')?></p>
+			<p><input type="checkbox" name="autocontinue" value="1" <?php if(!empty($question->autocontinue)) echo 'checked'?>> <?php _e('Autocontinue?', 'chained')?></p>
+			</span>			
+			<!-- Comments -->
+			<h4><?php _e('Comments', 'chained')?></h4>
+				<p><?php _e('Displays a field to enter additional comments with the answer.', 'chained');?></p>
+				<p><input type="checkbox" name="accept_comments" value="1" <?php if(!empty($question->accept_comments)) echo 'checked'?>> <?php _e('Accept comments?	', 'chained');?></p>
+				<p><?php _e('Comment Field Label:', 'chained');?><input type="text" name="accept_comments_label" size="30" value="<?php echo empty($question->accept_comments_label) ? __('Your comments:', 'chained') : stripslashes(@$question->accept_comments_label);?>"></p>
 
-			<span id="chainedAutoContinue" style="display:<?php echo (empty($question->id) or $question->qtype == 'radio') ? 'inline' : 'none';?>"><input type="checkbox" name="autocontinue" value="1" <?php if(!empty($question->autocontinue)) echo 'checked'?>> <?php _e('Automatically continue to the next question when a choice is selected', 'chained')?></span> </p>
-			
-			<p><input type="checkbox" name="accept_comments" value="1" <?php if(!empty($question->accept_comments)) echo 'checked'?>> <?php _e('Accept comments along with the answer.', 'chained');?> &nbsp;
-			<?php _e('Label before the comments field:', 'chained');?> <input type="text" name="accept_comments_label" size="30" value="<?php echo empty($question->accept_comments_label) ? __('Your comments:', 'chained') : stripslashes(@$question->accept_comments_label);?>"></p>
-			
-			<h3><?php _e('Answers and Settings', 'chained')?></h3>
-			
-			
+			<!-- POSSIBLE ANSWERS -->
+			<h3><?php _e('Answers', 'chained')?></h3>		
 			<div id="answerRows">
 				<?php if(!empty($choices) and sizeof($choices)):
 					foreach($choices as $choice):

views/sidebar.html.php

@@ -1,13 +1,6 @@
 <div id="chained-related" class="chained-sidebox">
 	<h3><?php _e('ABOUT', 'chained')?></h3>
-	<p><?php _e('Version: 1.0 introduces the Triage Algorithm.', 'chained');?></p>
-	<p><?php _e('Version: 2.0 introduces a Submissions Dashboard.', 'chained');?></p>
-	<p><?php _e('Version: 2.1 fixed bugs.', 'chained');?></p>
-	<p><?php _e('Version: 2.2 fixed bugs.', 'chained');?></p>
-	<p><?php _e('Version: 3.0 introduces Billing Codes.', 'chained');?></p>
-	<p><?php _e('Version: 4.0 introduces Algorithm Points.', 'chained');?></p>
-	<p><?php _e('Version: 5.0 introduces Checkbox follow-up.', 'chained');?></p>
-	<p><?php _e('Version: 5.1 improves Question management.', 'chained');?></p>
+	<p><?php _e('Nothing related.', 'chained');?></p>
 </div>