MultichoiceQuestion.php in Quiz 8.6

Same filename and directory in other branches
Namespace

Drupal\quiz_multichoice\Plugin\quiz\QuizQuestion
File

question_types/quiz_multichoice/src/Plugin/quiz/QuizQuestion/MultichoiceQuestion.php
View source
<?php

namespace Drupal\quiz_multichoice\Plugin\quiz\QuizQuestion;

use Drupal;
use Drupal\Core\Form\FormStateInterface;
use Drupal\paragraphs\Entity\Paragraph;
use Drupal\quiz\Entity\QuizQuestion;
use Drupal\quiz\Entity\QuizResultAnswer;
use function check_markup;
use function db_delete;
use function db_insert;
use function db_merge;
use function db_query;
use function db_update;
use function variable_get;

/**
 * @QuizQuestion (
 *   id = "multichoice",
 *   label = @Translation("Multiple choice question"),
 *   handlers = {
 *     "response" = "\Drupal\quiz_multichoice\Plugin\quiz\QuizQuestion\MultichoiceResponse"
 *   }
 * )
 */
class MultichoiceQuestion extends QuizQuestion {
  function save() {

    // Before we save we forgive some possible user errors.
    // @todo fix for D8

    //$this->forgive();
    return parent::save();
  }

  /**
   * Forgive some possible logical flaws in the user input.
   */
  private function forgive() {
    if ($this->node->choice_multi == 1) {
      for ($i = 0; isset($this->node->alternatives[$i]); $i++) {
        $short =& $this->node->alternatives[$i];

        // If the scoring data doesn't make sense, use the data from the
        // "correct" checkbox to set the score data.
        if ($short['score_if_chosen'] == $short['score_if_not_chosen'] || !is_numeric($short['score_if_chosen']) || !is_numeric($short['score_if_not_chosen'])) {
          if (!empty($short['correct'])) {
            $short['score_if_chosen'] = 1;
            $short['score_if_not_chosen'] = 0;
          }
          else {
            if (variable_get('multichoice_def_scoring', 0) == 0) {
              $short['score_if_chosen'] = -1;
              $short['score_if_not_chosen'] = 0;
            }
            elseif (variable_get('multichoice_def_scoring', 0) == 1) {
              $short['score_if_chosen'] = 0;
              $short['score_if_not_chosen'] = 1;
            }
          }
        }
      }
    }
    else {

      // For questions with one, and only one, correct answer, there will be
      // no points awarded for alternatives not chosen.
      for ($i = 0; isset($this->node->alternatives[$i]); $i++) {
        $short =& $this->node->alternatives[$i];
        $short['score_if_not_chosen'] = 0;
        if (isset($short['correct']) && $short['correct'] == 1 && !_quiz_is_int($short['score_if_chosen'], 1)) {
          $short['score_if_chosen'] = 1;
        }
      }
    }
  }

  /**
   * Warn the user about possible user errors.
   */
  private function warn() {

    // Count the number of correct answers.
    $num_corrects = 0;
    for ($i = 0; isset($this->node->alternatives[$i]); $i++) {
      $alt =& $this->node->alternatives[$i];
      if ($alt['score_if_chosen'] > $alt['score_if_not_chosen']) {
        $num_corrects++;
      }
    }
    if ($num_corrects == 1 && $this->node->choice_multi == 1 || $num_corrects > 1 && $this->node->choice_multi == 0) {
      $link_options = array();
      if (isset($_GET['destination'])) {
        $link_options['query'] = array(
          'destination' => $_GET['destination'],
        );
      }
      $go_back = l(t('go back'), 'quiz/' . $this->node->nid . '/edit', $link_options);
      if ($num_corrects == 1) {
        Drupal::messenger()
          ->addWarning(t("Your question allows multiple answers. Only one of the alternatives have been marked as correct. If this wasn't intended please !go_back and correct it.", array(
          '!go_back' => $go_back,
        )), 'warning');
      }
      else {
        Drupal::messenger()
          ->addWarning(t("Your question doesn't allow multiple answers. More than one of the alternatives have been marked as correct. If this wasn't intended please !go_back and correct it.", array(
          '!go_back' => $go_back,
        )), 'warning');
      }
    }
  }

