ilPollContentRenderer 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 ilPollContentRenderer:

Public Member Functions
	__construct (ilLanguage $lng, UIFactory $ui_factory, UIRenderer $ui_renderer, ilPollStateInfo $availability, ilPollCommentsHandler $comments, ilPollAnswersHandler $answers, ilPollAnswersRenderer $answers_renderer, ilPollResultsHandler $results, ilPollResultsRenderer $results_renderer)
	render (ilTemplate $tpl, int $ref_id, int $user_id, ilObjPoll $poll, bool $admin_view=false)

Protected Member Functions
	renderAnswersAndResults (ilTemplate $tpl, ilObjPoll $poll, int $user_id)
	renderAnswers (ilTemplate $tpl, ilObjPoll $poll, int $user_id)
	renderResults (ilTemplate $tpl, ilObjPoll $poll)
	renderTotalParticipantsInfo (ilTemplate $tpl, int $total)
	renderNotAbleToVoteMessage (ilTemplate $tpl, bool $has_voted, bool $results_in_future, int $voting_end_date)
	renderQuestion (ilTemplate $tpl, string $text, ?string $img_path)
	renderMiscVoteInfo (ilTemplate $tpl, ?int $answer_limit, int $deadline)
	renderAnonimityInfo (ilTemplate $tpl, bool $anonymous)
	renderNotWithinVotingPeriodMessage (ilTemplate $tpl, int $vote_start, int $vote_end)
	renderNoQuestionMessage (ilTemplate $tpl)
	renderAnchor (ilTemplate $tpl, int $obj_id)
	renderDescription (ilTemplate $tpl, string $description)
	renderAvailability (ilTemplate $tpl, ilObjPoll $poll)
	renderAlertForAnonymousUser (ilTemplate $tpl)
	renderComments (ilTemplate $tpl, int $ref_id)
	getMessageBox (string $message)
	getFormattedDate (int $date)
	specialCharsAsEntities (string $string)

Protected Attributes
ilPollStateInfo	$state
ilPollCommentsHandler	$comments
ilPollAnswersHandler	$answers
ilPollAnswersRenderer	$answers_renderer
ilPollResultsHandler	$results
ilPollResultsRenderer	$results_renderer
ilLanguage	$lng
UIFactory	$ui_factory
UIRenderer	$ui_renderer

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 25 of file class.ilPollContentRenderer.php.

Constructor & Destructor Documentation

__construct()

ilPollContentRenderer::__construct	(	ilLanguage	$lng,
		UIFactory	$ui_factory,
		UIRenderer	$ui_renderer,
		ilPollStateInfo	$availability,
		ilPollCommentsHandler	$comments,
		ilPollAnswersHandler	$answers,
		ilPollAnswersRenderer	$answers_renderer,
		ilPollResultsHandler	$results,
		ilPollResultsRenderer	$results_renderer
	)

Definition at line 37 of file class.ilPollContentRenderer.php.

References $answers, $answers_renderer, $comments, $lng, $results, $results_renderer, $ui_factory, $ui_renderer, and ILIAS\Repository\lng().

      {
        $this->lng = $lng;
        $this->ui_factory = $ui_factory;
        $this->ui_renderer = $ui_renderer;
        $this->state = $availability;
        $this->comments = $comments;
        $this->answers = $answers;
        $this->answers_renderer = $answers_renderer;
        $this->results = $results;
        $this->results_renderer = $results_renderer;
    }

Here is the call graph for this function:

Member Function Documentation

getFormattedDate()

ilPollContentRenderer::getFormattedDate ( int  $date )

protected

Definition at line 347 of file class.ilPollContentRenderer.php.

References ilDatePresentation\formatDate(), and IL_CAL_UNIX.

