ilPollStateInfo Class Reference

Collaboration diagram for ilPollStateInfo:

Public Member Functions
	isOfflineOrUnavailable (ilObjPoll $poll)
	hasQuestion (ilObjPoll $poll)
	hasVotingPeriodNotStarted (ilObjPoll $poll, bool $default)
	returns default if no voting period is set More...
	hasVotingPeriodEnded (ilObjPoll $poll, bool $default)
	returns default if no voting period is set More...
	hasUserAlreadyVoted (int $user_id, ilObjPoll $poll)
	mayUserVote (int $user_id)
	isUserAnonymous (int $user_id)
	areResultsVisible (int $user_id, ilObjPoll $poll)
	willResultsBeShown (ilObjPoll $poll)

Protected Attributes
array	$cached_user_status = []

Detailed Description

Definition at line 21 of file class.ilPollStateInfo.php.

Member Function Documentation

areResultsVisible()

ilPollStateInfo::areResultsVisible	(	int	$user_id,
		ilObjPoll	$poll
	)

Definition at line 95 of file class.ilPollStateInfo.php.

                                                                    : bool
    {
        switch ($poll->getViewResults()) {
            case ilObjPoll::VIEW_RESULTS_NEVER:
                return false;
 
            case ilObjPoll::VIEW_RESULTS_ALWAYS:
                return true;
 
            case ilObjPoll::VIEW_RESULTS_AFTER_PERIOD:
                return $this->hasVotingPeriodEnded($poll, true);
 
            case ilObjPoll::VIEW_RESULTS_AFTER_VOTE:
                if ($this->hasUserAlreadyVoted($user_id, $poll)) {
                    return true;
                }
                return false;
        }
        return false;
    }

References $user_id, ilObjPoll\getViewResults(), ilObjPoll\VIEW_RESULTS_AFTER_PERIOD, ilObjPoll\VIEW_RESULTS_AFTER_VOTE, ilObjPoll\VIEW_RESULTS_ALWAYS, and ilObjPoll\VIEW_RESULTS_NEVER.

Here is the call graph for this function:

hasQuestion()

ilPollStateInfo::hasQuestion

(

ilObjPoll

$poll

)

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

                                                : bool
    {
        if (count($poll->getAnswers())) {
            return true;
        }
        return false;
    }

References ilObjPoll\getAnswers().

Here is the call graph for this function:

hasUserAlreadyVoted()

ilPollStateInfo::hasUserAlreadyVoted	(	int	$user_id,
		ilObjPoll	$poll
	)

Definition at line 77 of file class.ilPollStateInfo.php.

                                                                      : bool
    {
        if (!array_key_exists($user_id, $this->cached_user_status)) {
            $this->cached_user_status[$user_id] = $poll->hasUserVoted($user_id);
        }
        return $this->cached_user_status[$user_id];
    }

References $user_id, and ilObjPoll\hasUserVoted().

Here is the call graph for this function:

hasVotingPeriodEnded()

ilPollStateInfo::hasVotingPeriodEnded	(	ilObjPoll	$poll,
		bool	$default
	)

returns default if no voting period is set

Definition at line 64 of file class.ilPollStateInfo.php.

     : bool {
        if (!$poll->getVotingPeriod()) {
            return $default;
        }
        if ($poll->getVotingPeriodEnd() < time()) {
            return true;
        }
        return false;
    }

hasVotingPeriodNotStarted()

ilPollStateInfo::hasVotingPeriodNotStarted	(	ilObjPoll	$poll,
		bool	$default
	)

returns default if no voting period is set

Definition at line 48 of file class.ilPollStateInfo.php.

     : bool {
        if (!$poll->getVotingPeriod()) {
            return $default;
        }
        if ($poll->getVotingPeriodBegin() > time()) {
            return true;
        }
        return false;
    }

isOfflineOrUnavailable()

ilPollStateInfo::isOfflineOrUnavailable

(

ilObjPoll

$poll

)

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

                                                           : bool
    {
        $offline = $poll->getOfflineStatus();
        $before_start = false;
        $after_end = false;
        if ($poll->getAccessType() === ilObjectActivation::TIMINGS_ACTIVATION) {
            $before_start = $poll->getAccessBegin() > time();
            $after_end = $poll->getAccessEnd() < time();
        }
        return $offline || $before_start || $after_end;
    }

References ilObjPoll\getAccessBegin(), ilObjPoll\getAccessEnd(), ilObjPoll\getAccessType(), ilObject\getOfflineStatus(), and ilObjectActivation\TIMINGS_ACTIVATION.

Here is the call graph for this function:

isUserAnonymous()

ilPollStateInfo::isUserAnonymous

(

int

$user_id

)

Definition at line 90 of file class.ilPollStateInfo.php.

                                                 : bool
    {
        return $user_id === ANONYMOUS_USER_ID;
    }

References $user_id, and ANONYMOUS_USER_ID.

mayUserVote()

ilPollStateInfo::mayUserVote

(

int

$user_id

)

Definition at line 85 of file class.ilPollStateInfo.php.

                                             : bool
    {
        return !$this->isUserAnonymous($user_id);
    }

References $user_id.

willResultsBeShown()

ilPollStateInfo::willResultsBeShown

(

ilObjPoll

$poll

)

Definition at line 116 of file class.ilPollStateInfo.php.

                                                       : bool
    {
        if (
            $poll->getViewResults() !== ilObjPoll::VIEW_RESULTS_AFTER_PERIOD ||
            $this->hasVotingPeriodEnded($poll, false)
        ) {
            return false;
        }
        return true;
    }

References ilObjPoll\getViewResults(), and ilObjPoll\VIEW_RESULTS_AFTER_PERIOD.

Here is the call graph for this function:

Field Documentation

$cached_user_status

array ilPollStateInfo::$cached_user_status = []

protected

Definition at line 23 of file class.ilPollStateInfo.php.

---

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

• components/ILIAS/Poll/classes/BlockGUI/class.ilPollStateInfo.php