chamilo-lms2/main/exercise/unique_answer.class.php

<?php
/* For licensing terms, see /license.txt */

use \ChamiloSession as Session;

/**
 * Class UniqueAnswer
 *
 * This class allows to instantiate an object of type UNIQUE_ANSWER
 * (MULTIPLE CHOICE, UNIQUE ANSWER),
 * extending the class question
 *
 * @author Eric Marguin
 * @author Julio Montoya
 * @package chamilo.exercise
 **/
class UniqueAnswer extends Question
{
    static $typePicture = 'mcua.png';
    static $explanationLangVar = 'UniqueSelect';

    /**
     * Constructor
     */
    public function __construct()
    {
        //this is highly important
        parent::__construct();
        $this->type = UNIQUE_ANSWER;
        $this->isContent = $this->getIsContent();
    }

    /**
     * function which redefines Question::createAnswersForm
     * @param FormValidator $form
     */
    public function createAnswersForm($form)
    {
        // Getting the exercise list
        $obj_ex = Session::read('objExercise');

        $editor_config = array(
            'FullPage' => true,
            'ToolbarSet' => 'TestProposedAnswer',
            'Width' => '100%',
            'Height' => '125'
        );

        //this line defines how many questions by default appear when creating a choice question
        // The previous default value was 2. See task #1759.
        $nb_answers = isset($_POST['nb_answers']) ? (int) $_POST['nb_answers'] : 4;
        $nb_answers += (isset($_POST['lessAnswers']) ? -1 : (isset($_POST['moreAnswers']) ? 1 : 0));

        /*
          Types of Feedback
          $feedback_option[0]=get_lang('Feedback');
          $feedback_option[1]=get_lang('DirectFeedback');
          $feedback_option[2]=get_lang('NoFeedback');
         */

        $feedback_title = '';

        if ($obj_ex->selectFeedbackType() == EXERCISE_FEEDBACK_TYPE_DIRECT) {
            //Scenario
            $comment_title = '<th width="20%">' . get_lang('Comment') . '</th>';
            $feedback_title = '<th width="20%">' . get_lang('Scenario') . '</th>';
        } else {
            $comment_title = '<th width="40%">' . get_lang('Comment') . '</th>';
        }

        $html = '<table class="table table-striped table-hover">
            <thead>
                <tr style="text-align: center;">
                    <th width="5%">' . get_lang('Number') . '</th>
                    <th width="5%"> ' . get_lang('True') . '</th>
                    <th width="40%">' . get_lang('Answer') . '</th>
                        ' . $comment_title . '
                        ' . $feedback_title . '
                    <th width="10%">' . get_lang('Weighting') . '</th>
                </tr>
            </thead>
            <tbody>';

        $form->addHeader(get_lang('Answers'));
        $form->addHtml($html);

        $defaults = array();
        $correct = 0;
        if (!empty($this->id)) {
            $answer = new Answer($this->id);
            $answer->read();
            if (count($answer->nbrAnswers) > 0 && !$form->isSubmitted()) {
                $nb_answers = $answer->nbrAnswers;
            }
        }
        $form->addElement('hidden', 'nb_answers');

        //Feedback SELECT
        $question_list = $obj_ex->selectQuestionList();
        $select_question = array();
        $select_question[0] = get_lang('SelectTargetQuestion');
        if (is_array($question_list)) {
            foreach ($question_list as $key => $questionid) {
                //To avoid warning messages
                if (!is_numeric($questionid)) {
                    continue;
                }
                $question = Question::read($questionid);
                $select_question[$questionid] = 'Q' . $key . ' :' . cut(
                    $question->selectTitle(), 20
                );
            }
        }
        $select_question[-1] = get_lang('ExitTest');

        $list = new LearnpathList(api_get_user_id());
        $flat_list = $list->get_flat_list();
        $select_lp_id = array();
        $select_lp_id[0] = get_lang('SelectTargetLP');

        foreach ($flat_list as $id => $details) {
            $select_lp_id[$id] = cut($details['lp_name'], 20);
        }

        $temp_scenario = array();

        if ($nb_answers < 1) {
            $nb_answers = 1;
            Display::display_normal_message(
                get_lang('YouHaveToCreateAtLeastOneAnswer')
            );
        }

        for ($i = 1; $i <= $nb_answers; ++$i) {
            $form->addHtml('<tr>');
            if (isset($answer) && is_object($answer)) {
                if ($answer->correct[$i]) {
                    $correct = $i;
                }
                $defaults['answer[' . $i . ']'] = $answer->answer[$i];
                $defaults['comment[' . $i . ']'] = $answer->comment[$i];
                $defaults['weighting[' . $i . ']'] = float_format(
                    $answer->weighting[$i],
                    1
                );

                $item_list = explode('@@', $answer->destination[$i]);

                $try = isset($item_list[0]) ? $item_list[0] : '';
                $lp = isset($item_list[1]) ? $item_list[1] : '';
                $list_dest = isset($item_list[2]) ? $item_list[2] : '';
                $url = isset($item_list[3]) ? $item_list[3] : '';

                if ($try == 0) {
                    $try_result = 0;
                } else {
                    $try_result = 1;
                }
                if ($url == 0) {
                    $url_result = '';
                } else {
                    $url_result = $url;
                }

                $temp_scenario['url' . $i] = $url_result;
                $temp_scenario['try' . $i] = $try_result;
                $temp_scenario['lp' . $i] = $lp;
                $temp_scenario['destination' . $i] = $list_dest;
            } else {
                $defaults['answer[1]'] = get_lang('DefaultUniqueAnswer1');
                $defaults['weighting[1]'] = 10;
                $defaults['answer[2]'] = get_lang('DefaultUniqueAnswer2');
                $defaults['weighting[2]'] = 0;

                $temp_scenario['destination' . $i] = array('0');
                $temp_scenario['lp' . $i] = array('0');
            }
            $defaults['scenario'] = $temp_scenario;

            $renderer = $form->defaultRenderer();

            $renderer->setElementTemplate(
                '<td><!-- BEGIN error --><span class="form_error">{error}</span><!-- END error --><br/>{element}</td>',
                'correct'
            );
            $renderer->setElementTemplate(
                '<td><!-- BEGIN error --><span class="form_error">{error}</span><!-- END error --><br/>{element}</td>',
                'counter[' . $i . ']'
            );
            $renderer->setElementTemplate(
                '<td><!-- BEGIN error --><span class="form_error">{error}</span><!-- END error --><br/>{element}</td>',
                'answer[' . $i . ']'
            );
            $renderer->setElementTemplate(
                '<td><!-- BEGIN error --><span class="form_error">{error}</span><!-- END error --><br/>{element}</td>',
                'comment[' . $i . ']'
            );
            $renderer->setElementTemplate(
                '<td><!-- BEGIN error --><span class="form_error">{error}</span><!-- END error --><br/>{element}</td>',
                'weighting[' . $i . ']'
            );

            $answer_number = $form->addElement(
                'text', 'counter[' . $i . ']', null, ' value = "' . $i . '"'
            );
            $answer_number->freeze();
            $form->addElement(
                'radio', 'correct', null, null, $i, 'class="checkbox"'
            );

            $form->addHtmlEditor('answer[' . $i . ']', null, null, true, $editor_config);

            $form->addRule(
                'answer[' . $i . ']', get_lang('ThisFieldIsRequired'), 'required'
            );

            if ($obj_ex->selectFeedbackType() == EXERCISE_FEEDBACK_TYPE_DIRECT) {
                $form->addHtmlEditor('comment[' . $i . ']', null, null, false, $editor_config);
                // Direct feedback
                //Adding extra feedback fields
                $group = array();
                $group['try' . $i] = $form->createElement(
                    'checkbox',
                    'try' . $i,
                    null,
                    get_lang('TryAgain')
                );
                $group['lp' . $i] = $form->createElement(
                    'select',
                    'lp' . $i,
                    get_lang('SeeTheory') . ': ',
                    $select_lp_id
                );
                $group['destination' . $i] = $form->createElement(
                    'select',
                    'destination' . $i,
                    get_lang('GoToQuestion') . ': ',
                    $select_question
                );
                $group['url' . $i] = $form->createElement(
                    'text',
                    'url' . $i,
                    get_lang('Other') . ': ',
                    array(
                        'class' => 'col-md-2',
                        'placeholder' => get_lang('Other')
                    )
                );
                $form->addGroup($group, 'scenario');

                $renderer->setElementTemplate(
                    '<td><!-- BEGIN error --><span class="form_error">{error}</span><!-- END error --><br/>{element}',
                    'scenario'
                );
            } else {
                $form->addHtmlEditor('comment[' . $i . ']', null, null, false, $editor_config);
            }
            $form->addText('weighting[' . $i . ']', null, null, array('value' => '0'));
            $form->addHtml('</tr>');
        }

        $form->addHtml('</tbody>');
        $form->addHtml('</table>');

        global $text;

        $buttonGroup = [];
        //ie6 fix
        if ($obj_ex->edit_exercise_in_lp == true) {

            //setting the save button here and not in the question class.php
            $buttonGroup[] = $form->addButtonDelete(get_lang('LessAnswer'), 'lessAnswers', true);
            $buttonGroup[] = $form->addButtonCreate(get_lang('PlusAnswer'), 'moreAnswers', true);
            $buttonGroup[] = $form->addButtonSave($text, 'submitQuestion', true);

            $form->addGroup($buttonGroup);
        }

        // We check the first radio button to be sure a radio button will be check
        if ($correct == 0) {
            $correct = 1;
        }

        $defaults['correct'] = $correct;

        if (!empty($this->id)) {
            $form->setDefaults($defaults);
        } else {
            if ($this->isContent == 1) {
                // Default sample content.
                $form->setDefaults($defaults);
            } else {
                $form->setDefaults(array('correct' => 1));
            }
        }
        $form->setConstants(array('nb_answers' => $nb_answers));
    }

