class MatchingQuestion in Quiz 7.6

Extension of QuizQuestion.

Hierarchy

• class \QuizQuestion
  • class \MatchingQuestion

1 string reference to 'MatchingQuestion'

matching_quiz_question_info in question_types/matching/matching.module

Implements hook_quiz_question_info().

File

question_types/matching/matching.classes.inc, line 17

matching.classes

class MatchingQuestion extends QuizQuestion {

  /**
   * Constructor
   *
   * @param $node
   *  matching node
   */
  public function __construct(stdClass $node) {
    parent::__construct($node);
    if (empty($this->node->match)) {
      $this->node->match = array();
    }
  }

  /**
   * Implementation of saveNodeProperties
   *
   * @see QuizQuestion#saveNodeProperties($is_new)
   */
  public function saveNodeProperties($is_new = FALSE) {

    // Update or insert the question properties
    db_merge('quiz_matching_properties')
      ->key(array(
      'nid' => $this->node->nid,
      'vid' => $this->node->vid,
    ))
      ->fields(array(
      'choice_penalty' => $this->node->choice_penalty,
    ))
      ->execute();

    // Loop through each question-answer combination
    foreach ($this->node->match as $match) {
      $match['feedback'] = isset($match['feedback']) ? $match['feedback'] : '';

      // match_id is not so it is a new question.
      if ($is_new || empty($match['match_id']) || $this->node->revision || isset($this->node->node_export_drupal_version)) {
        if (!empty($match['question']) && !empty($match['answer'])) {
          $id = db_insert('quiz_matching_node')
            ->fields(array(
            'nid' => $this->node->nid,
            'vid' => $this->node->vid,
            'question' => $match['question'],
            'answer' => $match['answer'],
            'feedback' => $match['feedback'],
          ))
            ->execute();
        }
      }
      else {
        if (empty($match['question']) && empty($match['answer'])) {

          // remove sub question.
          db_delete('quiz_matching_node')
            ->condition('match_id', $match['match_id'])
            ->execute();
        }
        else {

          // update sub question.
          db_update('quiz_matching_node')
            ->fields(array(
            'question' => $match['question'],
            'answer' => $match['answer'],
            'feedback' => $match['feedback'],
          ))
            ->condition('match_id', $match['match_id'])
            ->execute();
        }
      }
    }
  }

  /**
   * Implementation of validateNode
   *
   * @see QuizQuestion#validateNode($form)
   */
  public function validateNode(array &$form) {

    // No validation is required
    // The first two pairs are required in the form, if there are other errors we forgive them
  }

  /**
   * Implementation of delete
   *
   * @see QuizQuestion#delete($only_this_version)
   */
  public function delete($only_this_version = FALSE) {
    parent::delete($only_this_version);
    $delete_properties = db_delete('quiz_matching_properties')
      ->condition('nid', $this->node->nid);
    if ($only_this_version) {
      $delete_properties
        ->condition('vid', $this->node->vid);
      $match_id = db_query('SELECT match_id FROM {quiz_matching_node} WHERE nid = :nid AND vid = :vid', array(
        ':nid' => $this->node->nid,
        ':vid' => $this->node->vid,
      ))
        ->fetchCol();
      db_delete('quiz_matching_user_answers')
        ->condition('match_id', is_array($match_id) ? $match_id : array(
        0,
      ), 'IN')
        ->execute();
      db_delete('quiz_matching_node')
        ->condition('nid', $this->node->nid)
        ->condition('vid', $this->node->vid)
        ->execute();
    }
    else {
      $match_id = db_query('SELECT match_id FROM {quiz_matching_node} WHERE nid = :nid', array(
        ':nid' => $this->node->nid,
      ))
        ->fetchCol();
      if (!empty($match_id)) {
        db_delete('quiz_matching_user_answers')
          ->condition('match_id', $match_id, 'IN')
          ->execute();
      }
      db_delete('quiz_matching_node')
        ->condition('nid', $this->node->nid)
        ->execute();
    }
    $delete_properties
      ->execute();
  }

