chamilo/chamilo-lms

View on GitHub
public/main/survey/preview.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

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

use Chamilo\CoreBundle\Framework\Container;
use Chamilo\CourseBundle\Entity\CSurvey;

/**
 * @author  Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @author  Julio Montoya <gugli100@gmail.com>
 */
require_once __DIR__.'/../inc/global.inc.php';

api_protect_course_script(true);

if (!api_is_allowed_to_edit()) {
    api_not_allowed(true);
}

$surveyId = (int) $_GET['survey_id'];

if (empty($surveyId)) {
    api_not_allowed(true);
}

$repo = Container::getSurveyRepository();
/** @var CSurvey $survey */
$survey = $repo->find($surveyId);
if (null === $survey) {
    api_not_allowed(true);
}

$this_section = SECTION_COURSES;
$table_survey_question = Database::get_course_table(TABLE_SURVEY_QUESTION);
$table_survey_question_option = Database::get_course_table(TABLE_SURVEY_QUESTION_OPTION);

$course_id = api_get_course_int_id();
$courseInfo = api_get_course_info();
$allowRequiredSurveyQuestions = true;

// Breadcrumbs
$interbreadcrumb[] = [
    'url' => api_get_path(WEB_CODE_PATH).'survey/survey_list.php?'.api_get_cidreq(),
    'name' => get_lang('Survey list'),
];
$interbreadcrumb[] = [
    'url' => api_get_path(WEB_CODE_PATH).'survey/survey.php?survey_id='.$surveyId.'&'.api_get_cidreq(),
    'name' => strip_tags($survey->getTitle(), '<span>'),
];

//$htmlHeadXtra[] = '<script>'.api_get_language_translate_html().'</script>';
$htmlHeadXtra[] = ch_selectivedisplay::getJs();
$htmlHeadXtra[] = survey_question::getJs();
$show = 0;
Display::display_header(get_lang('Survey preview'));

// We exit here is the first or last question is a pagebreak (which causes errors)
SurveyUtil::check_first_last_question($surveyId, false);

// Survey information
echo '<div class="page-header"><h2>'.Security::remove_XSS($survey->getTitle()).'</h2></div>';
if (!empty($survey->getSubtitle())) {
    echo '<div id="survey_subtitle">'.Security::remove_XSS($survey->getSubtitle()).'</div>';
}

// Displaying the survey introduction
if (!isset($_GET['show'])) {
    if (!empty($survey->getIntro())) {
        echo '<div class="survey_content">'.Security::remove_XSS($survey->getIntro()).'</div>';
    }
}

// Displaying the survey thanks message
if (isset($_POST['finish_survey'])) {
    echo Display::return_message(get_lang('You have finished this survey.'), 'confirm');
    echo Security::remove_XSS($survey->getSurveythanks());
    Display::display_footer();
    exit;
}

$questions = [];
$pageBreakText = [];
if (isset($_GET['show'])) {
    // Getting all the questions for this page and add them to a
    // multidimensional array where the first index is the page.
    // as long as there is no pagebreak fount we keep adding questions to the page
    $paged_questions = [];
    $counter = 0;
    $sql = "SELECT * FROM $table_survey_question
            WHERE
              survey_question NOT LIKE '%{{%' AND
              survey_id = $surveyId
            ORDER BY sort ASC";
    $result = Database::query($sql);
    $questions_exists = true;
    if (Database::num_rows($result)) {
        while ($row = Database::fetch_array($result)) {
            if (1 == $survey->getOneQuestionPerPage()) {
                if ('pagebreak' !== $row['type']) {
                    $paged_questions[$counter][] = $row['iid'];
                    $counter++;
                    continue;
                }
            } else {
                if ('pagebreak' === $row['type']) {
                    $counter++;
                    $pageBreakText[$counter] = $row['survey_question'];
                } else {
                    $paged_questions[$counter][] = $row['iid'];
                }
            }
        }
    } else {
        $questions_exists = false;
    }

    if (array_key_exists($_GET['show'], $paged_questions)) {
        $select = '';
        $select = ' survey_question.parent_id, survey_question.parent_option_id, ';
        $sql = "SELECT
                    survey_question.iid question_id,
                    survey_question.survey_id,
                    survey_question.survey_question,
                    survey_question.display,
                    survey_question.sort,
                    survey_question.type,
                    survey_question.max_value,
                    survey_question_option.iid as question_option_id,
                    survey_question_option.option_text,
                    $select
                    survey_question_option.sort as option_sort
                    ".($allowRequiredSurveyQuestions ? ', survey_question.is_required' : '')."
                FROM $table_survey_question survey_question
                LEFT JOIN $table_survey_question_option survey_question_option
                ON
                    survey_question.iid = survey_question_option.question_id
                WHERE
                    survey_question.survey_id = '".$surveyId."' AND
                    survey_question.iid IN (".Database::escape_string(implode(',', $paged_questions[$_GET['show']]), null, false).") AND
                    survey_question NOT LIKE '%{{%'
                ORDER BY survey_question.sort, survey_question_option.sort ASC";

        $result = Database::query($sql);
        while ($row = Database::fetch_array($result)) {
            // If the type is not a pagebreak we store it in the $questions array
            if ('pagebreak' !== $row['type']) {
                $sort = $row['sort'];
                $questions[$sort]['question_id'] = $row['question_id'];
                $questions[$sort]['survey_id'] = $row['survey_id'];
                $questions[$sort]['survey_question'] = Security::remove_XSS($row['survey_question']);
                $questions[$sort]['display'] = $row['display'];
                $questions[$sort]['type'] = $row['type'];
                $questions[$sort]['options'][$row['question_option_id']] = Security::remove_XSS($row['option_text']);
                $questions[$sort]['maximum_score'] = $row['max_value'];
                $questions[$sort]['parent_id'] = isset($row['parent_id']) ? $row['parent_id'] : 0;
                $questions[$sort]['parent_option_id'] = isset($row['parent_option_id']) ? $row['parent_option_id'] : 0;
                $questions[$row['sort']]['is_required'] = $allowRequiredSurveyQuestions && $row['is_required'];
            }
        }
    }
}

