quizfileupload.classes.inc in Quiz File Upload 7.4

The main classes for the quizfileupload question type.

These inherit or implement code found in quiz_question.classes.inc.

Based on: Other question types in the quiz framework.

File

quizfileupload.classes.inc

<?php

/**
 * The main classes for the quizfileupload question type.
 *
 * These inherit or implement code found in quiz_question.classes.inc.
 *
 * Based on:
 * Other question types in the quiz framework.
 *
 *
 *
 * @file
 */

/**
 * Extension of QuizQuestion.
 */
class QuizfileuploadQuestion extends QuizQuestion {

  // Constants for answer matching options
  const ANSWER_MATCH = 0;
  const ANSWER_MANUAL = 1;

  /**
   * Implements saveNodeProperties().
   *
   * @see QuizQuestion#saveNodeProperties($is_new)
   */
  public function saveNodeProperties($is_new = FALSE) {
    $is_new = $is_new || $this->node->revision == 1;
    if ($is_new) {
      db_insert('quiz_fileupload_node_properties')
        ->fields(array(
        'nid' => $this->node->nid,
        'vid' => $this->node->vid,
        'filetypes' => $this->node->filetypes,
        'correct_answer_evaluation' => $this->node->correct_answer_evaluation,
      ))
        ->execute();
    }
    else {
      db_update('quiz_fileupload_node_properties')
        ->fields(array(
        'filetypes' => $this->node->filetypes,
        'correct_answer_evaluation' => $this->node->correct_answer_evaluation,
      ))
        ->condition('nid', $this->node->nid)
        ->condition('vid', $this->node->vid)
        ->execute();
    }
  }

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

    //no validation required
  }

  /**
   * Implements delete().
   *
   * @see QuizQuestion#delete($only_this_version)
   */
  public function delete($only_this_version = FALSE) {
    if ($only_this_version) {
      db_delete('quiz_fileupload_node_properties')
        ->condition('question_nid', $this->node->nid)
        ->condition('question_vid', $this->node->vid)
        ->execute();
      db_delete('quiz_fileupload_user_answers')
        ->condition('nid', $this->node->nid)
        ->condition('vid', $this->node->vid)
        ->execute();
    }
    else {
      db_delete('quiz_fileupload_node_properties')
        ->condition('nid', $this->node->nid)
        ->execute();
      db_delete('quiz_fileupload_user_answers')
        ->condition('question_nid', $this->node->nid)
        ->execute();
    }
    parent::delete($only_this_version);
  }

  /**
   * Implements getNodeProperties().
   *
   * @see QuizQuestion#getNodeProperties()
   */
  public function getNodeProperties() {
    if (isset($this->nodeProperties)) {
      return $this->nodeProperties;
    }
    $props = parent::getNodeProperties();

    // Load the properties
    $res_a = db_query('SELECT filetypes, correct_answer_evaluation FROM {quiz_fileupload_node_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);
    }
    $this->nodeProperties = $props;
    return $props;
  }

  /**
   * Implements getNodeView().
   *
   * @see QuizQuestion#getNodeView()
   */
  public function getNodeView() {
    $content = parent::getNodeView();
    $content['filetypes'] = array(
      '#type' => 'markup',
      '#value' => '<pre>' . check_plain($this->node->filetypes) . '</pre>',
    );
    return $content;
  }

  /**
   * Implements getAnsweringForm().
   *
   * @see QuizQuestion#getAnsweringForm($form_state, $rid)
   */
  public function getAnsweringForm(array $form_state = NULL, $rid) {
    $form = parent::getAnsweringForm($form_state, $rid);
    $fid = db_query('SELECT qf.fid
      FROM {quiz_fileupload_user_answers} qf
      WHERE question_nid = :nid AND question_vid = :vid AND result_id = :result_id', array(
      ':nid' => $this->node->nid,
      ':vid' => $this->node->vid,
      ':result_id' => $rid,
    ))
      ->fetchField();
    if (is_numeric($fid)) {
      $form['previous_upload'] = array(
        '#title' => t('Previous upload'),
        '#type' => 'item',
        '#markup' => quiz_file_markup($fid),
        '#description' => t('<strong>Upload a new file to replace previous upload.</strong>'),
      );
    }
    $form['tries'] = array(
      '#type' => 'file',
      '#title' => t('Upload'),
      '#description' => t('Allowed extensions !ext', array(
        '!ext' => $this->node->filetypes,
      )),
    );
    return $form;
  }

  /**
   * Implements getCreationForm().
   *
   * @see QuizQuestion#getCreationForm($form_state)
   */
  public function getCreationForm(array &$form_state = NULL) {
    $allowed = variable_get('quizfileupload_default_extensions', QUIZFILEUPLOAD_DEFAULT_EXTENSIONS);
    $form['filetypes'] = array(
      '#type' => 'textfield',
      '#title' => t('Allowed extension'),
      '#description' => t('Enter the allowed file extensions one per line.'),
      '#default_value' => isset($this->node->filetypes) ? $this->node->filetypes : $allowed,
      '#required' => TRUE,
    );
    $options = array(
      self::ANSWER_MATCH => t('Automatic'),
      self::ANSWER_MANUAL => t('Manual'),
    );
    $form['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' => TRUE,
    );
    return $form;
  }

  /**
   * Implements getMaximumScore().
   *
   * @see QuizQuestion#getMaximumScore()
   */
  public function getMaximumScore() {
    return variable_get('quizfileupload_default_score', 1);
  }

}

