Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Exercise: Add validation to enforce correct answer and positive score - refs BT#22404 #6130

Open
wants to merge 1 commit into
base: 1.11.x
Choose a base branch
from
Open

Exercise: Add validation to enforce correct answer and positive score - refs BT#22404 #6130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions main/exercise/multiple_answer.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,11 +184,58 @@ public function createAnswersForm($form)
$form->setConstants(['nb_answers' => $nb_answers]);
}

/**
* Validate question answers before saving.
*
* @param object $form The form object.
* @return array|bool True if valid, or an array with errors if invalid.
*/
public function validateAnswers($form)
{
$nb_answers = $form->getSubmitValue('nb_answers');
$hasCorrectAnswer = false;
$hasValidWeighting = false;
$errors = [];
$error_fields = [];

for ($i = 1; $i <= $nb_answers; $i++) {
$isCorrect = $form->getSubmitValue("correct[$i]");
$weighting = trim($form->getSubmitValue("weighting[$i]") ?? '');

if ($isCorrect) {
$hasCorrectAnswer = true;

if (is_numeric($weighting) && floatval($weighting) > 0) {
$hasValidWeighting = true;
}
}
}

if (!$hasCorrectAnswer) {
$errors[] = get_lang('AtLeastOneCorrectAnswerRequired');
$error_fields[] = "correct";
}

if ($hasCorrectAnswer && !$hasValidWeighting) {
// Only show if at least one correct answer exists but its weighting is not valid
$errors[] = get_lang('AtLeastOneCorrectAnswerMustHavePositiveWeighting');
}

return empty($errors) ? true : ['errors' => $errors, 'error_fields' => $error_fields];
}

/**
* {@inheritdoc}
*/
public function processAnswersCreation($form, $exercise)
{
$validationResult = $this->validateAnswers($form);
if ($validationResult !== true) {
Display::addFlash(Display::return_message(implode("<br>", $validationResult['errors']), 'error'));

return;
}

$questionWeighting = 0;
$objAnswer = new Answer($this->iid);
$nb_answers = $form->getSubmitValue('nb_answers');
Expand Down
85 changes: 44 additions & 41 deletions main/exercise/question_admin.inc.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,50 +51,53 @@
}

