short_answer.classes.inc in Quiz 6.4
Same filename and directory in other branches
- 6.6 question_types/short_answer/short_answer.classes.inc
- 6.3 question_types/short_answer/short_answer.classes.inc
- 6.5 question_types/short_answer/short_answer.classes.inc
- 7.6 question_types/short_answer/short_answer.classes.inc
- 7 question_types/short_answer/short_answer.classes.inc
- 7.4 question_types/short_answer/short_answer.classes.inc
- 7.5 question_types/short_answer/short_answer.classes.inc
The main classes for the short answer question type.
These inherit or implement code found in quiz_question.classes.inc.
If you are developing your own question type, the easiest place to start is with multichoice.classes.inc. short_answer and long_answer are good for understanding question types that involve textual answers.
File
question_types/short_answer/short_answer.classes.incView source
<?php
/**
* The main classes for the short answer question type.
*
* These inherit or implement code found in quiz_question.classes.inc.
*
* If you are developing your own question type, the easiest place to start is with
* multichoice.classes.inc. short_answer and long_answer are good for understanding
* question types that involve textual answers.
*
* @file
*/
/**
* Extension of QuizQuestion.
*
* This could have extended long answer, except that that would have entailed
* adding long answer as a dependency.
*/
class ShortAnswerQuestion extends QuizQuestion {
// Constants for answer matching options
const ANSWER_MATCH = 0;
const ANSWER_INSENSITIVE_MATCH = 1;
const ANSWER_REGEX = 2;
const ANSWER_MANUAL = 3;
/**
* Implementation of saveNodeProperties
*
* @see QuizQuestion#saveNodeProperties($is_new)
*/
public function saveNodeProperties($is_new = FALSE) {
if ($is_new || $this->node->revision == 1) {
$sql = "INSERT INTO {quiz_short_answer_node_properties}\n (nid, vid, correct_answer, correct_answer_evaluation)\n VALUES (%d, %d, '%s', %d)";
db_query($sql, $this->node->nid, $this->node->vid, $this->node->correct_answer, $this->node->correct_answer_evaluation);
}
else {
$sql = "UPDATE {quiz_short_answer_node_properties}\n SET correct_answer = '%s', correct_answer_evaluation = %d\n WHERE nid = %d AND vid = %d";
db_query($sql, $this->node->correct_answer, $this->node->correct_answer_evaluation, $this->node->nid, $this->node->vid);
}
}
/**
* Implementation of validateNode
*
* @see QuizQuestion#validateNode($form)
*/
public function validateNode(array &$form) {
if ($this->node->correct_answer_evaluation != self::ANSWER_MANUAL && empty($this->node->correct_answer)) {
form_set_error('correct_answer', t('An answer must be specified for any evaluation type other than manual scoring.'));
}
}
/**
* Implementation of delete
*
* @see QuizQuestion#delete($only_this_version)
*/
public function delete($only_this_version = FALSE) {
parent::delete($only_this_version);
if ($only_this_version) {
db_query('DELETE FROM {quiz_short_answer_user_answers} WHERE question_nid = %d AND question_vid = %d', $this->node->nid, $this->node->vid);
db_query('DELETE FROM {quiz_short_answer_node_properties} WHERE nid = %d AND vid = %d', $this->node->nid, $this->node->vid);
}
else {
db_query('DELETE FROM {quiz_short_answer_user_answers} WHERE question_nid = %d', $this->node->nid);
db_query('DELETE FROM {quiz_short_answer_node_properties} WHERE nid = %d', $this->node->nid);
}
}
/**
* Implementation of getNodeProperties
*
* @see QuizQuestion#getNodeProperties()
*/
public function getNodeProperties() {
if (isset($this->nodeProperties)) {
return $this->nodeProperties;
}
$props = parent::getNodeProperties();
$sql = 'SELECT correct_answer, correct_answer_evaluation
FROM {quiz_short_answer_node_properties}
WHERE nid = %d AND vid = %d';
$res = db_query($sql, $this->node->nid, $this->node->vid);
$res_a = db_fetch_array($res);
if (is_array($res_a)) {
$props = array_merge($props, $res_a);
}
$this->nodeProperties = $props;
return $props;
}
/**
* Implementation of getNodeView
*
* @see QuizQuestion#getNodeView()
*/
public function getNodeView() {
$content = parent::getNodeView();
if ($this
->viewCanRevealCorrect()) {
$content['answers'] = array(
'#type' => 'markup',
'#value' => '<div class="quiz-solution">' . check_plain($this->node->correct_answer) . '</div>',
'#weight' => 1,
);
}
else {
$content['answers'] = array(
'#type' => 'markup',
'#value' => '<div class="quiz-answer-hidden">Answer hidden</div>',
'#weight' => 2,
);
}
return $content;
}
/**
* Implementation of getAnsweringForm
*
* @see QuizQuestion#getAnsweringForm($form_state, $rid)
*/
public function getAnsweringForm(array $form_state = NULL, $rid) {
$form = parent::getAnsweringForm($form_state, $rid);
$form['#theme'] = 'short_answer_answering_form';
$form['tries'] = array(
'#type' => 'textfield',
'#title' => t('Answer'),
'#description' => t('Enter your answer here'),
'#default_value' => '',
'#size' => 60,
'#maxlength' => 256,
'#required' => FALSE,
);
if (isset($rid)) {
$response = new ShortAnswerResponse($rid, $this->node);
$form['tries']['#default_value'] = $response
->getResponse();
}
return $form;
}
/**
* Implementation of getCreationForm
*
* @see QuizQuestion#getCreationForm($form_state)
*/
public function getCreationForm(array $form_state = NULL) {
$form['answer'] = array(
'#type' => 'fieldset',
'#title' => t('Answer'),
'#description' => t('Provide the answer and the method by which the answer will be evaluated.'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#weight' => -4,
);
$options = array(
self::ANSWER_MATCH => t('Automatic and case sensitive'),
self::ANSWER_INSENSITIVE_MATCH => t('Automatic. Not case sensitive'),
);
$access_regex = user_access('use regex for short answer');
if ($access_regex) {
$options[self::ANSWER_REGEX] = t('Match against a regular expression (answer must match the supplied regular expression)');
}
$options[self::ANSWER_MANUAL] = t('Manual');
$form['answer']['correct_answer_evaluation'] = array(
'#type' => 'radios',
'#title' => t('Pick an evaluation method'),
'#description' => t('Choose how the answer shall be evaluated.'),
'#options' => $options,
'#default_value' => isset($this->node->correct_answer_evaluation) ? $this->node->correct_answer_evaluation : self::ANSWER_MATCH,
'#required' => FALSE,
);
if ($access_regex) {
$form['answer']['regex_box'] = array(
'#type' => 'fieldset',
'#title' => t('About regular expressions'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['answer']['regex_box']['regex_help'] = array(
'#type' => 'markup',
'#value' => '<p>' . t('Regular expressions are an advanced syntax for pattern matching. They allow you to create a concise set of rules that must be met before a value can be considered a match.') . '</p><p>' . t('For more on regular expression syntax, visit !url.', array(
'!url' => l('the PHP regular expressions documentation', 'http://www.php.net/manual/en/book.pcre.php'),
)) . '</p>',
);
}
$form['answer']['correct_answer'] = array(
'#type' => 'textfield',
'#title' => t('Correct answer'),
'#description' => t('Specify the answer. If this question is manually scored, no answer needs to be supplied.'),
'#default_value' => isset($this->node->correct_answer) ? $this->node->correct_answer : '',
'#size' => 60,
'#maxlength' => 256,
'#required' => FALSE,
);
return $form;
}
/**
* Implementation of getMaximumScore
*
* @see QuizQuestion#getMaximumScore()
*/
public function getMaximumScore() {
return 5;
}
/**
* Evaluate the correctness of an answer based on the correct answer and evaluation method.
*/
public function evaluateAnswer($user_answer) {
$score = 0;
switch ($this->node->correct_answer_evaluation) {
case self::ANSWER_MATCH:
if ($user_answer == $this->node->correct_answer) {
$score = $this->node->max_score;
}
break;
case self::ANSWER_INSENSITIVE_MATCH:
if (drupal_strtolower($user_answer) == drupal_strtolower($this->node->correct_answer)) {
$score = $this->node->max_score;
}
break;
case self::ANSWER_REGEX:
if (preg_match($this->node->correct_answer, $user_answer) > 0) {
$score = $this->node->max_score;
}
break;
}
return $score;
}
}
/**
* Extension of QuizQuestionResponse
*/
class ShortAnswerResponse extends QuizQuestionResponse {
/**
* Get all quiz scores that haven't been evaluated yet.
*
* @param $count
* Number of items to return (default: 50).
* @param $offset
* Where in the results we should start (default: 0).
*
* @return
* Array of objects describing unanswered questions. Each object will have result_id, question_nid, and question_vid.
*/
public static function fetchAllUnscoredAnswers($count = 50, $offset = 0) {
global $user;
$sql = 'SELECT a.result_id, a.question_nid, a.question_vid, a.answer_feedback, r.title, qnr.time_end, qnr.time_start, qnr.uid
FROM {quiz_short_answer_user_answers} AS a
INNER JOIN {node_revisions} r ON a.question_vid = r.vid
INNER JOIN {quiz_node_results} qnr ON a.result_id = qnr.result_id
JOIN {node} n ON qnr.nid = n.nid
WHERE a.is_evaluated = 0';
if (!user_access('score any quiz')) {
$sql .= ' AND n.uid = %d';
}
$results = db_query_range(db_rewrite_sql($sql), $user->uid, $offset, $count);
$unscored = array();
if ($results) {
while ($row = db_fetch_object($results)) {
$unscored[] = $row;
}
}
return $unscored;
}
/**
* Given a question, return a list of all of the unscored answers.
*
* @param $nid
* Node ID for the question to check.
* @param $vid
* Version ID for the question to check.
* @param $count
* Number of items to return (default: 50).
* @param $offset
* Where in the results we should start (default: 0).
*
* @return
* Indexed array of result IDs that need to be scored.
*/
public static function fetchUnscoredAnswersByQuestion($nid, $vid, $count = 50, $offset = 0) {
$results = db_query_range('SELECT result_id FROM {quiz_short_answer_user_answers} WHERE is_evaluated = 0 AND question_nid = %d AND question_vid = %d', $nid, $vid, $offset, $count);
$unscored = array();
foreach (db_fetch_object($results) as $row) {
$unscored[] = $row->result_id;
}
return $unscored;
}
/**
* ID of the answer.
*/
protected $answer_id = 0;
/**
* Constructor
*/
public function __construct($result_id, stdClass $question_node, $answer = NULL) {
parent::__construct($result_id, $question_node, $answer);
if (!isset($answer)) {
$sql = "SELECT answer_id, answer, is_evaluated, score, question_vid, question_nid, result_id, answer_feedback\n FROM {quiz_short_answer_user_answers}\n WHERE question_nid = %d AND question_vid = %d AND result_id = %d";
$r = db_fetch_object(db_query($sql, $question_node->nid, $question_node->vid, $result_id));
if (!empty($r)) {
$this->answer = $r->answer;
$this->score = $r->score;
$this->evaluated = $r->is_evaluated;
$this->answer_id = $r->answer_id;
$this->answer_feedback = $r->answer_feedback;
}
}
else {
if (is_array($answer)) {
$this->answer = $answer['answer'];
}
else {
$this->answer = $answer;
$this->evaluated = $this->question->correct_answer_evaluation != ShortAnswerQuestion::ANSWER_MANUAL;
}
}
}
/**
* Implementation of isValid
*
* @see QuizQuestionResponse#isValid()
*/
public function isValid() {
if (trim($this->answer) == '') {
return t('You must provide an answer');
}
return TRUE;
}
/**
* Implementation of save
*
* @see QuizQuestionResponse#save()
*/
public function save() {
// We need to set is_evaluated depending on whether the type requires evaluation.
$this->is_evaluated = (int) ($this->question->correct_answer_evaluation != ShortAnswerQuestion::ANSWER_MANUAL);
$sql = "INSERT INTO {quiz_short_answer_user_answers}\n (answer, question_nid, question_vid, result_id, score, is_evaluated)\n VALUES ('%s', %d, %d, %d, %d, %d)";
db_query($sql, $this->answer, $this->question->nid, $this->question->vid, $this->rid, $this
->getScore(FALSE), $this->is_evaluated);
$this->answer_id = db_last_insert_id('quiz_long_answer_user_answers', 'answer_id');
}
/**
* Implementation of delete
*
* @see QuizQuestionResponse#delete()
*/
public function delete() {
$sql = 'DELETE FROM {quiz_short_answer_user_answers} WHERE question_nid = %d AND question_vid = %d AND result_id = %d';
db_query($sql, $this->question->nid, $this->question->vid, $this->rid);
}
/**
* Implementation of score
*
* @see QuizQuestionResponse#score()
*/
public function score() {
// Manual scoring means we go with what is in the DB.
if ($this->question->correct_answer_evaluation == ShortAnswerQuestion::ANSWER_MANUAL) {
$sql = "SELECT score FROM {quiz_short_answer_user_answers} WHERE result_id = %d AND question_vid = %d";
$score = db_result(db_query($sql, $this->rid, $this->question->vid));
}
else {
$shortAnswer = new ShortAnswerQuestion($this->question);
$score = $shortAnswer
->evaluateAnswer($this
->getResponse());
}
return $score;
}
/**
* Implementation of getResponse
*
* @see QuizQuestionResponse#getResponse()
*/
public function getResponse() {
return $this->answer;
}
/**
* Implementation of getReportFormResponse
*
* @see QuizQuestionResponse#getReportFormResponse($showpoints, $showfeedback, $allow_scoring)
*/
public function getReportFormResponse($showpoints = TRUE, $showfeedback = TRUE, $allow_scoring = FALSE) {
$form = array();
$form['#theme'] = 'short_answer_response_form';
if ($this->question && !empty($this->question->answers)) {
$answer = (object) current($this->question->answers);
}
else {
return $form;
}
$form['answer'] = array(
'#type' => 'markup',
'#value' => theme('short_answer_user_answer', check_plain($answer->answer), check_plain($this->question->correct_answer)),
);
if ($answer->is_evaluated == 1) {
// Show feedback, if any.
if ($showfeedback && !empty($answer->feedback)) {
// @todo: Feedback doesn't seem to be in use anymore...
$feedback = check_markup($answer->feedback);
}
}
else {
$feedback = t('This answer has not yet been scored.') . '<br/>' . t('Until the answer is scored, the total score will not be correct.');
}
if (!$allow_scoring && !empty($this->answer_feedback)) {
$form['answer_feedback'] = array(
'#title' => t('Feedback'),
'#type' => 'item',
'#value' => '<span class="quiz_answer_feedback">' . $this->answer_feedback . '</span>',
);
}
if (!empty($feedback)) {
$form['feedback'] = array(
'#type' => 'markup',
'#value' => '<span class="quiz_answer_feedback">' . $feedback . '</span>',
);
}
return $form;
}
/**
* Implementation of getReportFormScore
*
* @see QuizQuestionResponse#getReportFormScore($showpoints, $showfeedback, $allow_scoring)
*/
public function getReportFormScore($showfeedback = TRUE, $showpoints = TRUE, $allow_scoring = FALSE) {
$score = $this
->isEvaluated() ? $this
->getScore() : '?';
if (quiz_access_to_score() && $allow_scoring && $this->question->correct_answer_evaluation == ShortAnswerQuestion::ANSWER_MANUAL) {
return array(
'#type' => 'textfield',
'#default_value' => $score,
'#size' => 3,
'#maxlength' => 3,
'#attributes' => array(
'class' => 'quiz-report-score',
),
);
}
else {
return array(
'#type' => 'markup',
'#value' => $score,
);
}
}
public function getReportFormAnswerFeedback($showpoints = TRUE, $showfeedback = TRUE, $allow_scoring = FALSE) {
if (quiz_access_to_score() && $allow_scoring && $this->question->correct_answer_evaluation == ShortAnswerQuestion::ANSWER_MANUAL) {
return array(
'#title' => t('Enter feedback'),
'#type' => 'textarea',
'#default_value' => $this->answer_feedback,
'#attributes' => array(
'class' => 'quiz-report-score',
),
);
}
return FALSE;
}
/**
* Implementation of getReportFormSubmit
*
* @see QuizQuestionResponse#getReportFormSubmit($showfeedback, $showpoints, $allow_scoring)
*/
public function getReportFormSubmit($showfeedback = TRUE, $showpoints = TRUE, $allow_scoring = FALSE) {
if (quiz_access_to_score() && $allow_scoring && $this->question->correct_answer_evaluation == ShortAnswerQuestion::ANSWER_MANUAL) {
return $allow_scoring ? 'short_answer_report_submit' : FALSE;
}
return FALSE;
}
/**
* Implementation of getReportFormValidate
*
* @see QuizQuestionResponse#getReportFormValidate($showfeedback, $showpoints, $allow_scoring)
*/
public function getReportFormValidate($showfeedback = TRUE, $showpoints = TRUE, $allow_scoring = FALSE) {
if (quiz_access_to_score() && $allow_scoring && $this->question->correct_answer_evaluation == ShortAnswerQuestion::ANSWER_MANUAL) {
return $allow_scoring ? 'short_answer_report_validate' : FALSE;
}
return FALSE;
}
}
Classes
Name![]() |
Description |
---|---|
ShortAnswerQuestion | Extension of QuizQuestion. |
ShortAnswerResponse | Extension of QuizQuestionResponse |