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

Collaboration diagram for ilPollAnswersHandler:

Public Member Functions
	__construct (ilObjPoll $poll, string $vote_url, string $vote_cmd)

	popLastVoteFromSession ()
	TODO session handling should get its own class. More...

	getAnswers ()

	getAnswer (int $id)

	getNumberOfAnswers ()

	getAnswerLimitForInfo ()

	getAnswerLimit ()

	getVoteURL ()

	getVoteCommand ()

Protected Attributes
string	$vote_url

string	$vote_cmd

int	$poll_id

array	$answers

int	$answer_limit

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.ilPollAnswersHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ilPollAnswersHandler::__construct	(	ilObjPoll	$poll,
		string	$vote_url,
		string	$vote_cmd
	)

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

References $answers, $id, $vote_cmd, $vote_url, ilObjPoll\getAnswers(), ilObject\getId(), ilObjPoll\getMaxNumberOfAnswers(), and ILIAS\Repository\int().

       {
         $this->vote_url = $vote_url;
         $this->vote_cmd = $vote_cmd;
         $this->answer_limit = $poll->getMaxNumberOfAnswers();
         $this->poll_id = $poll->getId();
 
         $answers = [];
         foreach ($poll->getAnswers() as $answer) {
             $id = (int) ($answer['id'] ?? 0);
             $text = (string) ($answer['answer'] ?? '');
             $answers[$id] = $text;
         }
         $this->answers = $answers;
     }

Here is the call graph for this function:

Member Function Documentation

◆ getAnswer()

ilPollAnswersHandler::getAnswer ( int $id )

Definition at line 78 of file class.ilPollAnswersHandler.php.

References $id.

                                       : string
     {
         return (string) ($this->answers[$id] ?? '');
     }

◆ getAnswerLimit()

ilPollAnswersHandler::getAnswerLimit ( )

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

References $answer_limit.

Referenced by getAnswerLimitForInfo(), and ilPollAnswersRenderer\render().

                                     : int
     {
         return $this->answer_limit;
     }

Here is the caller graph for this function:

◆ getAnswerLimitForInfo()

ilPollAnswersHandler::getAnswerLimitForInfo ( )

Definition at line 88 of file class.ilPollAnswersHandler.php.

References getAnswerLimit(), and getNumberOfAnswers().

                                            : ?int
     {
         $single_answer = $this->getAnswerLimit() === 1;
         $below_max = $this->getNumberOfAnswers() > $this->getAnswerLimit();
         if ($below_max && !$single_answer) {
             return $this->getAnswerLimit();
         }
         return null;
     }

Here is the call graph for this function:

◆ getAnswers()

ilPollAnswersHandler::getAnswers ( )

Returns: Generator|string[]

Definition at line 71 of file class.ilPollAnswersHandler.php.

References $id.

Referenced by ilPollAnswersRenderer\render().

                                 : Generator
     {
         foreach ($this->answers as $id => $answer) {
             yield $id => $answer;
         }
     }

Here is the caller graph for this function:

◆ getNumberOfAnswers()

ilPollAnswersHandler::getNumberOfAnswers ( )

Definition at line 83 of file class.ilPollAnswersHandler.php.

Referenced by getAnswerLimitForInfo().

                                         : int
     {
         return count($this->answers);
     }

Here is the caller graph for this function:

◆ getVoteCommand()

ilPollAnswersHandler::getVoteCommand ( )

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

References $vote_cmd.

Referenced by ilPollAnswersRenderer\render().

                                     : string
     {
         return $this->vote_cmd;
     }

Here is the caller graph for this function:

◆ getVoteURL()

ilPollAnswersHandler::getVoteURL ( )

Definition at line 103 of file class.ilPollAnswersHandler.php.

References $vote_url.

Referenced by ilPollAnswersRenderer\render().

                                 : string
     {
         return $this->vote_url;
     }

Here is the caller graph for this function:

◆ popLastVoteFromSession()

ilPollAnswersHandler::popLastVoteFromSession ( )

TODO session handling should get its own class.

Definition at line 56 of file class.ilPollAnswersHandler.php.

References $poll_id, ilSession\get(), and ilSession\set().

Referenced by ilPollAnswersRenderer\render().

                                             : ?array
     {
         $session_last_poll_vote = ilSession::get('last_poll_vote');
         if (isset($session_last_poll_vote[$this->poll_id])) {
             $last_vote = $session_last_poll_vote[$this->poll_id];
             unset($session_last_poll_vote[$this->poll_id]);
             ilSession::set('last_poll_vote', $session_last_poll_vote);
             return $last_vote;
         }
         return null;
     }