    /**
     * Receives the unique answer question type creation form data and creates
     * or updates the answers from that question
     * @param FormValidator $form
     */
    public function processAnswersCreation($form)
    {
        $questionWeighting = $nbrGoodAnswers = 0;
        $correct = $form->getSubmitValue('correct');
        $objAnswer = new Answer($this->id);
        $nb_answers = $form->getSubmitValue('nb_answers');

        for ($i = 1; $i <= $nb_answers; $i++) {
            $answer = trim($form->getSubmitValue('answer[' . $i . ']'));
            $comment = trim($form->getSubmitValue('comment[' . $i . ']'));
            $weighting = trim($form->getSubmitValue('weighting[' . $i . ']'));

            $scenario = $form->getSubmitValue('scenario');

            //$list_destination = $form -> getSubmitValue('destination'.$i);
            //$destination_str = $form -> getSubmitValue('destination'.$i);

            $try = $scenario['try' . $i];
            $lp = $scenario['lp' . $i];
            $destination = $scenario['destination' . $i];
            $url = trim($scenario['url' . $i]);

            /*
            How we are going to parse the destination value

           here we parse the destination value which is a string
            1@@3@@2;4;4;@@http://www.chamilo.org

            where: try_again@@lp_id@@selected_questions@@url

           try_again = is 1 || 0
           lp_id = id of a learning path (0 if dont select)
           selected_questions= ids of questions
           url= an url

            $destination_str='';
            foreach ($list_destination as $destination_id)
            {
                $destination_str.=$destination_id.';';
            }*/

            $goodAnswer = ($correct == $i) ? true : false;

            if ($goodAnswer) {
                $nbrGoodAnswers++;
                $weighting = abs($weighting);
                if ($weighting > 0) {
                    $questionWeighting += $weighting;
                }
            }

            if (empty($try)) {
                $try = 0;
            }

            if (empty($lp)) {
                $lp = 0;
            }

            if (empty($destination)) {
                $destination = 0;
            }

            if ($url == '') {
                $url = 0;
            }

            //1@@1;2;@@2;4;4;@@http://www.chamilo.org
            $dest = $try . '@@' . $lp . '@@' . $destination . '@@' . $url;
            $objAnswer->createAnswer(
                $answer,
                $goodAnswer,
                $comment,
                $weighting,
                $i,
                null,
                null,
                $dest
            );
        }

        // saves the answers into the data base
        $objAnswer->save();

        // sets the total weighting of the question
        $this->updateWeighting($questionWeighting);
        $this->save();
    }

