class QuizfileuploadQuestion in Quiz File Upload 7.5

Extension of QuizQuestion.

Hierarchy

• class \QuizfileuploadQuestion extends \QuizQuestion

1 string reference to 'QuizfileuploadQuestion'

quizfileupload_quiz_question_info in ./quizfileupload.module

Implements hook_quiz_question_info().

File

./quizfileupload.classes.inc, line 14

File upload question class.

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) {
    db_merge('quiz_fileupload_node_properties')
      ->key(array(
      'nid' => $this->node->nid,
      'vid' => $this->node->vid,
    ))
      ->fields(array(
      'nid' => $this->node->nid,
      'vid' => $this->node->vid,
      'filetypes' => $this->node->filetypes,
      'filesize' => isset($this->node->filesize) ? $this->node->filesize : NULL,
      'correct_answer_evaluation' => $this->node->correct_answer_evaluation,
    ))
      ->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) {
    parent::delete($only_this_version);
    $delete_node = db_delete('quiz_fileupload_node_properties');
    $delete_node
      ->condition('nid', $this->node->nid);
    if ($only_this_version) {
      $delete_node
        ->condition('vid', $this->node->vid);
    }
    $delete_node
      ->execute();
  }

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

    // Load the properties.
    $result = db_select('quiz_fileupload_node_properties', 'qfnp')
      ->fields('qfnp', array(
      'filetypes',
      'correct_answer_evaluation',
    ))
      ->fields('qfnp', array(
      'filetypes',
      'filesize',
      'correct_answer_evaluation',
    ))
      ->condition('nid', $this->node->nid, '=')
      ->condition('vid', $this->node->vid, '=')
      ->execute()
      ->fetchAssoc();
    $this->nodeProperties = is_array($result) ? array_merge($props, $result) : $props;
    return $this->nodeProperties;
  }

  /**
   * Implements getNodeView().
   *
   * @see QuizQuestion#getNodeView()
   */
  public function getNodeView() {
    $content = parent::getNodeView();

    // No need to really check permissions as we actually don't show any answer
    // here.
    $content['answers'] = array(
      '#markup' => '<div class="quiz-solution">' . check_plain($this->node->filetypes) . '</div>',
      '#weight' => 2,
    );
    return $content;
  }

  /**
   * Implements getAnsweringForm().
   *
   * @see QuizQuestion#getAnsweringForm($form_state, $result_id)
   */
  public function getAnsweringForm(array $form_state = NULL, $result_id) {
    $element = parent::getAnsweringForm($form_state, $result_id);
    $filesize = !empty($this->node->filesize) ? parse_size($this->node->filesize) : file_upload_max_size();
    $description = array(
      t('Files must be less than !size.', array(
        '!size' => '<strong>' . format_size($filesize) . '</strong>',
      )),
      t('Allowed file types: !extensions.', array(
        '!extensions' => '<strong>' . check_plain($this->node->filetypes) . '</strong>',
      )),
    );
    $element += array(
      '#type' => 'managed_file',
      '#title' => t('Upload'),
      '#description' => implode('<br />', $description),
      '#required' => FALSE,
      '#upload_location' => variable_get('quizfileupload_upload_location', 'public') . '://quizfileupload/' . $this->node->nid . '/',
      '#upload_validators' => array(
        'file_validate_extensions' => array(
          $this->node->filetypes,
        ),
        'file_validate_size' => array(
          parse_size($filesize),
        ),
      ),
    );
    if (isset($result_id)) {
      $response = new QuizfileuploadResponse($result_id, $this->node);
      $element['#default_value'] = $response
        ->getResponse();
    }
    return $element;
  }

  /**
   * Question response validator.
   */
  public function getAnsweringFormValidate(array &$element, &$value) {
    if (empty($value['fid'])) {
      form_set_error($element['#name'], t('You must upload a file.'));
    }
    else {

      // If we have a file we'll set the status to permanent.
      // We mainly do it here so that the "allow resume" function of the quiz
      // should work as expected for the file upload as well.
      $file = file_load($value['fid']);
      $file->status = FILE_STATUS_PERMANENT;
      file_save($file);
    }
  }

  /**
   * Implements getCreationForm().
   *
   * @see QuizQuestion#getCreationForm()
   */
  public function getCreationForm(array &$form_state = NULL) {
    $allowed = variable_get('quizfileupload_default_extensions', QUIZFILEUPLOAD_DEFAULT_EXTENSIONS);
    $form['filetypes'] = array(
      '#type' => 'textfield',
      '#title' => t('Allowed file extensions'),
      '#description' => t('Separate extensions with a space or comma and do not include the leading dot.'),
      '#default_value' => str_replace(' ', ', ', isset($this->node->filetypes) ? $this->node->filetypes : $allowed),
      '#element_validate' => array(
        '_file_generic_settings_extensions',
      ),
      '#required' => TRUE,
    );
    $form['filesize'] = array(
      '#type' => 'textfield',
      '#title' => t('Maximum upload size'),
      '#default_value' => isset($this->node->filesize) ? $this->node->filesize : variable_get('quizfileupload_default_filesize', NULL),
      '#description' => t('Enter a value like "512" (bytes), "80 KB" (kilobytes) or "50 MB" (megabytes) in order to restrict the allowed file size. If left empty the file sizes will be limited only by PHP\'s maximum post and file upload sizes (current limit <strong>%limit</strong>).', array(
        '%limit' => format_size(file_upload_max_size()),
      )),
      '#maxlength' => 18,
      '#element_validate' => array(
        '_file_generic_settings_max_filesize',
      ),
    );
    $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);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
QuizfileuploadQuestion::ANSWER_MANUAL		constant
QuizfileuploadQuestion::ANSWER_MATCH		constant
QuizfileuploadQuestion::delete	public	function	Implements delete().
QuizfileuploadQuestion::getAnsweringForm	public	function	Implements getAnsweringForm().
QuizfileuploadQuestion::getAnsweringFormValidate	public	function	Question response validator.
QuizfileuploadQuestion::getCreationForm	public	function	Implements getCreationForm().
QuizfileuploadQuestion::getMaximumScore	public	function	Implements getMaximumScore().
QuizfileuploadQuestion::getNodeProperties	public	function	Implements getNodeProperties().
QuizfileuploadQuestion::getNodeView	public	function	Implements getNodeView().
QuizfileuploadQuestion::saveNodeProperties	public	function	Implements saveNodeProperties().
QuizfileuploadQuestion::validateNode	public	function	Implements validateNode().