$numberOfPages = SurveyManager::getCountPages($survey);
// Displaying the form with the questions
if (isset($_GET['show'])) {
    $show = (int) $_GET['show'] + 1;
}
$originalShow = isset($_GET['show']) ? (int) $_GET['show'] : 0;

$url = api_get_self().'?survey_id='.$surveyId.'&show='.$show.'&'.api_get_cidreq();

$form = new FormValidator(
    'question-survey',
    'post',
    $url,
    null,
    null,
    FormValidator::LAYOUT_INLINE
);

if (is_array($questions) && count($questions) > 0) {
    $counter = 1;
    if (!empty($originalShow)) {
        $before = 0;
        foreach ($paged_questions as $keyQuestion => $list) {
            if ($originalShow > $keyQuestion) {
                $before += count($list);
            }
        }
        $counter = $before + 1;
    }

    $showNumber = true;
    if (SurveyManager::hasDependency($survey)) {
        $showNumber = false;
    }

    $js = '';
    if (isset($pageBreakText[$originalShow]) && !empty(strip_tags($pageBreakText[$originalShow]))) {
        // Only show page-break texts if there is something there, apart from
        // HTML tags
        $form->addHtml(
            '<div>'.
            Security::remove_XSS($pageBreakText[$originalShow]).
            '</div>'
        );
        $form->addHtml('<br />');
    }

    foreach ($questions as $key => &$question) {
        $ch_type = 'ch_'.$question['type'];
        $display = survey_question::createQuestion($question['type']);
        $parent = $question['parent_id'];
        $parentClass = '';

        if (!empty($parent)) {
            $parentClass = ' with_parent with_parent_'.$question['question_id'];
            $parents = survey_question::getParents($question['question_id']);
            if (!empty($parents)) {
                foreach ($parents as $parentId) {
                    $parentClass .= ' with_parent_only_hide_'.$parentId;
                }
            }
        }

        $js .= survey_question::getQuestionJs($question);

        $form->addHtml('<div class="survey_question '.$ch_type.' '.$parentClass.'">');
        if ($showNumber && $survey->isDisplayQuestionNumber()) {
            $form->addHtml('<div style="float:left; font-weight: bold; margin-right: 5px;"> '.$counter.'. </div>');
        }
        $form->addHtml('<div>'.Security::remove_XSS($question['survey_question']).'</div>');
        $display->render($form, $question);
        $form->addHtml('</div>');
        $counter++;
    }
    $form->addHtml($js);
}
$form->addHtml('<div class="start-survey">');

if ($show < $numberOfPages) {
    if (0 == $show) {
        $form->addButton(
            'next_survey_page',
            get_lang('Start the Survey'),
            'arrow-right',
            'success'
        );
    } else {
        $form->addButton(
            'next_survey_page',
            get_lang('Next question'),
            'arrow-right',
            'success'
        );
    }
}

if (isset($_GET['show'])) {
    if ($show >= $numberOfPages || 0 == count($questions)) {
        if (false == $questions_exists) {
            echo '<p>'.get_lang('There are not questions for this survey').'</p>';
        }
        $form->addButton(
            'finish_survey',
            get_lang('Finish survey'),
            'arrow-right',
            'success'
        );
    }
}

$form->addHtml('</div>');
$form->display();

echo Display::toolbarButton(
    get_lang('Return to Course Homepage'),
    api_get_course_url($courseInfo['real_id']),
    'home-outline'
);

Display::display_footer();