survey_question::renderForm() - Code Metrics - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

survey_question::renderForm() A
last analyzed 2025-06-17 20:49 UTC

↳ Parent: survey_question

Complexity

Conditions	6
Paths	5

Size

Total Lines	30
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	12
nc	5
nop	0
dl	0
loc	30
rs	9.2222
c	0
b	0
f	0

<?php

/* For licensing terms, see /license.txt */

use ChamiloSession as Session;

/**
 * Class survey_question.
 */
class survey_question
{
    public $buttonList = [];
    /** @var FormValidator */
    private $form;

    /**
     * @param array $surveyData
     */
    public function addParentMenu($formData, FormValidator $form, $surveyData)
    {
        $surveyId = $surveyData['survey_id'];
        $questionId = isset($formData['question_id']) ? $formData['question_id'] : 0;
        $parentId = isset($formData['parent_id']) ? $formData['parent_id'] : 0;
        $optionId = isset($formData['parent_option_id']) ? $formData['parent_option_id'] : 0;
        $questions = SurveyManager::get_questions($surveyId);

        $newQuestionList = [];
        $allowTypes = ['yesno', 'multiplechoice', 'multipleresponse'];
        foreach ($questions as $question) {
            if (in_array($question['type'], $allowTypes)) {
                $newQuestionList[$question['sort']] = $question;
            }
        }
        ksort($newQuestionList);

        $options = [];
        foreach ($newQuestionList as $question) {
            if (!empty($questionId)) {
                if ($question['question_id'] == $questionId) {
                    break;
                }
            }
            $options[$question['question_id']] = strip_tags($question['question']);
        }
        $form->addSelect(
            'parent_id',
            get_lang('Parent'),
            $options,
            ['id' => 'parent_id', 'placeholder' => get_lang('SelectAnOption')]
        );
        $url = api_get_path(WEB_AJAX_PATH).
            'survey.ajax.php?'.api_get_cidreq().'&a=load_question_options&survey_id='.$surveyId;
        $form->addHtml('
            <script>
                $(function() {
                    $("#parent_id").on("change", function() {
                        var questionId = $(this).val()
                        var $select = $("#parent_option_id");
                        $select.empty();

                        if (questionId === "") {
                              $("#option_list").hide();
                        } else {
                            $.getJSON({
                                url: "'.$url.'" + "&question_id=" + questionId,
                                success: function(data) {
                                    $("#option_list").show();
                                    $.each(data, function(key, value) {
                                        $("<option>").val(key).text(value).appendTo($select);
                                    });
                                }
                            });
                        }
                    });
                });
            </script>
        ');

        $style = 'display:none';
        $options = [];
        if (!empty($optionId) && !empty($parentId)) {
            $parentData = SurveyManager::get_question($parentId);
            $style = '';
            foreach ($parentData['answer_data'] as $answer) {
                $options[$answer['iid']] = strip_tags($answer['data']);
            }
        }

        $form->addHtml('<div id="option_list" style="'.$style.'">');
        $form->addSelect(
            'parent_option_id',
            get_lang('Option'),
            $options,
            ['id' => 'parent_option_id', 'disable_js' => true]
        );
        $form->addHtml('</div>');
    }

    /**
     * @param string $type
     *
     * @return survey_question
     */
    public static function createQuestion($type)
    {
        switch ($type) {
            case 'comment':
                return new ch_comment();
            case 'dropdown':
                return new ch_dropdown();
            case 'multiplechoice':
                return new ch_multiplechoice();
            case 'multipleresponse':
                return new ch_multipleresponse();
            case 'open':
                return new ch_open();
            case 'pagebreak':
                return new ch_pagebreak();
            case 'percentage':
                return new ch_percentage();
            case 'personality':
                return new ch_personality();
            case 'score':
                return new ch_score();
            case 'yesno':
                return new ch_yesno();
            case 'selectivedisplay':
                return new ch_selectivedisplay();
            case 'multiplechoiceother':
                return new ch_multiplechoiceother();
            default:
                api_not_allowed(true);
                break;
        }
    }

    /**
     * Generic part of any survey question: the question field.
     *
     * @param array $surveyData
     * @param array $formData
     *
     * @return FormValidator
     */
    public function createForm($surveyData, $formData)
    {
        $action = isset($_GET['action']) ? Security::remove_XSS($_GET['action']) : null;
        $questionId = isset($_GET['question_id']) ? (int) $_GET['question_id'] : null;
        $surveyId = isset($_GET['survey_id']) ? (int) $_GET['survey_id'] : null;
        $type = isset($_GET['type']) ? Security::remove_XSS($_GET['type']) : null;

        $actionHeader = get_lang('EditQuestion').': ';
        if ($action === 'add') {
            $actionHeader = get_lang('AddQuestion').': ';
        }

        $questionComment = '';
        $allowParent = false;
        switch ($type) {
            case 'open':
                $toolName = get_lang('Open');
                $questionComment = get_lang('QuestionTags');
                $allowParent = true;
                break;
            case 'yesno':
                $toolName = get_lang('YesNo');
                $allowParent = true;
                break;
            case 'multiplechoice':
                $toolName = get_lang('UniqueSelect');
                $allowParent = true;
                break;
            case 'multipleresponse':
                $toolName = get_lang('MultipleResponse');
                $allowParent = true;
                break;
            case 'selectivedisplay':
                $toolName = get_lang('SurveyQuestionSelectiveDisplay');
                $questionComment = get_lang('SurveyQuestionSelectiveDisplayComment');
                $allowParent = true;
                break;
            case 'multiplechoiceother':
                $toolName = get_lang('SurveyQuestionMultipleChoiceWithOther');
                $questionComment = get_lang('SurveyQuestionMultipleChoiceWithOtherComment');
                $allowParent = true;
                break;
            case 'pagebreak':
                $toolName = get_lang(api_ucfirst($type));
                $allowParent = false;
                break;
            default:
                $toolName = get_lang(api_ucfirst($type));
                $allowParent = true;
                break;
        }

        if (false === api_get_configuration_value('survey_question_dependency')) {
            $allowParent = false;
        }

        $icon = Display::return_icon(
                SurveyManager::icon_question($type),
                $toolName,
                ['align' => 'middle', 'height' => '22px']
            ).' ';

        $toolName = $icon.$actionHeader.$toolName;
        $sharedQuestionId = isset($formData['shared_question_id']) ? $formData['shared_question_id'] : null;

        $url = api_get_self().'?action='.$action.'&type='.$type.'&survey_id='.$surveyId.'&question_id='.$questionId.'&'.api_get_cidreq();
        $form = new FormValidator('question_form', 'post', $url);
        $form->addHeader($toolName);
        if (!empty($questionComment)) {
            $form->addHtml(Display::return_message($questionComment, 'info', false));
        }
        $form->addHidden('survey_id', $surveyId);
        $form->addHidden('question_id', $questionId);
        $form->addHidden('shared_question_id', Security::remove_XSS($sharedQuestionId));
        $form->addHidden('type', $type);

        $config = [
            'ToolbarSet' => 'SurveyQuestion',
            'Width' => '100%',
            'Height' => '120',
        ];
        $form->addHtmlEditor(
            'question',
            get_lang('Question'),
            true,
            false,
            $config
        );

        if (api_get_configuration_value('allow_required_survey_questions') &&
            in_array($_GET['type'], ['yesno', 'multiplechoice'])) {
            $form->addCheckBox('is_required', get_lang('IsMandatory'), get_lang('Yes'));
        }

        if ($allowParent) {
            $this->addParentMenu($formData, $form, $surveyData);
        }

        if (1 == $surveyData['survey_type']) {
            $table_survey_question_group = Database::get_course_table(TABLE_SURVEY_QUESTION_GROUP);
            $sql = 'SELECT id, name FROM '.$table_survey_question_group.'
                    WHERE survey_id = '.$surveyId.'
                    ORDER BY name';
            $rs = Database::query($sql);
            $glist = null;
            while ($row = Database::fetch_array($rs, 'NUM')) {
                $glist .= '<option value="'.$row[0].'" >'.$row[1].'</option>';
            }

            $grouplist = $grouplist1 = $grouplist2 = $glist;
            if (!empty($formData['assigned'])) {
                $grouplist = str_replace(
                    '<option value="'.$formData['assigned'].'"',
                    '<option value="'.$formData['assigned'].'" selected',
                    $glist
                );
            }

            if (!empty($formData['assigned1'])) {
                $grouplist1 = str_replace(
                    '<option value="'.$formData['assigned1'].'"',
                    '<option value="'.$formData['assigned1'].'" selected',
                    $glist
                );
            }

            if (!empty($formData['assigned2'])) {
                $grouplist2 = str_replace(
                    '<option value="'.$formData['assigned2'].'"',
                    '<option value="'.$formData['assigned2'].'" selected',
                    $glist
                );
            }

            $this->html .= '<tr><td colspan="">

			<fieldset style="border:1px solid black">
			    <legend>'.get_lang('Condition').'</legend>
			    <b>'.get_lang('Primary').'</b><br />
			    <input type="radio" name="choose" value="1" '.(($formData['choose'] == 1) ? 'checked' : '').'>
			    <select name="assigned">'.$grouplist.'</select><br />';
            $this->html .= '
			<b>'.get_lang('Secondary').'</b><br />
			    <input type="radio" name="choose" value="2" '.(($formData['choose'] == 2) ? 'checked' : '').'>
			    <select name="assigned1">'.$grouplist1.'</select>
                <select name="assigned2">'.$grouplist2.'</select>
            </fieldset><br />';
        }

        $this->setForm($form);

        return $form;
    }

    /**
     * Adds submit button.
     */
    public function renderForm()
    {
        if (isset($_GET['question_id']) && !empty($_GET['question_id'])) {
            /**
             * Prevent the edition of already-answered questions to avoid
             * inconsistent answers. Use the configuration option
             * survey_allow_answered_question_edit to change this behaviour.
             */
            $surveyId = isset($_GET['survey_id']) ? (int) $_GET['survey_id'] : 0;
            $answersChecker = SurveyUtil::checkIfSurveyHasAnswers($surveyId);
            $allowQuestionEdit = api_get_configuration_value('survey_allow_answered_question_edit') == true;
            if ($allowQuestionEdit or !$answersChecker) {
                $this->buttonList[] = $this->getForm()->addButtonUpdate(get_lang('ModifyQuestionSurvey'), 'save', true);
            } else {
                $this->getForm()->addHtml('
                    <div class="form-group">
                        <label class="col-sm-2 control-label"></label>
                        <div class="col-sm-8">
                            <div class="alert alert-info">'.
                            get_lang('YouCantNotEditThisQuestionBecauseAlreadyExistAnswers').'</div>
                        </div>
                        <div class="col-sm-2"></div>
                    </div>
                ');
            }
        } else {
            $this->buttonList[] = $this->getForm()->addButtonSave(get_lang('CreateQuestionSurvey'), 'save', true);
        }

        $this->getForm()->addGroup($this->buttonList, 'buttons');
    }

    /**
     * @return FormValidator
     */
    public function getForm()
    {
        return $this->form;
    }

    /**
     * @param FormValidator $form
     */
    public function setForm($form)
    {
        $this->form = $form;
    }

    /**
     * @param array $formData
     *
     * @return mixed
     */
    public function preSave($formData)
    {
        $counter = Session::read('answer_count');
        $answerList = Session::read('answer_list');

        if (empty($answerList)) {
            $answerList = isset($formData['answers']) ? $formData['answers'] : [];
            Session::write('answer_list', $answerList);
        }

        if (isset($_POST['answers'])) {
            $formData['answers'] = $_POST['answers'];
        }

        if (empty($counter)) {
            $counter = count($answerList) - 1;
            Session::write('answer_count', $counter);
        }

        // Moving an answer up
        if (isset($_POST['move_up']) && $_POST['move_up']) {
            foreach ($_POST['move_up'] as $key => &$value) {
                $id1 = $key;
                $content1 = $formData['answers'][$id1];
                $id2 = $key - 1;
                $content2 = $formData['answers'][$id2];
                $formData['answers'][$id1] = $content2;
                $formData['answers'][$id2] = $content1;
            }
        }

        // Moving an answer down
        if (isset($_POST['move_down']) && $_POST['move_down']) {
            foreach ($_POST['move_down'] as $key => &$value) {
                $id1 = $key;
                $content1 = $formData['answers'][$id1];
                $id2 = $key + 1;
                $content2 = $formData['answers'][$id2];
                $formData['answers'][$id1] = $content2;
                $formData['answers'][$id2] = $content1;
            }
        }

        /**
         * Deleting a specific answer is only saved in the session until the
         * "Save question" button is pressed. This means all options are kept
         * in the survey_question_option table until the question is saved.
         */
        if (isset($_POST['delete_answer'])) {
            $deleted = false;
            foreach ($_POST['delete_answer'] as $key => &$value) {
                $deleted = $key;
                $counter--;
                Session::write('answer_count', $counter);
            }

            $newAnswers = [];
            $newAnswersId = [];
            foreach ($formData['answers'] as $key => &$value) {
                if ($key > $deleted) {
                    // swap with previous (deleted) option slot
                    $newAnswers[$key - 1] = $formData['answers'][$key];
                    $newAnswersId[$key - 1] = $formData['answersid'][$key];
                    unset($formData['answers'][$key]);
                    unset($formData['answersid'][$key]);
                } elseif ($key === $deleted) {
                    // delete option
                    unset($formData['answers'][$deleted]);
                    unset($formData['answersid'][$deleted]);
                } else {
                    // keep as is
                    $newAnswers[$key] = $value;
                    $newAnswersId[$key] = $formData['answersid'][$key];
                }
            }
            unset($formData['answers']);
            unset($formData['answersid']);
            $formData['answers'] = $newAnswers;
            $formData['answersid'] = $newAnswersId;
        }

        // Adding an answer
        if (isset($_POST['buttons']) && isset($_POST['buttons']['add_answer'])) {
            if (isset($_REQUEST['type']) && 'multiplechoiceother' === $_REQUEST['type'] && $counter > 2) {
                $counter--;
            }
            $counter++;
            Session::write('answer_count', $counter);
        }

        // Removing an answer
        if (isset($_POST['buttons']) && isset($_POST['buttons']['remove_answer'])) {
            $counter--;
            Session::write('answer_count', $counter);
            foreach ($formData['answers'] as $index => &$data) {
                if ($index > $counter) {
                    unset($formData['answers'][$index]);
                    unset($formData['answersid'][$index]);
                }
            }
        }

        if (!isset($_POST['delete_answer'])) {
            // Make sure we have an array of answers
            if (!isset($formData['answers'])) {
                $formData['answers'] = [];
            }
            // Check if no deleted answer remains at the end of the answers
            // array and add empty answers if the array is too short
            foreach ($formData['answers'] as $index => $data) {
                if ($index > $counter) {
                    unset($formData['answers'][$index]);
                }
            }

            for ($i = 0; $i <= $counter; $i++) {
                if (!isset($formData['answers'][$i])) {
                    $formData['answers'][$i] = '';
                }
            }
        }

        $formData['answers'] = isset($formData['answers']) ? $formData['answers'] : [];
        Session::write('answer_list', $formData['answers']);

        if (!isset($formData['is_required']) && api_get_configuration_value('survey_mark_question_as_required')) {
            $formData['is_required'] = true;
        }

        return $formData;
    }

    /**
     * @param array $surveyData
     * @param array $formData
     *
     * @return mixed
     */
    public function save($surveyData, $formData, $dataFromDatabase = [])
    {
        // Saving a question
        if (isset($_POST['buttons']) && isset($_POST['buttons']['save'])) {
            Session::erase('answer_count');
            Session::erase('answer_list');
            $message = SurveyManager::save_question($surveyData, $formData, true, $dataFromDatabase);

            if ($message === 'QuestionAdded' || $message === 'QuestionUpdated') {
                $url = api_get_path(WEB_CODE_PATH).'survey/survey.php?survey_id='.intval($_GET['survey_id']).'&message='.$message.'&'.api_get_cidreq();
                header('Location: '.$url);
                exit;
            }
        }

        return $formData;
    }

    /**
     * Adds two buttons. One to add an option, one to remove an option.
     *
     * @param array $data
     */
    public function addRemoveButtons($data)
    {
        $this->buttonList['remove_answer'] = $this->getForm()->createElement(
            'button',
            'remove_answer',
            get_lang('RemoveAnswer'),
            'minus',
            'default'
        );

        if (count($data['answers']) <= 2) {
            $this->buttonList['remove_answer']->updateAttributes(
                ['disabled' => 'disabled']
            );
        }

        $this->buttonList['add_answer'] = $this->getForm()->createElement(
            'button',
            'add_answer',
            get_lang('AddAnswer'),
            'plus',
            'default'
        );
    }

    /**
     * Get the JS for questions that can depend on a previous question
     * (and that hides those questions until something changes in the previous
     * question).
     *
     * @return string HTML code
     */
    public static function getJs()
    {
        return '
            <style>
            .with_parent {
                display: none;
            }
            </style>
            <script>
            $(function() {
            });
            </script>';
    }

    /**
     * Get the question parents recursively, if any. This function depends on
     * the existence of a parent_id field, which depends on the
     * 'survey_question_dependency' setting and its corresponding SQL
     * requirements.
     *
     * @param int   $questionId The c_survey_question.question.id
     * @param array $list       An array of parents to be extended by this method
     *
     * @return array The completed array of parents
     */
    public static function getParents($questionId, $list = [])
    {
        if (true !== api_get_configuration_value('survey_question_dependency')) {
            return $list;
        }
        $courseId = api_get_course_int_id();
        $questionId = (int) $questionId;

        $table = Database::get_course_table(TABLE_SURVEY_QUESTION);
        $sql = "SELECT parent_id FROM $table
                WHERE c_id = $courseId AND question_id = $questionId ";
        $result = Database::query($sql);
        $row = Database::fetch_array($result, 'ASSOC');
        if ($row && !empty($row['parent_id'])) {
            $list[] = $row['parent_id'];
            $list = self::getParents($row['parent_id'], $list);
        }

        return $list;
    }

    /**
     * Creates the JS code for the given parent question so that it shows
     * the children questions when a specific answer of the parent is selected.
     *
     * @param array $question An array with the question details
     *
     * @return string JS code to add to the HTML survey question page
     */
    public static function getQuestionJs($question)
    {
        if (empty($question)) {
            return '';
        }

        $list = self::getDependency($question);

        if (empty($list)) {
            return '';
        }

        $type = $question['type'];
        $questionId = $question['question_id'];
        $newList = [];
        foreach ($list as $child) {
            $childQuestionId = $child['question_id'];
            $optionId = $child['parent_option_id'];
            $newList[$optionId][] = $childQuestionId;
        }

        if ('multipleresponse' === $type) {
            $multiple = '';
            foreach ($newList as $optionId => $child) {
                $multiple .= '
                    $(\'input[name="question'.$questionId.'['.$optionId.']"]\').on("change", function() {
                        var isChecked= $(this).is(\':checked\');
                        var checkedValue = $(this).val();
                        if (isChecked) {
                            $.each(list, function(index, value) {
                                $(".with_parent_" + value).find("input").prop("checked", false);
                            });

                            var questionId = $(this).val();
                            var questionToShow = list[questionId];
                            $(".with_parent_" + questionToShow).show();
                        } else {
                            var checkedValue = list[checkedValue];
                        }
                    });
                ';
            }

            $js = '
            <script>
            $(function() {
                var list = '.json_encode($newList).';
                '.$multiple.'
            });
            </script>';

            return $js;
        }

        $js = '
            <script>
            $(function() {
                var list = '.json_encode($newList).';
                $("input[name=question'.$questionId.']").on("click", function() {
                    $.each(list, function(index, value) {
                         $.each(value, function(index, itemValue) {
                            $(".with_parent_" + itemValue).hide();
                            $(".with_parent_" + itemValue).find("input").prop("checked", false);
                            $(".with_parent_only_hide_" + itemValue).hide();
                        });
                    });

                    var questionId = $(this).val();
                    var questionToShowList = list[questionId];
                    $.each(questionToShowList, function(index, value) {
                        $(".with_parent_" + value).show();
                    });
                });
            });
            </script>';

        return $js;
    }

    /**
     * Returns the (children) questions that have the given question as parent.
     *
     * @param array $question An array describing the parent question
     *
     * @return array The questions that have the given question as parent
     */
    public static function getDependency($question)
    {
        if (true !== api_get_configuration_value('survey_question_dependency')) {
            return [];
        }
        $table = Database::get_course_table(TABLE_SURVEY_QUESTION);
        $questionId = $question['question_id'];
        $courseId = api_get_course_int_id();

        // Getting the information of the question
        $sql = "SELECT * FROM $table
		        WHERE c_id = $courseId AND parent_id = $questionId ";
        $result = Database::query($sql);
        $row = Database::store_result($result, 'ASSOC');

        return $row;
    }

    /**
     * This method is not implemented at this level (returns null).
     *
     * @param array $questionData
     * @param array $answers
     */
    public function render(FormValidator $form, $questionData = [], $answers = [])
    {
        return null;
    }
}


1			<?php
2
3			/* For licensing terms, see /license.txt */
4
5			use ChamiloSession as Session;
6
7			/**
8			* Class survey_question.
9			*/
10			class survey_question
11			{
12			public $buttonList = [];
13			/** @var FormValidator */
14			private $form;
15
16			/**
17			* @param array $surveyData
18			*/
19			public function addParentMenu($formData, FormValidator $form, $surveyData)
20			{
21			$surveyId = $surveyData['survey_id'];
22			$questionId = isset($formData['question_id']) ? $formData['question_id'] : 0;
23			$parentId = isset($formData['parent_id']) ? $formData['parent_id'] : 0;
24			$optionId = isset($formData['parent_option_id']) ? $formData['parent_option_id'] : 0;
25			$questions = SurveyManager::get_questions($surveyId);
26
27			$newQuestionList = [];
28			$allowTypes = ['yesno', 'multiplechoice', 'multipleresponse'];
29			foreach ($questions as $question) {
30			if (in_array($question['type'], $allowTypes)) {
31			$newQuestionList[$question['sort']] = $question;
32			}
33			}
34			ksort($newQuestionList);
35
36			$options = [];
37			foreach ($newQuestionList as $question) {
38			if (!empty($questionId)) {
39			if ($question['question_id'] == $questionId) {
40			break;
41			}
42			}
43			$options[$question['question_id']] = strip_tags($question['question']);
44			}
45			$form->addSelect(
46			'parent_id',
47			get_lang('Parent'),
48			$options,
49			['id' => 'parent_id', 'placeholder' => get_lang('SelectAnOption')]
50			);
51			$url = api_get_path(WEB_AJAX_PATH).
52			'survey.ajax.php?'.api_get_cidreq().'&a=load_question_options&survey_id='.$surveyId;
53			$form->addHtml('
54			<script>
55			$(function() {
56			$("#parent_id").on("change", function() {
57			var questionId = $(this).val()
58			var $select = $("#parent_option_id");
59			$select.empty();
60
61			if (questionId === "") {
62			$("#option_list").hide();
63			} else {
64			$.getJSON({
65			url: "'.$url.'" + "&question_id=" + questionId,
66			success: function(data) {
67			$("#option_list").show();
68			$.each(data, function(key, value) {
69			$("<option>").val(key).text(value).appendTo($select);
70			});
71			}
72			});
73			}
74			});
75			});
76			</script>
77			');
78
79			$style = 'display:none';
80			$options = [];
81			if (!empty($optionId) && !empty($parentId)) {
82			$parentData = SurveyManager::get_question($parentId);
83			$style = '';
84			foreach ($parentData['answer_data'] as $answer) {
85			$options[$answer['iid']] = strip_tags($answer['data']);
86			}
87			}
88
89			$form->addHtml('<div id="option_list" style="'.$style.'">');
90			$form->addSelect(
91			'parent_option_id',
92			get_lang('Option'),
93			$options,
94			['id' => 'parent_option_id', 'disable_js' => true]
95			);
96			$form->addHtml('</div>');
97			}
98
99			/**
100			* @param string $type
101			*
102			* @return survey_question
103			*/
104			public static function createQuestion($type)
105			{
106			switch ($type) {
107			case 'comment':
108			return new ch_comment();
109			case 'dropdown':
110			return new ch_dropdown();
111			case 'multiplechoice':
112			return new ch_multiplechoice();
113			case 'multipleresponse':
114			return new ch_multipleresponse();
115			case 'open':
116			return new ch_open();
117			case 'pagebreak':
118			return new ch_pagebreak();
119			case 'percentage':
120			return new ch_percentage();
121			case 'personality':
122			return new ch_personality();
123			case 'score':
124			return new ch_score();
125			case 'yesno':
126			return new ch_yesno();
127			case 'selectivedisplay':
128			return new ch_selectivedisplay();
129			case 'multiplechoiceother':
130			return new ch_multiplechoiceother();
131			default:
132			api_not_allowed(true);
133			break;
134			}
135			}
136
137			/**
138			* Generic part of any survey question: the question field.
139			*
140			* @param array $surveyData
141			* @param array $formData
142			*
143			* @return FormValidator
144			*/
145			public function createForm($surveyData, $formData)
146			{
147			$action = isset($_GET['action']) ? Security::remove_XSS($_GET['action']) : null;
148			$questionId = isset($_GET['question_id']) ? (int) $_GET['question_id'] : null;
149			$surveyId = isset($_GET['survey_id']) ? (int) $_GET['survey_id'] : null;
150			$type = isset($_GET['type']) ? Security::remove_XSS($_GET['type']) : null;
151
152			$actionHeader = get_lang('EditQuestion').': ';
153			if ($action === 'add') {
154			$actionHeader = get_lang('AddQuestion').': ';
155			}
156
157			$questionComment = '';
158			$allowParent = false;
159			switch ($type) {
160			case 'open':
161			$toolName = get_lang('Open');
162			$questionComment = get_lang('QuestionTags');
163			$allowParent = true;
164			break;
165			case 'yesno':
166			$toolName = get_lang('YesNo');
167			$allowParent = true;
168			break;
169			case 'multiplechoice':
170			$toolName = get_lang('UniqueSelect');
171			$allowParent = true;
172			break;
173			case 'multipleresponse':
174			$toolName = get_lang('MultipleResponse');
175			$allowParent = true;
176			break;
177			case 'selectivedisplay':
178			$toolName = get_lang('SurveyQuestionSelectiveDisplay');
179			$questionComment = get_lang('SurveyQuestionSelectiveDisplayComment');
180			$allowParent = true;
181			break;
182			case 'multiplechoiceother':
183			$toolName = get_lang('SurveyQuestionMultipleChoiceWithOther');
184			$questionComment = get_lang('SurveyQuestionMultipleChoiceWithOtherComment');
185			$allowParent = true;
186			break;
187			case 'pagebreak':
188			$toolName = get_lang(api_ucfirst($type));
189			$allowParent = false;
190			break;
191			default:
192			$toolName = get_lang(api_ucfirst($type));
193			$allowParent = true;
194			break;
195			}
196
197			if (false === api_get_configuration_value('survey_question_dependency')) {
198			$allowParent = false;
199			}
200
201			$icon = Display::return_icon(
202			SurveyManager::icon_question($type),
203			$toolName,
204			['align' => 'middle', 'height' => '22px']
205			).' ';
206
207			$toolName = $icon.$actionHeader.$toolName;
208			$sharedQuestionId = isset($formData['shared_question_id']) ? $formData['shared_question_id'] : null;
209
210			$url = api_get_self().'?action='.$action.'&type='.$type.'&survey_id='.$surveyId.'&question_id='.$questionId.'&'.api_get_cidreq();
211			$form = new FormValidator('question_form', 'post', $url);
212			$form->addHeader($toolName);
213			if (!empty($questionComment)) {
214			$form->addHtml(Display::return_message($questionComment, 'info', false));
215			}
216			$form->addHidden('survey_id', $surveyId);
217			$form->addHidden('question_id', $questionId);
218			$form->addHidden('shared_question_id', Security::remove_XSS($sharedQuestionId));
219			$form->addHidden('type', $type);
220
221			$config = [
222			'ToolbarSet' => 'SurveyQuestion',
223			'Width' => '100%',
224			'Height' => '120',
225			];
226			$form->addHtmlEditor(
227			'question',
228			get_lang('Question'),
229			true,
230			false,
231			$config
232			);
233
234			if (api_get_configuration_value('allow_required_survey_questions') &&
235			in_array($_GET['type'], ['yesno', 'multiplechoice'])) {
236			$form->addCheckBox('is_required', get_lang('IsMandatory'), get_lang('Yes'));
237			}
238
239			if ($allowParent) {
240			$this->addParentMenu($formData, $form, $surveyData);
241			}
242
243			if (1 == $surveyData['survey_type']) {
244			$table_survey_question_group = Database::get_course_table(TABLE_SURVEY_QUESTION_GROUP);
245			$sql = 'SELECT id, name FROM '.$table_survey_question_group.'
246			WHERE survey_id = '.$surveyId.'
247			ORDER BY name';
248			$rs = Database::query($sql);
249			$glist = null;
250			while ($row = Database::fetch_array($rs, 'NUM')) {
251			$glist .= '<option value="'.$row[0].'" >'.$row[1].'</option>';
252			}
253
254			$grouplist = $grouplist1 = $grouplist2 = $glist;
255			if (!empty($formData['assigned'])) {
256			$grouplist = str_replace(
257			'<option value="'.$formData['assigned'].'"',
258			'<option value="'.$formData['assigned'].'" selected',
259			$glist
260			);
261			}
262
263			if (!empty($formData['assigned1'])) {
264			$grouplist1 = str_replace(
265			'<option value="'.$formData['assigned1'].'"',
266			'<option value="'.$formData['assigned1'].'" selected',
267			$glist
268			);
269			}
270
271			if (!empty($formData['assigned2'])) {
272			$grouplist2 = str_replace(
273			'<option value="'.$formData['assigned2'].'"',
274			'<option value="'.$formData['assigned2'].'" selected',
275			$glist
276			);
277			}
278
279			$this->html .= '<tr><td colspan="">
			0 ignored issues – show Bug Best Practice introduced 2018-01-05 13:33 UTC by Report Bug Copy Issue Report The property `html` does not exist on `survey_question`. Did you maybe forget to declare it? Loading history...
280			<fieldset style="border:1px solid black">
281			<legend>'.get_lang('Condition').'</legend>
282			<b>'.get_lang('Primary').'</b><br />
283			<input type="radio" name="choose" value="1" '.(($formData['choose'] == 1) ? 'checked' : '').'>
284			<select name="assigned">'.$grouplist.'</select><br />';
285			$this->html .= '
286			<b>'.get_lang('Secondary').'</b><br />
287			<input type="radio" name="choose" value="2" '.(($formData['choose'] == 2) ? 'checked' : '').'>
288			<select name="assigned1">'.$grouplist1.'</select>
289			<select name="assigned2">'.$grouplist2.'</select>
290			</fieldset><br />';
291			}
292
293			$this->setForm($form);
294
295			return $form;
296			}
297
298			/**
299			* Adds submit button.
300			*/
301			public function renderForm()
302			{
303			if (isset($_GET['question_id']) && !empty($_GET['question_id'])) {
304			/**
305			* Prevent the edition of already-answered questions to avoid
306			* inconsistent answers. Use the configuration option
307			* survey_allow_answered_question_edit to change this behaviour.
308			*/
309			$surveyId = isset($_GET['survey_id']) ? (int) $_GET['survey_id'] : 0;
310			$answersChecker = SurveyUtil::checkIfSurveyHasAnswers($surveyId);
311			$allowQuestionEdit = api_get_configuration_value('survey_allow_answered_question_edit') == true;
312			if ($allowQuestionEdit or !$answersChecker) {
313			$this->buttonList[] = $this->getForm()->addButtonUpdate(get_lang('ModifyQuestionSurvey'), 'save', true);
314			} else {
315			$this->getForm()->addHtml('
316			<div class="form-group">
317			<label class="col-sm-2 control-label"></label>
318			<div class="col-sm-8">
319			<div class="alert alert-info">'.
320			get_lang('YouCantNotEditThisQuestionBecauseAlreadyExistAnswers').'</div>
321			</div>
322			<div class="col-sm-2"></div>
323			</div>
324			');
325			}
326			} else {
327			$this->buttonList[] = $this->getForm()->addButtonSave(get_lang('CreateQuestionSurvey'), 'save', true);
328			}
329
330			$this->getForm()->addGroup($this->buttonList, 'buttons');
331			}
332
333			/**
334			* @return FormValidator
335			*/
336			public function getForm()
337			{
338			return $this->form;
339			}
340
341			/**
342			* @param FormValidator $form
343			*/
344			public function setForm($form)
345			{
346			$this->form = $form;
347			}
348
349			/**
350			* @param array $formData
351			*
352			* @return mixed
353			*/
354			public function preSave($formData)
355			{
356			$counter = Session::read('answer_count');
357			$answerList = Session::read('answer_list');
358
359			if (empty($answerList)) {
360			$answerList = isset($formData['answers']) ? $formData['answers'] : [];
361			Session::write('answer_list', $answerList);
362			}
363
364			if (isset($_POST['answers'])) {
365			$formData['answers'] = $_POST['answers'];
366			}
367
368			if (empty($counter)) {
369			$counter = count($answerList) - 1;
370			Session::write('answer_count', $counter);
371			}
372
373			// Moving an answer up
374			if (isset($_POST['move_up']) && $_POST['move_up']) {
375			foreach ($_POST['move_up'] as $key => &$value) {
376			$id1 = $key;
377			$content1 = $formData['answers'][$id1];
378			$id2 = $key - 1;
379			$content2 = $formData['answers'][$id2];
380			$formData['answers'][$id1] = $content2;
381			$formData['answers'][$id2] = $content1;
382			}
383			}
384
385			// Moving an answer down
386			if (isset($_POST['move_down']) && $_POST['move_down']) {
387			foreach ($_POST['move_down'] as $key => &$value) {
388			$id1 = $key;
389			$content1 = $formData['answers'][$id1];
390			$id2 = $key + 1;
391			$content2 = $formData['answers'][$id2];
392			$formData['answers'][$id1] = $content2;
393			$formData['answers'][$id2] = $content1;
394			}
395			}
396
397			/**
398			* Deleting a specific answer is only saved in the session until the
399			* "Save question" button is pressed. This means all options are kept
400			* in the survey_question_option table until the question is saved.
401			*/
402			if (isset($_POST['delete_answer'])) {
403			$deleted = false;
404			foreach ($_POST['delete_answer'] as $key => &$value) {
405			$deleted = $key;
406			$counter--;
407			Session::write('answer_count', $counter);
408			}
409
410			$newAnswers = [];
411			$newAnswersId = [];
412			foreach ($formData['answers'] as $key => &$value) {
413			if ($key > $deleted) {
414			// swap with previous (deleted) option slot
415			$newAnswers[$key - 1] = $formData['answers'][$key];
416			$newAnswersId[$key - 1] = $formData['answersid'][$key];
417			unset($formData['answers'][$key]);
418			unset($formData['answersid'][$key]);
419			} elseif ($key === $deleted) {
420			// delete option
421			unset($formData['answers'][$deleted]);
422			unset($formData['answersid'][$deleted]);
423			} else {
424			// keep as is
425			$newAnswers[$key] = $value;
426			$newAnswersId[$key] = $formData['answersid'][$key];
427			}
428			}
429			unset($formData['answers']);
430			unset($formData['answersid']);
431			$formData['answers'] = $newAnswers;
432			$formData['answersid'] = $newAnswersId;
433			}
434
435			// Adding an answer
436			if (isset($_POST['buttons']) && isset($_POST['buttons']['add_answer'])) {
437			if (isset($_REQUEST['type']) && 'multiplechoiceother' === $_REQUEST['type'] && $counter > 2) {
438			$counter--;
439			}
440			$counter++;
441			Session::write('answer_count', $counter);
442			}
443
444			// Removing an answer
445			if (isset($_POST['buttons']) && isset($_POST['buttons']['remove_answer'])) {
446			$counter--;
447			Session::write('answer_count', $counter);
448			foreach ($formData['answers'] as $index => &$data) {
449			if ($index > $counter) {
450			unset($formData['answers'][$index]);
451			unset($formData['answersid'][$index]);
452			}
453			}
454			}
455
456			if (!isset($_POST['delete_answer'])) {
457			// Make sure we have an array of answers
458			if (!isset($formData['answers'])) {
459			$formData['answers'] = [];
460			}
461			// Check if no deleted answer remains at the end of the answers
462			// array and add empty answers if the array is too short
463			foreach ($formData['answers'] as $index => $data) {
464			if ($index > $counter) {
465			unset($formData['answers'][$index]);
466			}
467			}
468
469			for ($i = 0; $i <= $counter; $i++) {
470			if (!isset($formData['answers'][$i])) {
471			$formData['answers'][$i] = '';
472			}
473			}
474			}
475
476			$formData['answers'] = isset($formData['answers']) ? $formData['answers'] : [];
477			Session::write('answer_list', $formData['answers']);
478
479			if (!isset($formData['is_required']) && api_get_configuration_value('survey_mark_question_as_required')) {
480			$formData['is_required'] = true;
481			}
482
483			return $formData;
484			}
485
486			/**
487			* @param array $surveyData
488			* @param array $formData
489			*
490			* @return mixed
491			*/
492			public function save($surveyData, $formData, $dataFromDatabase = [])
493			{
494			// Saving a question
495			if (isset($_POST['buttons']) && isset($_POST['buttons']['save'])) {
496			Session::erase('answer_count');
497			Session::erase('answer_list');
498			$message = SurveyManager::save_question($surveyData, $formData, true, $dataFromDatabase);
499
500			if ($message === 'QuestionAdded' \|\| $message === 'QuestionUpdated') {
501			$url = api_get_path(WEB_CODE_PATH).'survey/survey.php?survey_id='.intval($_GET['survey_id']).'&message='.$message.'&'.api_get_cidreq();
502			header('Location: '.$url);
503			exit;
504			}
505			}
506
507			return $formData;
508			}
509
510			/**
511			* Adds two buttons. One to add an option, one to remove an option.
512			*
513			* @param array $data
514			*/
515			public function addRemoveButtons($data)
516			{
517			$this->buttonList['remove_answer'] = $this->getForm()->createElement(
518			'button',
519			'remove_answer',
520			get_lang('RemoveAnswer'),
521			'minus',
522			'default'
523			);
524
525			if (count($data['answers']) <= 2) {
526			$this->buttonList['remove_answer']->updateAttributes(
527			['disabled' => 'disabled']
528			);
529			}
530
531			$this->buttonList['add_answer'] = $this->getForm()->createElement(
532			'button',
533			'add_answer',
534			get_lang('AddAnswer'),
535			'plus',
536			'default'
537			);
538			}
539
540			/**
541			* Get the JS for questions that can depend on a previous question
542			* (and that hides those questions until something changes in the previous
543			* question).
544			*
545			* @return string HTML code
546			*/
547			public static function getJs()
548			{
549			return '
550			<style>
551			.with_parent {
552			display: none;
553			}
554			</style>
555			<script>
556			$(function() {
557			});
558			</script>';
559			}
560
561			/**
562			* Get the question parents recursively, if any. This function depends on
563			* the existence of a parent_id field, which depends on the
564			* 'survey_question_dependency' setting and its corresponding SQL
565			* requirements.
566			*
567			* @param int $questionId The c_survey_question.question.id
568			* @param array $list An array of parents to be extended by this method
569			*
570			* @return array The completed array of parents
571			*/
572			public static function getParents($questionId, $list = [])
573			{
574			if (true !== api_get_configuration_value('survey_question_dependency')) {
575			return $list;
576			}
577			$courseId = api_get_course_int_id();
578			$questionId = (int) $questionId;
579
580			$table = Database::get_course_table(TABLE_SURVEY_QUESTION);
581			$sql = "SELECT parent_id FROM $table
582			WHERE c_id = $courseId AND question_id = $questionId ";
583			$result = Database::query($sql);
584			$row = Database::fetch_array($result, 'ASSOC');
585			if ($row && !empty($row['parent_id'])) {
586			$list[] = $row['parent_id'];
587			$list = self::getParents($row['parent_id'], $list);
588			}
589
590			return $list;
591			}
592
593			/**
594			* Creates the JS code for the given parent question so that it shows
595			* the children questions when a specific answer of the parent is selected.
596			*
597			* @param array $question An array with the question details
598			*
599			* @return string JS code to add to the HTML survey question page
600			*/
601			public static function getQuestionJs($question)
602			{
603			if (empty($question)) {
604			return '';
605			}
606
607			$list = self::getDependency($question);
608
609			if (empty($list)) {
610			return '';
611			}
612
613			$type = $question['type'];
614			$questionId = $question['question_id'];
615			$newList = [];
616			foreach ($list as $child) {
617			$childQuestionId = $child['question_id'];
618			$optionId = $child['parent_option_id'];
619			$newList[$optionId][] = $childQuestionId;
620			}
621
622			if ('multipleresponse' === $type) {
623			$multiple = '';
624			foreach ($newList as $optionId => $child) {
625			$multiple .= '
626			$(\'input[name="question'.$questionId.'['.$optionId.']"]\').on("change", function() {
627			var isChecked= $(this).is(\':checked\');
628			var checkedValue = $(this).val();
629			if (isChecked) {
630			$.each(list, function(index, value) {
631			$(".with_parent_" + value).find("input").prop("checked", false);
632			});
633
634			var questionId = $(this).val();
635			var questionToShow = list[questionId];
636			$(".with_parent_" + questionToShow).show();
637			} else {
638			var checkedValue = list[checkedValue];
639			}
640			});
641			';
642			}
643
644			$js = '
645			<script>
646			$(function() {
647			var list = '.json_encode($newList).';
648			'.$multiple.'
649			});
650			</script>';
651
652			return $js;
653			}
654
655			$js = '
656			<script>
657			$(function() {
658			var list = '.json_encode($newList).';
659			$("input[name=question'.$questionId.']").on("click", function() {
660			$.each(list, function(index, value) {
661			$.each(value, function(index, itemValue) {
662			$(".with_parent_" + itemValue).hide();
663			$(".with_parent_" + itemValue).find("input").prop("checked", false);
664			$(".with_parent_only_hide_" + itemValue).hide();
665			});
666			});
667
668			var questionId = $(this).val();
669			var questionToShowList = list[questionId];
670			$.each(questionToShowList, function(index, value) {
671			$(".with_parent_" + value).show();
672			});
673			});
674			});
675			</script>';
676
677			return $js;
678			}
679
680			/**
681			* Returns the (children) questions that have the given question as parent.
682			*
683			* @param array $question An array describing the parent question
684			*
685			* @return array The questions that have the given question as parent
686			*/
687			public static function getDependency($question)
688			{
689			if (true !== api_get_configuration_value('survey_question_dependency')) {
690			return [];
691			}
692			$table = Database::get_course_table(TABLE_SURVEY_QUESTION);
693			$questionId = $question['question_id'];
694			$courseId = api_get_course_int_id();
695
696			// Getting the information of the question
697			$sql = "SELECT * FROM $table
698			WHERE c_id = $courseId AND parent_id = $questionId ";
699			$result = Database::query($sql);
700			$row = Database::store_result($result, 'ASSOC');
701
702			return $row;
703			}
704
705			/**
706			* This method is not implemented at this level (returns null).
707			*
708			* @param array $questionData
709			* @param array $answers
710			*/
711			public function render(FormValidator $form, $questionData = [], $answers = [])
712			{
713			return null;
714			}
715			}
716

chamilo / chamilo-lms

survey_question::renderForm() A last analyzed 2025-06-17 20:49 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

survey_question::renderForm() A
last analyzed 2025-06-17 20:49 UTC