// FORM VALIDATION
if (isset($_POST['submitQuestion']) && $form->validate()) {
// Question
$objQuestion->processCreation($form, $objExercise);
$objQuestion->processAnswersCreation($form, $objExercise);
// TODO: maybe here is the better place to index this tool, including answers text
// redirect
if (in_array($objQuestion->type, [HOT_SPOT, HOT_SPOT_COMBINATION, HOT_SPOT_DELINEATION])) {
echo '<script type="text/javascript">window.location.href="admin.php?exerciseId='.$exerciseId.'&page='.$page.'&hotspotadmin='.$objQuestion->iid.'&'.api_get_cidreq(
).'"</script>';
} elseif (in_array($objQuestion->type, [MULTIPLE_ANSWER_DROPDOWN, MULTIPLE_ANSWER_DROPDOWN_COMBINATION])) {
$url = 'admin.php?'
.api_get_cidreq().'&'
.http_build_query(['exerciseId' => $exerciseId, 'page' => $page, 'mad_admin' => $objQuestion->iid]);
echo '<script type="text/javascript">window.location.href="'.$url.'"</script>';
} else {
if (isset($_GET['editQuestion'])) {
if (empty($exerciseId)) {
Display::addFlash(Display::return_message(get_lang('ItemUpdated')));
$url = 'admin.php?exerciseId='.$exerciseId.'&'.api_get_cidreq().'&editQuestion='.$objQuestion->iid;
echo '<script type="text/javascript">window.location.href="'.$url.'"</script>';
exit;
}
echo '<script type="text/javascript">window.location.href="admin.php?exerciseId='.$exerciseId.'&'.api_get_cidreq().'&page='.$page.'&message=ItemUpdated"</script>';
if (isset($_POST['submitQuestion'])) {
$validationResult = true;
if (method_exists($objQuestion, 'validateAnswers')) {
$validationResult = $objQuestion->validateAnswers($form);
}
if (is_array($validationResult) && !empty($validationResult['errors'])) {
echo Display::return_message(implode("<br>", $validationResult['errors']), 'error', false);
} elseif ($form->validate()) {
$objQuestion->processCreation($form, $objExercise);
$objQuestion->processAnswersCreation($form, $objExercise);
if (in_array($objQuestion->type, [HOT_SPOT, HOT_SPOT_COMBINATION, HOT_SPOT_DELINEATION])) {
echo '<script type="text/javascript">window.location.href="admin.php?exerciseId='.$exerciseId.'&page='.$page.'&hotspotadmin='.$objQuestion->iid.'&'.api_get_cidreq().'";</script>';
} elseif (in_array($objQuestion->type, [MULTIPLE_ANSWER_DROPDOWN, MULTIPLE_ANSWER_DROPDOWN_COMBINATION])) {
$url = 'admin.php?'.api_get_cidreq().'&'.http_build_query(['exerciseId' => $exerciseId, 'page' => $page, 'mad_admin' => $objQuestion->iid]);
echo '<script type="text/javascript">window.location.href="'.$url.'";</script>';
} else {
// New question
$page = 1;
$length = api_get_configuration_value('question_pagination_length');
if (!empty($length)) {
$page = round($objExercise->getQuestionCount() / $length);
if (isset($_GET['editQuestion'])) {
if (empty($exerciseId)) {
Display::addFlash(Display::return_message(get_lang('ItemUpdated')));
$url = 'admin.php?exerciseId='.$exerciseId.'&'.api_get_cidreq().'&editQuestion='.$objQuestion->iid;
echo '<script type="text/javascript">window.location.href="'.$url.'";</script>';
exit;
}
echo '<script type="text/javascript">window.location.href="admin.php?exerciseId='.$exerciseId.'&'.api_get_cidreq().'&page='.$page.'&message=ItemUpdated";</script>';
} else {
// New question
$page = 1;
$length = api_get_configuration_value('question_pagination_length');
if (!empty($length)) {
$page = round($objExercise->getQuestionCount() / $length);
}
echo '<script type="text/javascript">window.location.href="admin.php?exerciseId='.$exerciseId.'&'.api_get_cidreq().'&page='.$page.'&message=ItemAdded";</script>';
}
echo '<script type="text/javascript">window.location.href="admin.php?exerciseId='.$exerciseId.'&'.api_get_cidreq().'&page='.$page.'&message=ItemAdded"</script>';
}
exit();
}
} else {
if (isset($questionName)) {
echo '<h3>'.$questionName.'</h3>';
}
if (!empty($pictureName)) {
echo '<img src="../document/download.php?doc_url=%2Fimages%2F'.$pictureName.'" border="0">';
}
if (!empty($msgErr)) {
echo Display::return_message($msgErr);
}
// display the form
$form->display();
}

if (isset($questionName)) {
echo '<h3>'.$questionName.'</h3>';
}
if (!empty($pictureName)) {
echo '<img src="../document/download.php?doc_url=%2Fimages%2F'.$pictureName.'" border="0">';
}
if (!empty($msgErr)) {
echo Display::return_message($msgErr);
}

$form->display();
}
53 changes: 53 additions & 0 deletions main/exercise/unique_answer.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,11 +335,64 @@ public function setDirectOptions($i, FormValidator $form, $renderer, $select_lp_
);
}

/**
* Validate question answers before saving.
* @return bool|string True if valid, error message if invalid.
*/
public function validateAnswers($form)
{
$correct = $form->getSubmitValue('correct');
$nb_answers = $form->getSubmitValue('nb_answers');
$hasCorrectAnswer = false;
$hasPositiveScore = false;
$errors = [];
$error_fields = [];

for ($i = 1; $i <= $nb_answers; $i++) {
$answer = trim($form->getSubmitValue("answer[$i]") ?? '');
$weighting = trim($form->getSubmitValue("weighting[$i]") ?? '');
$isCorrect = ($correct == $i);
if (empty($answer)) {
$errors[] = sprintf(get_lang('QuestionCannotBeEmpty'), $i);
$error_fields[] = "answer[$i]";
}

if ($weighting === '' || !is_numeric($weighting)) {
$errors[] = sprintf(get_lang('WeightingMustBeNumeric'), $i);
$error_fields[] = "weighting[$i]";
}

if ($isCorrect) {
$hasCorrectAnswer = true;
if (floatval($weighting) > 0) {
$hasPositiveScore = true;
}
}
}

if (!$hasCorrectAnswer) {
$errors[] = get_lang('MustSelectCorrectAnswer');
$error_fields[] = "correct";
}

if (!$hasPositiveScore) {
$errors[] = get_lang('CorrectAnswerMustHavePositiveScore');
}

return empty($errors) ? true : ['errors' => $errors, 'error_fields' => $error_fields];
}

/**
* {@inheritdoc}
*/
public function processAnswersCreation($form, $exercise)
{
$validationResult = $this->validateAnswers($form);
if ($validationResult !== true) {
Display::addFlash(Display::return_message(implode("<br>", $validationResult['errors']), 'error'));
return;
}

$questionWeighting = $nbrGoodAnswers = 0;
$correct = $form->getSubmitValue('correct');
$objAnswer = new Answer($this->iid);
Expand Down
Loading