    /**
     * Helper function to print the column titles in the answers edition form
     * @param null $feedback_type The type of feedback influences what columns are shown to the editor
     * @param null $counter The number of answers to show, in case there should be pagination
     * @param null $score The maximum score for the question
     * @return string HTML string for a table header + a wrapper before it
     */
    public function return_header(
        $feedback_type = null,
        $counter = null,
        $score = null
    ) {
        $header = parent::return_header($feedback_type, $counter, $score);
        $header .= '<table class="' . $this->question_table_class . '">
			<tr>
				<th>' . get_lang("Choice") . '</th>
				<th>' . get_lang("ExpectedChoice") . '</th>
				<th>' . get_lang("Answer") . '</th>';
        $header .= '<th>' . get_lang("Comment") . '</th>';
        $header .= '</tr>';

        return $header;
    }

    /**
     * Saves one answer to the database
     * @param int $id   The ID of the answer (has to be calculated for this course)
     * @param int $question_id  The question ID (to which the answer is attached)
     * @param string $title The text of the answer
     * @param string $comment The feedback for the answer
     * @param float|null $score  The score you get when picking this answer
     * @param int|null $correct  Whether this answer is considered *the* correct one (this is the unique answer type)
     */
    public function addAnswer(
        $id,
        $question_id,
        $title,
        $comment,
        $score = 0.0,
        $correct = 0
    ) {
        $tbl_quiz_answer = Database::get_course_table(TABLE_QUIZ_ANSWER);
        $tbl_quiz_question = Database::get_course_table(TABLE_QUIZ_QUESTION);
        $course_id = api_get_course_int_id();
        $question_id = intval($question_id);
        $score = floatval($score);
        $correct = intval($correct);
        $title = Database::escape_string($title);
        $comment = Database::escape_string($comment);
        // Get the max position.
        $sql = "SELECT max(position) as max_position
                FROM $tbl_quiz_answer
                WHERE
                  c_id = $course_id AND
                  question_id = $question_id";
        $rs_max = Database::query($sql);
        $row_max = Database::fetch_object($rs_max);
        $position = $row_max->max_position + 1;

        // Insert a new answer
       $params = [
            'c_id' => $course_id,
            'id' => $id,
            'question_id' => $question_id,
            'answer' => $title,
            'correct' => $correct,
            'comment' => $comment,
            'ponderation' => $score,
            'position' => $position,
            'destination' => '0@@0@@0@@0',
        ];

        $id = Database::insert($tbl_quiz_answer, $params);

        if ($id) {
            $sql = "UPDATE $tbl_quiz_answer SET id = iid WHERE iid = $id";
            Database::query($sql);
        }

        if ($correct) {
            $sql = "UPDATE $tbl_quiz_question
                    SET ponderation = (ponderation + $score)
                    WHERE c_id = $course_id AND id = " . $question_id;
            Database::query($sql);
        }
    }
}