ILIAS\Survey\Page\PageRenderer Class Reference

Survey page renderer. More...

Collaboration diagram for ILIAS\Survey\Page\PageRenderer:

Public Member Functions
	__construct (\ilObjSurvey $survey, array $page_data, array $working_data=[], array $errors=[], int $question_title_mode=1)
	render ()

Protected Member Functions
	compressQuestion (?array $previous_page, array $page)

Protected Attributes
int	$question_title_mode
ilCtrl	$ctrl
ilLanguage	$lng
array	$page_data
array	$working_data = []
array	$errors = []
ilObjSurvey	$survey

Detailed Description

Survey page renderer.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 25 of file class.PageRenderer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Survey\Page\PageRenderer::__construct	(	\ilObjSurvey	$survey,
		array	$page_data,
		array	$working_data = [],
		array	$errors = [],
		int	$question_title_mode = 1
	)

Parameters

array

$page_data

as returned by ilObjSurvey->getNextPage()

Todo:

use data objects

Definition at line 39 of file class.PageRenderer.php.

References $DIC, ILIAS\Survey\Page\PageRenderer\$errors, ILIAS\Survey\Page\PageRenderer\$page_data, ILIAS\Survey\Page\PageRenderer\$question_title_mode, ILIAS\Survey\Page\PageRenderer\$survey, ILIAS\Survey\Page\PageRenderer\$working_data, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

      {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->survey = $survey;
        $this->page_data = $page_data;
        $this->working_data = $working_data;
        $this->errors = $errors;
        $this->question_title_mode = $question_title_mode;
    }

Here is the call graph for this function:

Member Function Documentation

compressQuestion()

ILIAS\Survey\Page\PageRenderer::compressQuestion ( ?array  $previous_page, array  $page  )

protected

Definition at line 156 of file class.PageRenderer.php.

Referenced by ILIAS\Survey\Page\PageRenderer\render().

     : bool {
        if (is_null($previous_page)) {
            return false;
        }

        if ($previous_page["type_tag"] === $page["type_tag"] &&
            $page["type_tag"] === "SurveySingleChoiceQuestion") {
            if (\SurveySingleChoiceQuestion::compressable($previous_page["question_id"], $page["question_id"])) {
                return true;
            }
        }

        return false;
    }

Here is the caller graph for this function:

render()

ILIAS\Survey\Page\PageRenderer::render

(

)

Definition at line 57 of file class.PageRenderer.php.

References $data, ILIAS\$error, ILIAS\Survey\Page\PageRenderer\$page_data, ILIAS\Survey\Page\PageRenderer\$question_title_mode, ILIAS\Survey\Page\PageRenderer\compressQuestion(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                            : string
    {
        $page = $this->page_data;

        $required = false;
        $stpl = new \ilTemplate("tpl.page.html", true, true, "components/ILIAS/Survey/Page");

        // question block title
        if (count($page) > 1 && $page[0]["questionblock_show_blocktitle"]) {
            $stpl->setCurrentBlock("questionblock_title");
            $stpl->setVariable("TEXT_QUESTIONBLOCK_TITLE", $page[0]["questionblock_title"]);
            $stpl->parseCurrentBlock();
        }

        // dealing with compressed view
        $compress_view = false;
        if (count($page) > 1) {
            $compress_view = $page[0]["questionblock_compress_view"];
        }
        $previous_page = null;
        $previous_key = null;
        foreach ($page as $k => $data) {
            $page[$k]["compressed"] = false;
            $page[$k]["compressed_first"] = false;
            if ($compress_view && $this->compressQuestion($previous_page, $data)) {
                $page[$k]["compressed"] = true;
                if ($previous_key !== null && $page[$previous_key]["compressed"] == false) {
                    $page[$previous_key]["compressed_first"] = true;
                }
            }
            $previous_key = $k;
            $previous_page = $data;
        }

        // questions
        foreach ($page as $data) {
            // question heading
            if ($data["heading"]) {
                $stpl->setCurrentBlock("heading");
                $stpl->setVariable("QUESTION_HEADING", $data["heading"]);
                $stpl->parseCurrentBlock();
            }
            $stpl->setCurrentBlock("survey_content");
            // get question gui
            $question_gui = $this->survey->getQuestionGUI($data["type_tag"], $data["question_id"]);

            // set obligatory flag
            $question_gui->object->setObligatory($data["obligatory"]);

            // get show questiontext flag
            $show_questiontext = ($data["questionblock_show_questiontext"]) ? 1 : 0;

            // question title mode
            $question_title_mode = $this->question_title_mode;
            if (!$this->survey->getShowQuestionTitles() || $data["compressed_first"]) {
                $question_title_mode = 0;
            }
            $working_data = $this->working_data[$data["question_id"]] ?? null;
            $error = $this->errors[$data["question_id"]] ?? "";

            // get question output
            // getWorkingData($qid)
            // showQuestionTitle()
            $question_output = $question_gui->getWorkingForm(
                $working_data,
                $question_title_mode,
                $show_questiontext,
                $error,
                $this->survey->getSurveyId(),
                $compress_view
            );

            // tweak compressed view
            if ($data["compressed"]) {
                //$question_output = '<div class="il-svy-qst-compressed">' . $question_output . '</div>';

                $stpl->setVariable("CMPR_CLASS", "il-svy-qst-compressed");
            }
            $stpl->setVariable("QUESTION_OUTPUT", $question_output);

            // update qid ctrl parameter
            $this->ctrl->setParameter($this, "qid", $data["question_id"]);

            if ($data["obligatory"]) {
                $required = true;
            }
            $stpl->parseCurrentBlock();
        }

        // required text action
        if ($required) {
            $stpl->setCurrentBlock("required");
            $stpl->setVariable("TEXT_REQUIRED", $this->lng->txt("required_field"));
            $stpl->parseCurrentBlock();
        }

        return $stpl->get();
    }

Here is the call graph for this function:

Field Documentation

$ctrl

ilCtrl ILIAS\Survey\Page\PageRenderer::$ctrl

protected

Definition at line 28 of file class.PageRenderer.php.

$errors

array ILIAS\Survey\Page\PageRenderer::$errors = []

protected

Definition at line 32 of file class.PageRenderer.php.

Referenced by ILIAS\Survey\Page\PageRenderer\__construct().

$lng

ilLanguage ILIAS\Survey\Page\PageRenderer::$lng

protected

Definition at line 29 of file class.PageRenderer.php.

$page_data

array ILIAS\Survey\Page\PageRenderer::$page_data

protected

Definition at line 30 of file class.PageRenderer.php.

Referenced by ILIAS\Survey\Page\PageRenderer\__construct(), and ILIAS\Survey\Page\PageRenderer\render().

$question_title_mode

int ILIAS\Survey\Page\PageRenderer::$question_title_mode

protected

Definition at line 27 of file class.PageRenderer.php.

Referenced by ILIAS\Survey\Page\PageRenderer\__construct(), and ILIAS\Survey\Page\PageRenderer\render().

$survey

ilObjSurvey ILIAS\Survey\Page\PageRenderer::$survey

protected

Definition at line 33 of file class.PageRenderer.php.

Referenced by ILIAS\Survey\Page\PageRenderer\__construct().

$working_data

array ILIAS\Survey\Page\PageRenderer::$working_data = []

protected

Definition at line 31 of file class.PageRenderer.php.

Referenced by ILIAS\Survey\Page\PageRenderer\__construct().

---

The documentation for this class was generated from the following file:

• components/ILIAS/Survey/Page/class.PageRenderer.php