ilPollAnswersRenderer Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilPollAnswersRenderer:

Public Member Functions
	__construct (ilLanguage $lng)
	render (ilTemplate $tpl, ilPollAnswersHandler $answers, bool $disable_input)

Protected Member Functions
	renderAnswer (ilTemplate $tpl, int $id, string $answer, ?array $last_vote, bool $single_answer, bool $disable_input)
	specialCharsAsEntities (string $string)

Protected Attributes
ilLanguage	$lng

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 22 of file class.ilPollAnswersRenderer.php.

Constructor & Destructor Documentation

__construct()

ilPollAnswersRenderer::__construct

(

ilLanguage

$lng

)

Definition at line 26 of file class.ilPollAnswersRenderer.php.

References $lng, and ILIAS\Repository\lng().

    {
        $this->lng = $lng;
    }

Here is the call graph for this function:

Member Function Documentation

render()

ilPollAnswersRenderer::render	(	ilTemplate	$tpl,
		ilPollAnswersHandler	$answers,
		bool	$disable_input
	)

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

References $id, ilPollAnswersHandler\getAnswerLimit(), ilPollAnswersHandler\getAnswers(), ilPollAnswersHandler\getVoteCommand(), ilPollAnswersHandler\getVoteURL(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ilPollAnswersHandler\popLastVoteFromSession(), renderAnswer(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

     : void {
        $single_answer = ($answers->getAnswerLimit() === 1);

        if (!is_null($last_vote = $answers->popLastVoteFromSession())) {
            if (!$single_answer && empty($last_vote)) {
                $error = $this->lng->txt("poll_vote_error_multi_no_answer");
            } elseif (!$single_answer) {
                $error = sprintf(
                    $this->lng->txt("poll_vote_error_multi"),
                    $answers->getAnswerLimit()
                );
            } else {
                $error = $this->lng->txt("poll_vote_error_single");
            }

            $tpl->setCurrentBlock("error_bl");
            $tpl->setVariable("FORM_ERROR", $error);
            $tpl->parseCurrentBlock();
        }

        $tpl->setCurrentBlock('answer');
        foreach ($answers->getAnswers() as $id => $answer) {
            $this->renderAnswer(
                $tpl,
                $id,
                $answer,
                $last_vote,
                $single_answer,
                $disable_input
            );
        }

        if (!$disable_input) {
            $tpl->setVariable("URL_FORM", $answers->getVoteURL());
            $tpl->setVariable("CMD_FORM", $answers->getVoteCommand());
            $tpl->setVariable("TXT_SUBMIT", $this->lng->txt("poll_vote"));
        }
    }

Here is the call graph for this function:

renderAnswer()

ilPollAnswersRenderer::renderAnswer ( ilTemplate  $tpl, int  $id, string  $answer, ?array  $last_vote, bool  $single_answer, bool  $disable_input  )

protected

Definition at line 74 of file class.ilPollAnswersRenderer.php.

References ilTemplate\parseCurrentBlock(), HTML_Template_IT\setVariable(), and specialCharsAsEntities().

Referenced by render().

     : void {
        if ($single_answer) {
            $tpl->setVariable("ANSWER_INPUT", "radio");
            $tpl->setVariable("ANSWER_NAME", "aw");
        } else {
            $tpl->setVariable("ANSWER_INPUT", "checkbox");
            $tpl->setVariable("ANSWER_NAME", "aw[]");

            $status = [];
            if (!empty($last_vote) && is_array($last_vote) && in_array($id, $last_vote)) {
                $status[] = 'checked="checked"';
            }
            if ($disable_input) {
                $status[] = 'disabled';
            }
            if ($status) {
                $tpl->setVariable("ANSWER_STATUS", implode(' ', $status));
            }
        }
        $tpl->setVariable("VALUE_ANSWER", $id);
        $tpl->setVariable(
            "TXT_ANSWER_VOTE",
            $this->specialCharsAsEntities(nl2br($answer))
        );
        $tpl->parseCurrentBlock();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

specialCharsAsEntities()

ilPollAnswersRenderer::specialCharsAsEntities ( string  $string )

protected

Definition at line 108 of file class.ilPollAnswersRenderer.php.

Referenced by renderAnswer().

                                                             : string
    {
        // Should be replaced by a proper refinery transformation once https://github.com/ILIAS-eLearning/ILIAS/pull/6314 is merged
        return  htmlspecialchars(
            $string,
            ENT_QUOTES | ENT_SUBSTITUTE,
            'utf-8'
        );
    }

Here is the caller graph for this function:

Field Documentation

$lng

ilLanguage ilPollAnswersRenderer::$lng

protected

Definition at line 24 of file class.ilPollAnswersRenderer.php.

Referenced by __construct().

---

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

• Modules/Poll/classes/BlockGUI/Answers/class.ilPollAnswersRenderer.php