  /**
   * Run check_markup() on the field of the specified choice alternative.
   *
   * @param string $alternativeIndex
   *   The index of the alternative in the alternatives array.
   * @param string $field
   *   The name of the field we want to check markup on.
   * @param bool $check_user_access
   *   Whether or not to check for user access to the filter we're trying to
   *   apply.
   *
   * @return string
   *   The filtered text.
   */
  private function checkMarkup($alternativeIndex, $field, $check_user_access = FALSE) {
    $alternative = $this->node->alternatives[$alternativeIndex];
    return check_markup($alternative[$field]['value'], $alternative[$field]['format']);
  }

  /**
   * Implementation of saveNodeProperties().
   *
   * @see QuizQuestion::saveNodeProperties()
   */
  public function saveNodeProperties($is_new = FALSE) {
    $is_new = $is_new || !empty($this->node->revision);

    // We also add warnings on other possible user errors.
    $this
      ->warn();
    if ($is_new) {
      $id = db_insert('quiz_multichoice_properties')
        ->fields(array(
        'nid' => $this->node->nid,
        'vid' => $this->node->vid,
        'choice_multi' => $this->node->choice_multi,
        'choice_random' => $this->node->choice_random,
        'choice_boolean' => $this->node->choice_boolean,
      ))
        ->execute();

      // TODO: utilize the benefit of multiple insert of DBTNG.
      for ($i = 0; isset($this->node->alternatives[$i]); $i++) {
        if (drupal_strlen($this->node->alternatives[$i]['answer']['value']) > 0) {
          $this
            ->insertAlternative($i);
        }
      }
    }
    else {
      db_update('quiz_multichoice_properties')
        ->fields(array(
        'choice_multi' => $this->node->choice_multi,
        'choice_random' => $this->node->choice_random,
        'choice_boolean' => $this->node->choice_boolean,
      ))
        ->condition('nid', $this->node->nid)
        ->condition('vid', $this->node->vid)
        ->execute();

      // We fetch ids for the existing answers belonging to this question.
      // We need to figure out if an existing alternative has been changed or
      // deleted.
      $res = db_query('SELECT id FROM {quiz_multichoice_answers}
              WHERE question_nid = :nid AND question_vid = :vid', array(
        ':nid' => $this->node->nid,
        ':vid' => $this->node->vid,
      ));

      // We start by assuming that all existing alternatives needs to be
      // deleted.
      $ids_to_delete = array();
      while ($res_o = $res
        ->fetch()) {
        $ids_to_delete[] = $res_o->id;
      }
      for ($i = 0; isset($this->node->alternatives[$i]); $i++) {
        $short = $this->node->alternatives[$i];
        if (drupal_strlen($this->node->alternatives[$i]['answer']['value']) > 0) {

          // If new alternative.
          if (!is_numeric($short['id'])) {
            $this
              ->insertAlternative($i);
          }
          else {
            $this
              ->updateAlternative($i);

            // Make sure this alternative isn't deleted.
            $key = array_search($short['id'], $ids_to_delete);
            $ids_to_delete[$key] = FALSE;
          }
        }
      }
      foreach ($ids_to_delete as $id_to_delete) {
        if ($id_to_delete) {
          db_delete('quiz_multichoice_answers')
            ->condition('id', $id_to_delete)
            ->execute();
        }
      }
    }
    $this
      ->saveUserSettings();
  }

  /**
   * Helper function. Normalizes alternatives.
   *
   * @param array $alternatives
   *
   * @return array
   */
  private function _normalizeAlternative($alternatives) {
    $copy = $alternatives;

    // Answer and answer format.
    if (is_array($alternatives['answer'])) {
      $copy['answer'] = array_key_exists('value', $alternatives['answer']) ? $alternatives['answer']['value'] : NULL;
      $copy['answer_format'] = array_key_exists('format', $alternatives['answer']) ? $alternatives['answer']['format'] : NULL;
    }

    // Feedback if chosen and feedback if chosen format.
    if (is_array($alternatives['feedback_if_chosen'])) {
      $copy['feedback_if_chosen'] = array_key_exists('value', $alternatives['feedback_if_chosen']) ? $alternatives['feedback_if_chosen']['value'] : NULL;
      $copy['feedback_if_chosen_format'] = array_key_exists('format', $alternatives['feedback_if_chosen']) ? $alternatives['feedback_if_chosen']['format'] : NULL;
    }

    // Feedback if not chosen and feedback if not chosen format.
    if (is_array($alternatives['feedback_if_not_chosen'])) {
      $copy['feedback_if_not_chosen'] = array_key_exists('value', $alternatives['feedback_if_not_chosen']) ? $alternatives['feedback_if_not_chosen']['value'] : NULL;
      $copy['feedback_if_not_chosen_format'] = array_key_exists('format', $alternatives['feedback_if_not_chosen']) ? $alternatives['feedback_if_not_chosen']['format'] : NULL;
    }
    return $copy;
  }

  /**
   * Helper function. Saves new alternatives.
   *
   * @param int $i
   *   The alternative index.
   */
  private function insertAlternative($i) {
    $alternatives = $this
      ->_normalizeAlternative($this->node->alternatives[$i]);
    db_insert('quiz_multichoice_answers')
      ->fields(array(
      'answer' => $alternatives['answer'],
      'answer_format' => $alternatives['answer_format'],
      'feedback_if_chosen' => $alternatives['feedback_if_chosen'],
      'feedback_if_chosen_format' => $alternatives['feedback_if_chosen_format'],
      'feedback_if_not_chosen' => $alternatives['feedback_if_not_chosen'],
      'feedback_if_not_chosen_format' => $alternatives['feedback_if_not_chosen_format'],
      'score_if_chosen' => $alternatives['score_if_chosen'],
      'score_if_not_chosen' => $alternatives['score_if_not_chosen'],
      'question_nid' => $this->node->nid,
      'question_vid' => $this->node->vid,
      'weight' => isset($alternatives['weight']) ? $alternatives['weight'] : $i,
    ))
      ->execute();
  }

  /**
   * Helper function. Updates existing alternatives.
   *
   * @param $i
   *  The alternative index.
   */
  private function updateAlternative($i) {
    $alternatives = $this
      ->_normalizeAlternative($this->node->alternatives[$i]);
    db_update('quiz_multichoice_answers')
      ->fields(array(
      'answer' => $alternatives['answer'],
      'answer_format' => $alternatives['answer_format'],
      'feedback_if_chosen' => $alternatives['feedback_if_chosen'],
      'feedback_if_chosen_format' => $alternatives['feedback_if_chosen_format'],
      'feedback_if_not_chosen' => $alternatives['feedback_if_not_chosen'],
      'feedback_if_not_chosen_format' => $alternatives['feedback_if_not_chosen_format'],
      'score_if_chosen' => $alternatives['score_if_chosen'],
      'score_if_not_chosen' => $alternatives['score_if_not_chosen'],
      'weight' => isset($alternatives['weight']) ? $alternatives['weight'] : $i,
    ))
      ->condition('id', $alternatives['id'])
      ->condition('question_nid', $this->node->nid)
      ->condition('question_vid', $this->node->vid)
      ->execute();
  }

  /**
   * Implementation of validateNode().
   *
   * @see QuizQuestion::validateNode()
   */
  public function validateNode(array &$form) {
    if ($this->node->choice_multi == 0) {
      $found_one_correct = FALSE;
      for ($i = 0; isset($this->node->alternatives[$i]) && is_array($this->node->alternatives[$i]); $i++) {
        $short = $this->node->alternatives[$i];
        if (drupal_strlen($this
          ->checkMarkup($i, 'answer')) < 1) {
          continue;
        }
        if ($short['correct'] == 1) {
          if ($found_one_correct) {

            // We don't display an error message here since we allow
            // alternatives to be partially correct.
          }
          else {
            $found_one_correct = TRUE;
          }
        }
      }
      if (!$found_one_correct) {
        form_set_error('choice_multi', t('You have not marked any alternatives as correct. If there are no correct alternatives you should allow multiple answers.'));
      }
    }
    else {
      for ($i = 0; isset($this->node->alternatives[$i]); $i++) {
        $short = $this->node->alternatives[$i];
        if (strlen($this
          ->checkMarkup($i, 'answer')) < 1) {
          continue;
        }
        if ($short['score_if_chosen'] < $short['score_if_not_chosen'] && $short['correct']) {
          form_set_error("alternatives][{$i}][score_if_not_chosen", t("The alternative is marked as correct, but gives more points if you don't select it."));
        }
        elseif ($short['score_if_chosen'] > $short['score_if_not_chosen'] && !$short['correct']) {
          form_set_error("alternatives][{$i}][score_if_chosen", t('The alternative is not marked as correct, but gives more points if you select it.'));
        }
      }
    }
  }

  /**
   * Implementation of delete().
   *
   * @see QuizQuestion::delete()
   */
  public function delete($only_this_version = FALSE) {
    $delete_properties = db_delete('quiz_multichoice_properties')
      ->condition('nid', $this->node->nid);
    $delete_answers = db_delete('quiz_multichoice_answers')
      ->condition('question_nid', $this->node->nid);
    if ($only_this_version) {
      $delete_properties
        ->condition('vid', $this->node->vid);
      $delete_answers
        ->condition('question_vid', $this->node->vid);
    }
    $delete_properties
      ->execute();
    $delete_answers
      ->execute();
    parent::delete($only_this_version);
  }

  /**
   * Implementation of getNodeProperties().
   *
   * @see QuizQuestion::getNodeProperties()
   */
  public function getNodeProperties() {
    if (isset($this->nodeProperties) && !empty($this->nodeProperties)) {
      return $this->nodeProperties;
    }
    $props = parent::getNodeProperties();
    $res_a = db_query('SELECT choice_multi, choice_random, choice_boolean FROM {quiz_multichoice_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);
    }

    // Load the answers.
    $res = db_query('SELECT id, answer, answer_format, feedback_if_chosen, feedback_if_chosen_format,
            feedback_if_not_chosen, feedback_if_not_chosen_format, score_if_chosen, score_if_not_chosen, weight
            FROM {quiz_multichoice_answers}
            WHERE question_nid = :question_nid AND question_vid = :question_vid
            ORDER BY weight', array(
      ':question_nid' => $this->node->nid,
      ':question_vid' => $this->node->vid,
    ));

    // Init array so it can be iterated even if empty.
    $props['alternatives'] = array();
    while ($res_arr = $res
      ->fetchAssoc()) {
      $props['alternatives'][] = array(
        'id' => $res_arr['id'],
        'answer' => array(
          'value' => $res_arr['answer'],
          'format' => $res_arr['answer_format'],
        ),
        'feedback_if_chosen' => array(
          'value' => $res_arr['feedback_if_chosen'],
          'format' => $res_arr['feedback_if_chosen_format'],
        ),
        'feedback_if_not_chosen' => array(
          'value' => $res_arr['feedback_if_not_chosen'],
          'format' => $res_arr['feedback_if_not_chosen_format'],
        ),
        'score_if_chosen' => $res_arr['score_if_chosen'],
        'score_if_not_chosen' => $res_arr['score_if_not_chosen'],
        'weight' => $res_arr['weight'],
      );
    }
    $this->nodeProperties = $props;
    return $props;
  }

  /**
   * Implementation of getNodeView().
   *
   * @see QuizQuestion::getNodeView()
   */
  public function getNodeView() {
    $content = parent::getNodeView();
    if ($this->node->choice_random) {
      $this
        ->shuffle($this->node->alternatives);
    }
    $content['answers'] = array(
      '#markup' => theme('multichoice_answer_node_view', array(
        'alternatives' => $this->node->alternatives,
        'show_correct' => $this
          ->viewCanRevealCorrect(),
      )),
      '#weight' => 2,
    );
    return $content;
  }

  /**
   * {@inheritdoc}
   */
  public function getAnsweringForm(FormStateInterface $form_state, QuizResultAnswer $quizQuestionResultAnswer) {
    $element = parent::getAnsweringForm($form_state, $quizQuestionResultAnswer);
    foreach ($this
      ->get('alternatives')
      ->referencedEntities() as $alternative) {

      /* @var $alternative Paragraph */
      $uuid = $alternative
        ->get('uuid')
        ->getString();
      $alternatives[$uuid] = $alternative;
    }

    // Build options list.
    $element['user_answer'] = [
      '#type' => 'tableselect',
      '#header' => [
        'answer' => t('Answer'),
      ],
      '#js_select' => FALSE,
      '#multiple' => $this
        ->get('choice_multi')
        ->getString(),
    ];

    // @todo see https://www.drupal.org/project/drupal/issues/2986517
    // There is some way to label the elements.
    foreach ($alternatives as $uuid => $alternative) {
      $vid = $alternative
        ->getRevisionId();
      $answer_markup = check_markup($alternative
        ->get('multichoice_answer')
        ->getValue()[0]['value'], $alternative
        ->get('multichoice_answer')
        ->getValue()[0]['format']);
      $element['user_answer']['#options'][$vid]['title']['data']['#title'] = $answer_markup;
      $element['user_answer']['#options'][$vid]['answer'] = $answer_markup;
    }
    if ($this
      ->get('choice_random')
      ->getString()) {

      // We save the choice order so that the order will be the same in the
      // answer report.
      $element['choice_order'] = array(
        '#type' => 'hidden',
        '#value' => implode(',', $this
          ->shuffle($element['user_answer']['#options'])),
      );
    }
    if ($quizQuestionResultAnswer
      ->isAnswered()) {
      $choices = $quizQuestionResultAnswer
        ->getResponse();
      if ($this
        ->get('choice_multi')
        ->getString()) {
        foreach ($choices as $choice) {
          $element['user_answer']['#default_value'][$choice] = TRUE;
        }
      }
      else {
        $element['user_answer']['#default_value'] = reset($choices);
      }
    }
    return $element;
  }

  /**
   * Custom shuffle function.
   *
   * It keeps the array key - value relationship intact.
   *
   * @param array $array
   *
   * @return array
   */
  private function shuffle(array &$array) {
    $newArray = array();
    $toReturn = array_keys($array);
    shuffle($toReturn);
    foreach ($toReturn as $key) {
      $newArray[$key] = $array[$key];
    }
    $array = $newArray;
    return $toReturn;
  }

  /**
   * Implementation of getCreationForm().
   *
   * @see QuizQuestion::getCreationForm()
   */
  public function getCreationForm(array &$form_state = NULL) {
    $form = array();
    $type = node_type_get_type($this->node);

    // We add #action to the form because of the use of ajax.
    $options = array();
    $get = $_GET;
    unset($get['q']);
    if (!empty($get)) {
      $options['query'] = $get;
    }
    $action = url('quiz/add/' . $type->type, $options);
    if (isset($this->node->nid)) {
      $action = url('quiz/' . $this->node->nid . '/edit', $options);
    }
    $form['#action'] = $action;
    drupal_add_tabledrag('multichoice-alternatives-table', 'order', 'sibling', 'multichoice-alternative-weight');
    $form['alternatives'] = array(
      '#type' => 'fieldset',
      '#title' => t('Answer'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#weight' => -4,
      '#tree' => TRUE,
    );

    // Get the nodes settings, users settings or default settings.
    $default_settings = $this
      ->getDefaultAltSettings();
    $form['alternatives']['settings'] = array(
      '#type' => 'fieldset',
      '#title' => t('Settings'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#description' => t('Your settings will be remembered.'),
      '#weight' => 30,
    );
    $form['alternatives']['settings']['choice_multi'] = array(
      '#type' => 'checkbox',
      '#title' => t('Multiple answers'),
      '#description' => t('Allow any number of answers(checkboxes are used). If this box is not checked, one, and only one answer is allowed(radiobuttons are used).'),
      '#default_value' => $default_settings['choice_multi'],
      '#parents' => array(
        'choice_multi',
      ),
    );
    $form['alternatives']['settings']['choice_random'] = array(
      '#type' => 'checkbox',
      '#title' => t('Random order'),
      '#description' => t('Present alternatives in random order when @quiz is being taken.', array(
        '@quiz' => _quiz_get_quiz_name(),
      )),
      '#default_value' => $default_settings['choice_random'],
      '#parents' => array(
        'choice_random',
      ),
    );
    $form['alternatives']['settings']['choice_boolean'] = array(
      '#type' => 'checkbox',
      '#title' => t('Simple scoring'),
      '#description' => t('Give max score if everything is correct. Zero points otherwise.'),
      '#default_value' => $default_settings['choice_boolean'],
      '#parents' => array(
        'choice_boolean',
      ),
    );
    $form['alternatives']['#theme'][] = 'multichoice_creation_form';
    $i = 0;

    // choice_count might be stored in the form_state after an ajax callback.
    if (isset($form_state['values']['op']) && $form_state['values']['op'] == t('Add choice')) {
      $form_state['choice_count']++;
    }
    else {
      $form_state['choice_count'] = max(variable_get('multichoice_def_num_of_alts', 2), isset($this->node->alternatives) ? count($this->node->alternatives) : 0);
    }
    $form['alternatives']['#prefix'] = '<div class="clear-block" id="multichoice-alternatives-wrapper">';
    $form['alternatives']['#suffix'] = '</div>';
    $form['alternatives']['#theme'] = array(
      'multichoice_alternative_creation_table',
    );
    for ($i = 0; $i < $form_state['choice_count']; $i++) {
      $short = isset($this->node->alternatives[$i]) ? $this->node->alternatives[$i] : NULL;
      $form['alternatives'][$i] = array(
        '#type' => 'container',
        '#collapsible' => TRUE,
        '#collapsed' => FALSE,
      );
      if (is_array($short)) {
        if ($short['score_if_chosen'] == $short['score_if_not_chosen']) {
          $correct_default = isset($short['correct']) ? $short['correct'] : FALSE;
        }
        else {
          $correct_default = $short['score_if_chosen'] > $short['score_if_not_chosen'];
        }
      }
      else {
        $correct_default = FALSE;
      }
      $form['alternatives'][$i]['correct'] = array(
        '#type' => 'checkbox',
        '#title' => t('Correct'),
        '#default_value' => $correct_default,
        '#attributes' => array(
          'onchange' => 'Multichoice.refreshScores(this, ' . variable_get('multichoice_def_scoring', 0) . ')',
        ),
      );

      // We add id to be able to update the correct alternatives if the node
      // is updated, without destroying existing answer reports.
      $form['alternatives'][$i]['id'] = array(
        '#type' => 'value',
        '#value' => $short['id'],
      );
      $form['alternatives'][$i]['answer'] = array(
        '#type' => 'text_format',
        '#default_value' => $short['answer']['value'],
        '#required' => $i < 2,
        '#format' => isset($short['answer']['format']) ? $short['answer']['format'] : NULL,
        '#rows' => 3,
      );
      $form['alternatives'][$i]['advanced'] = array(
        '#type' => 'fieldset',
        '#title' => t('Advanced options'),
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
      );
      $form['alternatives'][$i]['advanced']['feedback_if_chosen'] = array(
        '#type' => 'text_format',
        '#title' => t('Feedback if chosen'),
        '#description' => t('This feedback is given to users who chooses this alternative.'),
        '#parents' => array(
          'alternatives',
          $i,
          'feedback_if_chosen',
        ),
        '#default_value' => $short['feedback_if_chosen']['value'],
        '#format' => isset($short['feedback_if_chosen']['format']) ? $short['feedback_if_chosen']['format'] : NULL,
        '#rows' => 3,
      );

      // We add 'helper' to trick the current version of the wysiwyg module to
      // add an editor to several textareas in the same fieldset.
      $form['alternatives'][$i]['advanced']['helper']['feedback_if_not_chosen'] = array(
        '#type' => 'text_format',
        '#title' => t('Feedback if not chosen'),
        '#description' => t("This feedback is given to users who doesn't choose this alternative."),
        '#parents' => array(
          'alternatives',
          $i,
          'feedback_if_not_chosen',
        ),
        '#default_value' => $short['feedback_if_not_chosen']['value'],
        '#format' => isset($short['feedback_if_not_chosen']['format']) ? $short['feedback_if_not_chosen']['format'] : NULL,
        '#rows' => 3,
      );
      $default_value = isset($this->node->alternatives[$i]['score_if_chosen']) ? $this->node->alternatives[$i]['score_if_chosen'] : 0;
      $form['alternatives'][$i]['advanced']['score_if_chosen'] = array(
        '#type' => 'textfield',
        '#title' => t('Score if chosen'),
        '#size' => 4,
        '#default_value' => $default_value,
        '#description' => t("This score is added to the user's total score if the user chooses this alternative."),
        '#attributes' => array(
          'onkeypress' => 'Multichoice.refreshCorrect(this)',
          'onkeyup' => 'Multichoice.refreshCorrect(this)',
          'onchange' => 'Multichoice.refreshCorrect(this)',
        ),
        '#parents' => array(
          'alternatives',
          $i,
          'score_if_chosen',
        ),
      );
      $default_value = $short['score_if_not_chosen'];
      if (!isset($default_value)) {
        $default_value = '0';
      }
      $form['alternatives'][$i]['advanced']['score_if_not_chosen'] = array(
        '#type' => 'textfield',
        '#title' => t('Score if not chosen'),
        '#size' => 4,
        '#default_value' => $default_value,
        '#description' => t("This score is added to the user's total score if the user doesn't choose this alternative. Only used if multiple answers are allowed."),
        '#attributes' => array(
          'onkeypress' => 'Multichoice.refreshCorrect(this)',
          'onkeyup' => 'Multichoice.refreshCorrect(this)',
          'onchange' => 'Multichoice.refreshCorrect(this)',
        ),
        '#parents' => array(
          'alternatives',
          $i,
          'score_if_not_chosen',
        ),
      );
      $form['alternatives'][$i]['weight'] = array(
        '#type' => 'textfield',
        '#size' => 2,
        '#attributes' => array(
          'class' => array(
            'multichoice-alternative-weight',
          ),
        ),
        '#default_value' => isset($this->node->alternatives[$i]['weight']) ? $this->node->alternatives[$i]['weight'] : $i,
      );

      // Add remove button.
      $form['alternatives'][$i]['remove_button'] = array(
        '#delta' => $i,
        '#name' => 'alternatives__' . $i . '__remove_button',
        '#type' => 'submit',
        '#value' => t('Remove'),
        '#validate' => array(),
        '#submit' => array(
          'multichoice_remove_alternative_submit',
        ),
        '#limit_validation_errors' => array(),
        '#ajax' => array(
          'callback' => 'multichoice_remove_alternative_ajax_callback',
          'effect' => 'fade',
          'wrapper' => 'multichoice-alternatives-wrapper',
        ),
        '#weight' => 1000,
      );
    }
    $form['alternatives']['multichoice_add_alternative'] = array(
      '#type' => 'button',
      '#value' => t('Add choice'),
      '#ajax' => array(
        'method' => 'replace',
        'wrapper' => 'multichoice-alternatives-wrapper',
        'callback' => 'multichoice_add_alternative_ajax_callback',
      ),
      '#weight' => 20,
      '#limit_validation_errors' => array(),
    );

    //$form['#attached']['js'] = array(

    // @todo not allowed

    //drupal_get_path('module', 'multichoice') . '/multichoice.js',

    //);
    return $form;
  }

  /**
   * Helper function providing the default settings for the creation form.
   *
   * @return array
   *   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_multi'] = $this->node->choice_multi;
      $settings['choice_random'] = $this->node->choice_random;
      $settings['choice_boolean'] = $this->node->choice_boolean;
    }
    elseif ($settings = $this
      ->getUserSettings()) {
    }
    else {
      $settings['choice_multi'] = 0;
      $settings['choice_random'] = 0;
      $settings['choice_boolean'] = 0;
    }
    return $settings;
  }

  /**
   * Fetches the users default settings for the creation form.
   *
   * @return array|false
   *   The users default node settings or FALSE if nothing found.
   */
  private function getUserSettings() {
    $user = \Drupal::currentUser();
    $res = db_query('SELECT choice_multi, choice_boolean, choice_random
            FROM {quiz_multichoice_user_settings}
            WHERE uid = :uid', array(
      ':uid' => $user
        ->id(),
    ))
      ->fetchAssoc();
    if ($res) {
      return $res;
    }
    else {
      return FALSE;
    }
  }

  /**
   * Save the users default settings to the database.
   */
  private function saveUserSettings() {
    $user = \Drupal::currentUser();
    db_merge('quiz_multichoice_user_settings')
      ->key(array(
      'uid' => $user
        ->id(),
    ))
      ->fields(array(
      'choice_random' => $this->node->choice_random,
      'choice_multi' => $this->node->choice_multi,
      'choice_boolean' => $this->node->choice_boolean,
    ))
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function getMaximumScore() {
    if ($this
      ->get('choice_boolean')
      ->getString()) {

      // Simple scoring - can only be worth 1 point.
      return 1;
    }
    $maxes = [
      0,
    ];
    foreach ($this
      ->get('alternatives')
      ->referencedEntities() as $alternative) {

      // "Not chosen" could have a positive point amount.
      $maxes[] = max($alternative
        ->get('multichoice_score_chosen')
        ->getString(), $alternative
        ->get('multichoice_score_not_chosen')
        ->getString());
    }
    if ($this
      ->get('choice_multi')
      ->getString()) {

      // For multiple answers, return the maximum possible points of all
      // positively pointed answers.
      return array_sum($maxes);
    }
    else {

      // For a single answer, return the highest pointed amount.
      return max($maxes);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function getAnsweringFormValidate(array &$element, FormStateInterface $form_state) {
    $mcq = $form_state
      ->getBuildInfo()['args'][0];
    if (!$mcq
      ->get('choice_multi')
      ->getString() && empty($element['user_answer']['#value'])) {
      $form_state
        ->setError($element, t('You must provide an answer.'));
    }
    parent::getAnsweringFormValidate($element, $form_state);
  }

}
Classes

Name	Description
MultichoiceQuestion	@QuizQuestion ( id = "multichoice", label = Plugin annotation @Translation("Multiple choice question"), handlers = { "response" = "\Drupal\quiz_multichoice\Plugin\quiz\QuizQuestion\MultichoiceResponse" } )
You are here

MultichoiceQuestion.php in Quiz 8.6

Namespace

File

Classes

API Navigation