Referenced by renderMiscVoteInfo(), renderNotAbleToVoteMessage(), and renderNotWithinVotingPeriodMessage().

                                                  : string
    {
        return ilDatePresentation::formatDate(
            new ilDateTime($date, IL_CAL_UNIX)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMessageBox()

ilPollContentRenderer::getMessageBox ( string  $message )

protected

Definition at line 340 of file class.ilPollContentRenderer.php.

Referenced by renderNoQuestionMessage(), renderNotAbleToVoteMessage(), and renderNotWithinVotingPeriodMessage().

                                                     : string
    {
        return $this->ui_renderer->render(
            $this->ui_factory->messageBox()->info($message)
        );
    }

Here is the caller graph for this function:

render()

ilPollContentRenderer::render	(	ilTemplate	$tpl,
		int	$ref_id,
		int	$user_id,
		ilObjPoll	$poll,
		bool	$admin_view = false
	)

Definition at line 59 of file class.ilPollContentRenderer.php.

References ilObject\getId(), ilObjPoll\getImageFullPath(), ilObject\getLongDescription(), ilObjPoll\getQuestion(), ilObjPoll\getShowComments(), ilObjPoll\getVotingPeriodBegin(), ilObjPoll\getVotingPeriodEnd(), renderAlertForAnonymousUser(), renderAnchor(), renderAnswersAndResults(), renderAvailability(), renderComments(), renderDescription(), renderNoQuestionMessage(), renderNotWithinVotingPeriodMessage(), and renderQuestion().

     : void {
        $this->renderAnchor($tpl, $poll->getId());
        $this->renderAvailability($tpl, $poll);
        $this->renderDescription($tpl, $poll->getLongDescription());

        if (!$this->state->hasQuestion($poll)) {
            $this->renderNoQuestionMessage($tpl);
        } elseif ($this->state->hasVotingPeriodNotStarted($poll, false)) {
            $this->renderNotWithinVotingPeriodMessage(
                $tpl,
                $poll->getVotingPeriodBegin(),
                $poll->getVotingPeriodEnd()
            );
        } else {
            $this->renderQuestion(
                $tpl,
                $poll->getQuestion(),
                $poll->getImageFullPath()
            );
            if (!$admin_view) {
                $this->renderAnswersAndResults($tpl, $poll, $user_id);
            }
        }

        if ($poll->getShowComments()) {
            $this->renderComments($tpl, $ref_id);
        }

        if ($this->state->isUserAnonymous($user_id)) {
            $this->renderAlertForAnonymousUser($tpl);
        }
    }

Here is the call graph for this function:

renderAlertForAnonymousUser()

ilPollContentRenderer::renderAlertForAnonymousUser ( ilTemplate  $tpl )

protected

Definition at line 320 of file class.ilPollContentRenderer.php.

References ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by render().

                                                                   : void
    {
        $tpl->setVariable("TXT_ANON", $this->lng->txt('no_access_item_public'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderAnchor()

ilPollContentRenderer::renderAnchor ( ilTemplate  $tpl, int  $obj_id  )

protected

Definition at line 295 of file class.ilPollContentRenderer.php.

References HTML_Template_IT\setVariable().

Referenced by render().

                                                                 : void
    {
        $tpl->setVariable("ANCHOR_ID", $obj_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderAnonimityInfo()

ilPollContentRenderer::renderAnonimityInfo ( ilTemplate  $tpl, bool  $anonymous  )

protected

Definition at line 260 of file class.ilPollContentRenderer.php.

References ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by renderAnswers().

     : void {
        if ($anonymous) {
            $info = $this->lng->txt("poll_anonymous_warning");
        } else {
            $info = $this->lng->txt("poll_non_anonymous_warning");
        }
        $tpl->setVariable("ANONIMITY_INFO", $info);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderAnswers()

ilPollContentRenderer::renderAnswers ( ilTemplate  $tpl, ilObjPoll  $poll, int  $user_id  )

protected

Definition at line 139 of file class.ilPollContentRenderer.php.

References ilObjPoll\getNonAnonymous(), ilObjPoll\getVotingPeriodEnd(), renderAnonimityInfo(), and renderMiscVoteInfo().

Referenced by renderAnswersAndResults().

     : void {
        $this->renderMiscVoteInfo(
            $tpl,
            $this->answers->getAnswerLimitForInfo(),
            $poll->getVotingPeriodEnd()
        );
        $this->answers_renderer->render(
            $tpl,
            $this->answers,
            !$this->state->mayUserVote($user_id)
        );
        $this->renderAnonimityInfo($tpl, !$poll->getNonAnonymous());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderAnswersAndResults()

ilPollContentRenderer::renderAnswersAndResults ( ilTemplate  $tpl, ilObjPoll  $poll, int  $user_id  )

protected

Definition at line 98 of file class.ilPollContentRenderer.php.

References ilObjPoll\getVotingPeriodEnd(), renderAnswers(), renderNotAbleToVoteMessage(), renderResults(), and renderTotalParticipantsInfo().

Referenced by render().

     : void {
        $either_is_shown = false;
        if (
            !$this->state->hasUserAlreadyVoted($user_id, $poll) &&
            !$this->state->hasVotingPeriodEnded($poll, false)
        ) {
            $this->renderAnswers($tpl, $poll, $user_id);
            $either_is_shown = true;
        }

        if (
            $this->state->areResultsVisible($user_id, $poll) &&
            $this->results->getTotalVotes()
        ) {
            $this->renderResults($tpl, $poll);
            $this->renderTotalParticipantsInfo(
                $tpl,
                $this->results->getTotalVotes()
            );
            $either_is_shown = true;
        } elseif ($this->state->areResultsVisible($user_id, $poll)) {
            $this->renderTotalParticipantsInfo(
                $tpl,
                $this->results->getTotalVotes()
            );
        }

        if (!$either_is_shown) {
            $this->renderNotAbleToVoteMessage(
                $tpl,
                $this->state->hasUserAlreadyVoted($user_id, $poll),
                $this->state->willResultsBeShown($poll),
                $poll->getVotingPeriodEnd()
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderAvailability()

ilPollContentRenderer::renderAvailability ( ilTemplate  $tpl, ilObjPoll  $poll  )

protected

Definition at line 313 of file class.ilPollContentRenderer.php.

References ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by render().

                                                                           : void
    {
        if ($this->state->isOfflineOrUnavailable($poll)) {
            $tpl->setVariable("TXT_OFFLINE", $this->lng->txt('offline'));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderComments()

ilPollContentRenderer::renderComments ( ilTemplate  $tpl, int  $ref_id  )

protected

Definition at line 325 of file class.ilPollContentRenderer.php.

References ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by render().

                                                                   : void
    {
        $tpl->setVariable("LANG_COMMENTS", $this->lng->txt('poll_comments'));
        $tpl->setVariable("COMMENT_JSCALL", $this->comments->commentJSCall($ref_id));
        $tpl->setVariable("COMMENTS_COUNT_ID", $ref_id);

        $comments_count = $this->comments->getNumberOfComments($ref_id);

        if ($comments_count > 0) {
            $tpl->setVariable("COMMENTS_COUNT", "(" . $comments_count . ")");
        }

        $tpl->setVariable("COMMENTS_REDRAW_URL", $this->comments->getRedrawURL());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderDescription()

ilPollContentRenderer::renderDescription ( ilTemplate  $tpl, string  $description  )

protected

Definition at line 300 of file class.ilPollContentRenderer.php.

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

Referenced by render().

     : void {
        $description = trim($description);
        if ($description) {
            $tpl->setVariable(
                "TXT_DESC",
                nl2br($this->specialCharsAsEntities($description))
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderMiscVoteInfo()

ilPollContentRenderer::renderMiscVoteInfo ( ilTemplate  $tpl, ?int  $answer_limit, int  $deadline  )

protected

Definition at line 234 of file class.ilPollContentRenderer.php.

References getFormattedDate(), ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by renderAnswers().

     : void {
        $infos = [];

        if ($answer_limit) {
            $infos[] = sprintf(
                $this->lng->txt('poll_max_number_of_answers_info'),
                $answer_limit
            );
        }

        if ($deadline) {
            $infos[] = sprintf(
                $this->lng->txt("poll_voting_period_info"),
                $this->getFormattedDate($deadline)
            );
        }

        if ($infos) {
            $tpl->setVariable('VOTE_INFO', implode(' ', $infos));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderNoQuestionMessage()

ilPollContentRenderer::renderNoQuestionMessage ( ilTemplate  $tpl )

protected

Definition at line 285 of file class.ilPollContentRenderer.php.

References getMessageBox(), ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by render().

                                                               : void
    {
        $tpl->setVariable(
            "MESSAGE_BOX",
            $this->getMessageBox(
                $this->lng->txt("poll_block_message_no_answers")
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderNotAbleToVoteMessage()

ilPollContentRenderer::renderNotAbleToVoteMessage ( ilTemplate  $tpl, bool  $has_voted, bool  $results_in_future, int  $voting_end_date  )

protected

Definition at line 185 of file class.ilPollContentRenderer.php.

References $messages, getFormattedDate(), getMessageBox(), ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by renderAnswersAndResults().

     : void {
        $messages = [];

        if ($has_voted) {
            $messages[] = $this->lng->txt("poll_block_message_already_voted");
        } else {
            $messages[] = sprintf(
                $this->lng->txt("poll_voting_period_ended_info"),
                $this->getFormattedDate($voting_end_date)
            );
        }

        if ($results_in_future && $has_voted) {
            $messages[] = sprintf(
                $this->lng->txt("poll_block_results_available_on"),
                $this->getFormattedDate($voting_end_date)
            );
        }

        $tpl->setVariable(
            "MESSAGE_BOX",
            $this->getMessageBox(
                implode(' ', $messages)
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderNotWithinVotingPeriodMessage()

ilPollContentRenderer::renderNotWithinVotingPeriodMessage ( ilTemplate  $tpl, int  $vote_start, int  $vote_end  )

protected

Definition at line 272 of file class.ilPollContentRenderer.php.

References $message, getFormattedDate(), getMessageBox(), ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by render().

     : void {
        $message = sprintf(
            $this->lng->txt("poll_voting_period_full_info"),
            $this->getFormattedDate($vote_start),
            $this->getFormattedDate($vote_end)
        );
        $tpl->setVariable("MESSAGE_BOX", $this->getMessageBox($message));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderQuestion()

ilPollContentRenderer::renderQuestion ( ilTemplate  $tpl, string  $text, ?string  $img_path  )

protected

Definition at line 217 of file class.ilPollContentRenderer.php.

References HTML_Template_IT\setVariable(), ilWACSignedPath\signFile(), and specialCharsAsEntities().

Referenced by render().

     : void {
        $tpl->setVariable(
            "TXT_QUESTION",
            $this->specialCharsAsEntities(nl2br(trim($text)))
        );
        if ($img_path) {
            $tpl->setVariable(
                "URL_IMAGE",
                ilWACSignedPath::signFile($img_path)
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderResults()

ilPollContentRenderer::renderResults ( ilTemplate  $tpl, ilObjPoll  $poll  )

protected

Definition at line 157 of file class.ilPollContentRenderer.php.

References ilObjPoll\getShowResultsAs().

Referenced by renderAnswersAndResults().

     : void {
        $this->results_renderer->render(
            $tpl,
            $this->results,
            $poll->getShowResultsAs()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderTotalParticipantsInfo()

ilPollContentRenderer::renderTotalParticipantsInfo ( ilTemplate  $tpl, int  $total  )

protected

Definition at line 168 of file class.ilPollContentRenderer.php.

References ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by renderAnswersAndResults().

     : void {
        if ($total === 1) {
            $tpl->setVariable(
                "TOTAL_ANSWERS",
                $this->lng->txt("poll_population_singular")
            );
            return;
        }
        $tpl->setVariable(
            "TOTAL_ANSWERS",
            sprintf($this->lng->txt("poll_population"), $total)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

specialCharsAsEntities()

ilPollContentRenderer::specialCharsAsEntities ( string  $string )

protected

Definition at line 354 of file class.ilPollContentRenderer.php.

Referenced by renderDescription(), and renderQuestion().

                                                             : 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

$answers

ilPollAnswersHandler ilPollContentRenderer::$answers

protected

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

Referenced by __construct().

$answers_renderer

ilPollAnswersRenderer ilPollContentRenderer::$answers_renderer

protected

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

Referenced by __construct().

$comments

ilPollCommentsHandler ilPollContentRenderer::$comments

protected

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

Referenced by __construct().

$lng

ilLanguage ilPollContentRenderer::$lng

protected

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

Referenced by __construct().

$results

ilPollResultsHandler ilPollContentRenderer::$results

protected

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

Referenced by __construct().

$results_renderer

ilPollResultsRenderer ilPollContentRenderer::$results_renderer

protected

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

Referenced by __construct().

$state

ilPollStateInfo ilPollContentRenderer::$state

protected

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

$ui_factory

UIFactory ilPollContentRenderer::$ui_factory

protected

Definition at line 34 of file class.ilPollContentRenderer.php.

Referenced by __construct().

$ui_renderer

UIRenderer ilPollContentRenderer::$ui_renderer

protected

Definition at line 35 of file class.ilPollContentRenderer.php.

Referenced by __construct().

---

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

• Modules/Poll/classes/BlockGUI/class.ilPollContentRenderer.php