class.ilPollAnswersHandler.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilPollAnswersHandler
{
    protected string $vote_url;
    protected string $vote_cmd;
    protected int $poll_id;

    protected array $answers;
    protected int $answer_limit;

    public function __construct(
        ilObjPoll $poll,
        string $vote_url,
        string $vote_cmd
    ) {
        $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;
    }

    public function popLastVoteFromSession(): ?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;
    }

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

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

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

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

    public function getAnswerLimit(): int
    {
        return $this->answer_limit;
    }

    public function getVoteURL(): string
    {
        return $this->vote_url;
    }

    public function getVoteCommand(): string
    {
        return $this->vote_cmd;
    }
}