/**
 * Extension of QuizQuestionResponse
 */
class QuizfileuploadResponse extends QuizQuestionResponse {

  /**
   * ID of the answer.
   */
  protected $answer_id = 0;
  protected $file = NULL;

  /**
   * Constructor
   */
  public function __construct($result_id, stdClass $question_node, $tries = NULL) {
    parent::__construct($result_id, $question_node, $tries);
    $tries = $_FILES;
    $this->answer = $tries;
    $this->answer_feedback = "";
    if (!isset($result) || !is_object($result)) {
      $result = new stdClass();
    }
    $result->is_correct = TRUE;
    $this->evaluated = 0;
    $response = $this
      ->getResponse();
    if (isset($question_node->correct_answer_evaluation)) {
      if ($question_node->correct_answer_evaluation == 0) {
        $this->evaluated = 1;
      }
    }
    $this->result_id = $result_id;

    // Question has been answered allready. We fetch the answer data from the database.
    $r = db_query('SELECT * FROM {quiz_fileupload_user_answers}
    WHERE question_nid = :question_nid AND question_vid = :question_vid AND result_id = :result_id', array(
      ':question_nid' => $question_node->nid,
      ':question_vid' => $question_node->vid,
      ':result_id' => $result_id,
    ))
      ->fetchAssoc();
    if (is_array($r)) {
      $this->score = $r['score'];
      $this->answer_id = $r['answer_id'];
      $this->evaluated = $r['is_evaluated'];
      $this->answer_feedback = $r['answer_feedback'];
      $this->answer_feedback_format = $r['answer_feedback_format'];
    }
  }

  /**
   * Implements isValid().
   *
   * @see QuizQuestionResponse#isValid()
   */
  public function isValid() {
    if (isset($this->file->fid)) {
      return TRUE;
    }
    else {
      return "";
    }
  }

  /**
   * Implements save().
   *
   * @see QuizQuestionResponse#save()
   */
  public function save() {
    $validator = array(
      'file_validate_extensions' => array(
        $this->question->filetypes,
      ),
    );
    $directory = variable_get('quizfileupload_upload_location', 'public') . '://quizfileupload/' . $this->question->nid . '/';
    file_prepare_directory($directory, FILE_CREATE_DIRECTORY);
    $this->file = file_save_upload('tries', $validator, $directory);
    if (isset($this->file->fid)) {
      $this->answer_id = db_insert('quiz_fileupload_user_answers')
        ->fields(array(
        'result_id' => $this->rid,
        'question_vid' => $this->question->vid,
        'question_nid' => $this->question->nid,
        'fid' => $this->file->fid,
        'score' => $this
          ->getScore(FALSE),
        'is_evaluated' => $this->evaluated,
        'answer_feedback' => $this->answer_feedback,
      ))
        ->execute();
      $this->file->status = FILE_STATUS_PERMANENT;
      file_save($this->file);
    }
  }

  /**
   * Implements delete().
   *
   * @see QuizQuestionResponse#delete()
   */
  public function delete() {
    db_delete('quiz_fileupload_user_answers')
      ->condition('question_nid', $this->question->nid)
      ->condition('question_vid', $this->question->vid)
      ->condition('result_id', $this->rid)
      ->execute();
  }

  /**
   * Implements score().
   *
   * @see QuizQuestionResponse#score()
   */
  public function score() {
    if ($this->question->correct_answer_evaluation == 1) {
      $score = db_query('SELECT score FROM {quiz_fileupload_user_answers} WHERE result_id = :result_id AND question_vid = :question_vid', array(
        ':result_id' => $this->rid,
        ':question_vid' => $this->question->vid,
      ))
        ->fetchField();
      if (!$score) {
        $score = 0;
      }
    }
    else {
      $shortAnswer = new QuizfileuploadQuestion($this->question);
      $score = $shortAnswer
        ->getMaximumScore();
    }
    return $score;
  }

  /**
   * Implements getResponse().
   *
   * @see QuizQuestionResponse#getResponse()
   */
  public function getResponse() {
    return $this->answer;
  }

  /**
   * Implements getReportFormResponse().
   *
   * @see getReportFormResponse($showpoints, $showfeedback, $allow_scoring)
   */
  public function getReportFormResponse($showpoints = TRUE, $showfeedback = TRUE, $allow_scoring = FALSE) {
    $result_id = $this->question->answers[0]['result_id'];
    $fid = db_query('SELECT f.fid
      FROM {file_managed} f
      INNER JOIN {quiz_fileupload_user_answers} qf ON (f.fid = qf.fid)
      WHERE result_id = :result_id AND question_nid = :question_nid AND question_vid = :question_vid', array(
      ':result_id' => $result_id,
      ':question_nid' => $this->question->nid,
      ':question_vid' => $this->question->vid,
    ))
      ->fetchField();
    $markup = quiz_file_markup($fid);
    if ($this->question && !empty($this->question->answers)) {
      $answer = (object) current($this->question->answers);
    }
    $form['fileupload'] = array(
      '#markup' => $markup,
    );
    if ($answer->is_evaluated == 1) {

      // Show feedback, if any.
      $form['answer_feedback'] = array(
        '#title' => t('Feedback'),
        '#type' => 'item',
        '#markup' => '<span class="quiz_answer_feedback">' . $this->answer_feedback . '</span>',
      );
    }
    else {
      $feedback = t('This answer has not yet been scored.') . '<br/>' . t('Until the answer is scored, the total score will not be correct.');
    }
    return $form;
  }

  /**
   * Implements getReportFormScore().
   *
   * @see QuizQuestionResponse#getReportFormScore($showpoints, $showfeedback, $allow_scoring)
   */
  public function getReportFormScore($showfeedback = TRUE, $showpoints = TRUE, $allow_scoring = FALSE) {
    $node = node_load($this->question->nid);
    $score = $this
      ->isEvaluated() ? $this
      ->getScore() : '?';
    if (quiz_access_to_score() && $allow_scoring && $node->correct_answer_evaluation == 1) {
      return array(
        '#type' => 'textfield',
        '#default_value' => $score,
        '#size' => 3,
        '#maxlength' => 3,
        '#attributes' => array(
          'class' => array(
            'quiz-report-score',
          ),
        ),
      );
    }
    else {
      return array(
        '#markup' => $score,
      );
    }
  }
  public function getReportFormAnswerFeedback($showpoints = TRUE, $showfeedback = TRUE, $allow_scoring = FALSE) {
    if (quiz_access_to_score() && $allow_scoring) {
      return array(
        '#title' => t('Enter feedback'),
        '#type' => 'text_format',
        '#default_value' => $this->answer_feedback,
        '#format' => isset($this->answer_feedback_format) ? $this->answer_feedback_format : NULL,
        '#attributes' => array(
          'class' => array(
            'quiz-report-score',
          ),
        ),
      );
    }
    return FALSE;
  }

  /**
   * Implements getReportFormSubmit().
   *
   * @see QuizQuestionResponse#getReportFormSubmit($showfeedback, $showpoints, $allow_scoring)
   */
  public function getReportFormSubmit($showfeedback = TRUE, $showpoints = TRUE, $allow_scoring = FALSE) {
    $node = node_load($this->question->nid);
    if (isset($node->correct_answer_evaluation)) {
      if (quiz_access_to_score() && $allow_scoring && $node->correct_answer_evaluation == 1) {
        return $allow_scoring ? 'quizfileupload_report_submit' : FALSE;
      }
    }
    return FALSE;
  }

  /**
   * Implements getReportFormValidate().
   *
   * @see QuizQuestionResponse#getReportFormValidate($showfeedback, $showpoints, $allow_scoring)
   */
  public function getReportFormValidate($showfeedback = TRUE, $showpoints = TRUE, $allow_scoring = FALSE) {
    $node = node_load($this->question->nid);
    if (isset($node->correct_answer_evaluation)) {
      if (quiz_access_to_score() && $allow_scoring && $node->correct_answer_evaluation == 1) {
        return $allow_scoring ? 'quizfileupload_report_validate' : FALSE;
      }
    }
    return FALSE;
  }

}

/**
 * Markup function to show the file on the result screen
 */
function quiz_file_markup($fid) {
  if (is_numeric($fid)) {

    // image check
    $file = file_load($fid);
    $errors = file_validate_is_image($file);

    // not image
    if (count($errors)) {
      return l($file->filename, file_create_url($file->uri));
    }
    else {
      $variables['item'] = array(
        'uri' => $file->uri,
        'alt' => '',
        'title' => $file->filename,
      );
      $variables['path'] = array(
        'path' => file_create_url($file->uri),
        'options' => array(
          'html' => TRUE,
        ),
      );
      $variables['image_style'] = 'large';
      return theme('image_formatter', $variables);
    }
  }
  else {
    return t('n/a');
  }
}

Functions

Name	Description
quiz_file_markup	Markup function to show the file on the result screen

Classes

Name	Description
QuizfileuploadQuestion	Extension of QuizQuestion.
QuizfileuploadResponse	Extension of QuizQuestionResponse