  /**
   * Implementation of getNodeProperties
   *
   * @see QuizQuestion#getNodeProperties()
   */
  public function getNodeProperties() {
    if (isset($this->nodeProperties)) {
      return $this->nodeProperties;
    }
    $props = parent::getNodeProperties();
    $res_a = db_query('SELECT choice_penalty FROM {quiz_matching_properties}
            WHERE nid = :nid AND vid = :vid', array(
      ':nid' => $this->node->nid,
      ':vid' => $this->node->vid,
    ))
      ->fetchAssoc();
    if (is_array($res_a)) {
      $props = array_merge($props, $res_a);
    }

    //$sql = "SELECT match_id, question, answer, feedback FROM {quiz_matching_node} WHERE nid = %d AND vid = %d";
    $query = db_query('SELECT match_id, question, answer, feedback FROM {quiz_matching_node} WHERE nid = :nid AND vid = :vid', array(
      ':nid' => $this->node->nid,
      ':vid' => $this->node->vid,
    ));
    while ($result = $query
      ->fetch()) {
      $props['match'][] = array(
        'match_id' => $result->match_id,
        'question' => $result->question,
        'answer' => $result->answer,
        'feedback' => $result->feedback,
      );
    }
    $this->nodeProperties = $props;
    return $props;
  }

  /**
   * Implementation of getNodeView
   *
   * @see QuizQuestion#getNodeView()
   */
  public function getNodeView() {
    $content = parent::getNodeView();
    list($matches, $select_option) = $this
      ->getSubquestions();
    $subquestions = array();
    if ($this
      ->viewCanRevealCorrect()) {
      foreach ($matches as $match) {
        $subquestions[] = array(
          'question' => $match['question'],
          'correct' => $match['answer'],
          'feedback' => $match['feedback'],
        );
      }
    }
    else {

      // shuffle the answer column
      foreach ($matches as $match) {
        $sub_qs[] = $match['question'];
        $sub_as[] = $match['answer'];
      }
      shuffle($sub_as);
      foreach ($sub_qs as $i => $sub_q) {
        $subquestions[] = array(
          'question' => $sub_q,
          'random' => $sub_as[$i],
        );
      }
    }
    $content['answers'] = array(
      '#markup' => theme('matching_match_node_view', array(
        'subquestions' => $subquestions,
      )),
      '#weight' => 2,
    );
    return $content;
  }

  /**
   * Implementation of getAnsweringForm
   *
   * @see QuizQuestion#getAnsweringForm($form_state, $result_id)
   */
  public function getAnsweringForm(array $form_state = NULL, $result_id) {
    $form = parent::getAnsweringForm($form_state, $result_id);
    if (isset($result_id)) {

      // The question has already been answered. We load the answers
      $response = new MatchingResponse($result_id, $this->node);
      $responses = $response
        ->getResponse();
    }
    list($matches, $select_option) = $this
      ->getSubquestions();

    //$form['#theme'] = 'matching_subquestion_form';
    foreach ($matches as $match) {
      $form[$match['match_id']] = array(
        '#title' => $match['question'],
        '#type' => 'select',
        '#options' => $this
          ->customShuffle($select_option),
      );
      if ($responses) {

        // If this question already has been answered
        $form[$match['match_id']]['#default_value'] = $responses[$match['match_id']];
      }
    }
    if (variable_get('quiz_matching_shuffle_options', TRUE)) {
      $form = $this
        ->customShuffle($form);
    }
    $form['scoring_info'] = array(
      '#markup' => '<p><em>' . t('You lose points by selecting incorrect options. You may leave an option blank to avoid losing points.') . '</em></p>',
    );
    return $form;
  }

  /**
   * Question response validator.
   */
  public function getAnsweringFormValidate(array &$form, array &$form_state = NULL) {
    $question_answer = $form_state['values']['question'][$this->node->nid]['answer'];
    foreach ($question_answer as $value) {
      if ($value != 'def') {
        return TRUE;
      }
    }
    form_set_error('', t('You need to match at least one of the items.'));
  }

  /**
   * Shuffles an array, but keeps the keys, and makes sure the first element is the default element
   *
   * @param $array
   *  Array to be shuffled
   * @return
   *  A shuffled version of the array with $array['def'] = '' as the first element
   */
  private function customShuffle(array $array = array()) {
    $new_array = array();
    $new_array['def'] = '';
    while (count($array)) {
      $element = array_rand($array);
      $new_array[$element] = $array[$element];
      unset($array[$element]);
    }
    return $new_array;
  }

  /**
   * Helper function to fetch subquestions
   *
   * @return
   *  Array with two arrays, matches and selected options
   */
  public function getSubquestions() {
    $matches = $select_option = array();

    //$sql = "SELECT match_id, question, answer, feedback FROM {quiz_matching_node} WHERE nid = %d AND vid = %d";
    $query = db_query('SELECT match_id, question, answer, feedback FROM {quiz_matching_node} WHERE nid = :nid AND vid = :vid', array(
      ':nid' => $this->node->nid,
      ':vid' => $this->node->vid,
    ));
    while ($result = $query
      ->fetch()) {
      $matches[] = array(
        'match_id' => $result->match_id,
        'question' => $result->question,
        'answer' => $result->answer,
        'feedback' => $result->feedback,
      );
      $select_option[$result->match_id] = $result->answer;
    }
    return array(
      $matches,
      $select_option,
    );
  }

  /**
   * Implementation of getBodyFieldTitle
   *
   * @see QuizQuestion#getBodyFieldTitle()
   */
  public function getBodyFieldTitle() {
    return t('Instruction');
  }

  /**
   * Implementation of getCreationForm
   *
   * @see QuizQuestion#getCreationForm($form_state)
   */
  public function getCreationForm(array &$form_state = NULL) {

    // Get the nodes settings, users settings or default settings
    $default_settings = $this
      ->getDefaultAltSettings();
    $form['settings'] = array(
      '#type' => 'fieldset',
      '#title' => t('Settings'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    );
    $form['settings']['choice_penalty'] = array(
      '#type' => 'checkbox',
      '#title' => t('Penalty for guessing'),
      '#description' => t('Subtract 1 point from the users score for each incorrect match. Scores cannot go below 0.'),
      '#default_value' => $default_settings['choice_penalty'],
      '#parents' => array(
        'choice_penalty',
      ),
    );
    $form['match'] = array(
      '#type' => 'fieldset',
      '#title' => t('Answer'),
      '#weight' => -4,
      '#tree' => TRUE,
      '#theme' => 'matching_question_form',
      '#description' => t('Write your pairs in the question and answer columns. For the user the question will be fixed and the answers will be shown as alternatives in a dropdown box.'),
    );
    for ($i = 1; $i <= variable_get('quiz_matching_form_size', 5); ++$i) {
      $form['match'][$i] = array(
        '#type' => 'fieldset',
        '#title' => t('Question ' . $i),
      );
      $form['match'][$i]['match_id'] = array(
        '#type' => 'value',
        '#default_value' => isset($this->node->match[$i - 1]['match_id']) ? $this->node->match[$i - 1]['match_id'] : '',
      );
      $form['match'][$i]['question'] = array(
        '#type' => 'textarea',
        '#rows' => 2,
        '#default_value' => isset($this->node->match[$i - 1]['question']) ? $this->node->match[$i - 1]['question'] : '',
        '#required' => $i < 3,
      );
      $form['match'][$i]['answer'] = array(
        '#type' => 'textarea',
        '#rows' => 2,
        '#default_value' => isset($this->node->match[$i - 1]['answer']) ? $this->node->match[$i - 1]['answer'] : '',
        '#required' => $i < 3,
      );
      $form['match'][$i]['feedback'] = array(
        '#type' => 'textarea',
        '#rows' => 2,
        '#default_value' => isset($this->node->match[$i - 1]['feedback']) ? $this->node->match[$i - 1]['feedback'] : '',
      );
    }
    return $form;
  }

  /**
   * Helper function provding the default settings for the creation form.
   *
   * @return
   *  Array with the default settings
   */
  private function getDefaultAltSettings() {

    // If the node is being updated the default settings are those stored in the node
    if (isset($this->node->nid)) {
      $settings['choice_penalty'] = $this->node->choice_penalty;
    }
    else {
      $settings['choice_penalty'] = 0;
    }
    return $settings;
  }

  /**
   * Implementation of getMaximumScore
   *
   * @see QuizQuestion#getMaximumScore()
   */
  public function getMaximumScore() {
    $to_return = 0;
    foreach ($this->node->match as $match) {
      if (empty($match['question']) || empty($match['answer'])) {
        continue;
      }
      $to_return++;
    }

    // The maximum score = the number of sub-questions
    return $to_return;
  }

  /**
   * Get the correct answers for this question
   *
   * @return
   *  Array of correct answers
   */
  public function getCorrectAnswer() {
    $correct_answers = array();
    $query = db_query('SELECT match_id, question, answer, feedback FROM {quiz_matching_node} WHERE nid = :nid AND vid = :vid', array(
      ':nid' => $this->node->nid,
      ':vid' => $this->node->vid,
    ));
    while ($result = $query
      ->fetch()) {
      $correct_answers[$result->match_id] = array(
        'match_id' => $result->match_id,
        'question' => $result->question,
        'answer' => $result->answer,
        'feedback' => $result->feedback,
      );
    }
    return $correct_answers;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MatchingQuestion::customShuffle	private	function	Shuffles an array, but keeps the keys, and makes sure the first element is the default element
MatchingQuestion::delete	public	function	Implementation of delete Overrides QuizQuestion::delete
MatchingQuestion::getAnsweringForm	public	function	Implementation of getAnsweringForm Overrides QuizQuestion::getAnsweringForm
MatchingQuestion::getAnsweringFormValidate	public	function	Question response validator. Overrides QuizQuestion::getAnsweringFormValidate
MatchingQuestion::getBodyFieldTitle	public	function	Implementation of getBodyFieldTitle Overrides QuizQuestion::getBodyFieldTitle
MatchingQuestion::getCorrectAnswer	public	function	Get the correct answers for this question
MatchingQuestion::getCreationForm	public	function	Implementation of getCreationForm Overrides QuizQuestion::getCreationForm
MatchingQuestion::getDefaultAltSettings	private	function	Helper function provding the default settings for the creation form.
MatchingQuestion::getMaximumScore	public	function	Implementation of getMaximumScore Overrides QuizQuestion::getMaximumScore
MatchingQuestion::getNodeProperties	public	function	Implementation of getNodeProperties Overrides QuizQuestion::getNodeProperties
MatchingQuestion::getNodeView	public	function	Implementation of getNodeView Overrides QuizQuestion::getNodeView
MatchingQuestion::getSubquestions	public	function	Helper function to fetch subquestions
MatchingQuestion::saveNodeProperties	public	function	Implementation of saveNodeProperties Overrides QuizQuestion::saveNodeProperties
MatchingQuestion::validateNode	public	function	Implementation of validateNode Overrides QuizQuestion::validateNode
MatchingQuestion::__construct	public	function	Constructor Overrides QuizQuestion::__construct
QuizQuestion::$node	public	property	The current node for this question.
QuizQuestion::$nodeProperties	public	property
QuizQuestion::autoUpdateMaxScore	protected	function	This may be overridden in subclasses. If it returns true, it means the max_score is updated for all occurrences of this question in quizzes.
QuizQuestion::getFormat	protected	function	Utility function that returns the format of the node body
QuizQuestion::getNodeForm	public	function	Returns a node form to quiz_question_form
QuizQuestion::hasBeenAnswered	public	function	Finds out if a question has been answered or not
QuizQuestion::hasFeedback	public	function	Does this question type give feedback?	2
QuizQuestion::isGraded	public	function	Is this question graded?	2
QuizQuestion::save	public	function	Responsible for handling insert/update of question-specific data. This is typically called from within the Node API, so there is no need to save the node.
QuizQuestion::saveRelationships		function	Save this Question to the specified Quiz.
QuizQuestion::viewCanRevealCorrect	public	function	Determines if the user can view the correct answers