ilPollBlock Class Reference

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

Inheritance diagram for ilPollBlock:

Collaboration diagram for ilPollBlock:

Public Member Functions
	__construct (int $a_id=0)
	setRefId (int $a_id)
	Set ref id (needed for poll access) More...
	getPoll ()
	hasAnyContent (int $a_user_id, int $a_ref_id)
	Check if user will see any content (vote/result) More...
	maySeeQuestion ($a_user_id)
	mayVote ($a_user_id)
	mayNotResultsYet ()
	maySeeResults (int $a_user_id)
	getMessage (int $a_user_id)
	showResultsAs ()
	Show Results as (Barchart or Piechart) More...
	showComments ()
	Are comments enabled or disabled. More...
Public Member Functions inherited from ilCustomBlock
	__construct (int $a_id=0)
	setId (int $a_id)
	getId ()
	setContextObjId (int $a_context_obj_id)
	getContextObjId ()
	setContextObjType (string $a_context_obj_type)
	getContextObjType ()
	setContextSubObjId (int $a_context_sub_obj_id)
	getContextSubObjId ()
	setContextSubObjType (string $a_context_sub_obj_type)
	getContextSubObjType ()
	setType (string $a_type)
	getType ()
	setTitle (string $a_title)
	getTitle ()
	create ()
	read ()
	update ()
	delete ()
	queryBlocksForContext (bool $a_include_sub_obj=true)
	Query BlocksForContext. More...
	queryCntBlockForContext ()

Protected Attributes
ilLanguage	$lng
ilObjPoll	$poll
array	$answers = []
bool	$visible = false
bool	$active = false
Protected Attributes inherited from ilCustomBlock
ilDBInterface	$db
int	$id = 0
int	$context_obj_id = 0
string	$context_obj_type = ""
int	$context_sub_obj_id = 0
string	$context_sub_obj_type = ""
string	$type = ""
string	$title = ""

Additional Inherited Members
Static Public Member Functions inherited from ilCustomBlock
static	multiBlockQuery (string $a_context_obj_type, array $a_context_obj_ids)

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 Custom block for polls

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilPollBlock::__construct

(

int

$a_id = 0

)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().

    {
        global $DIC;

        parent::__construct($a_id);
        $this->lng = $DIC->language();
    }

Here is the call graph for this function:

Member Function Documentation

getMessage()

ilPollBlock::getMessage

(

int

$a_user_id

)

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

References ilDatePresentation\formatDate(), IL_CAL_UNIX, and ILIAS\Repository\lng().

                                              : ?string
    {
        if (!count($this->answers)) {
            return $this->lng->txt("poll_block_message_no_answers");
        }

        if (!$this->active) {
            if ($this->poll->getOfflineStatus()) {
                return $this->lng->txt("poll_block_message_offline");
            }
            if ($this->poll->getAccessBegin() > time()) {
                $date = ilDatePresentation::formatDate(new ilDateTime($this->poll->getAccessBegin(), IL_CAL_UNIX));
                return sprintf($this->lng->txt("poll_block_message_inactive"), $date);
            }
        }

        return null;
    }

Here is the call graph for this function:

getPoll()

ilPollBlock::getPoll

(

)

Definition at line 52 of file class.ilPollBlock.php.

References $poll.

                             : ilObjPoll
    {
        return $this->poll;
    }

hasAnyContent()

ilPollBlock::hasAnyContent	(	int	$a_user_id,
		int	$a_ref_id
	)

Check if user will see any content (vote/result)

Definition at line 60 of file class.ilPollBlock.php.

References ilObjPollAccess\_isActivated(), maySeeQuestion(), and maySeeResults().

                                                                : bool
    {
        if (!count($this->answers)) {
            return false;
        }

        $this->active = ilObjPollAccess::_isActivated($a_ref_id);
        if (!$this->active) {
            return false;
        }

        if (!$this->maySeeQuestion($a_user_id) &&
            !$this->maySeeResults($a_user_id)) {
            return false;
        }

        return true;
    }

Here is the call graph for this function:

mayNotResultsYet()

ilPollBlock::mayNotResultsYet

(

)

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

References ilObjPoll\VIEW_RESULTS_AFTER_PERIOD.

                                      : bool
    {
        if ($this->poll->getViewResults() === ilObjPoll::VIEW_RESULTS_AFTER_PERIOD &&
            $this->poll->getVotingPeriod() &&
            $this->poll->getVotingPeriodEnd() > time()) {
            return true;
        }
        return false;
    }

maySeeQuestion()

ilPollBlock::maySeeQuestion

(

$a_user_id

)

Definition at line 79 of file class.ilPollBlock.php.

Referenced by hasAnyContent(), and mayVote().

                                              : bool
    {
        if (!$this->active) {
            return false;
        }

        if ($this->poll->hasUserVoted($a_user_id)) {
            return false;
        }

        if ($this->poll->getVotingPeriod() &&
            ($this->poll->getVotingPeriodBegin() > time() ||
            $this->poll->getVotingPeriodEnd() < time())) {
            return false;
        }

        return true;
    }

Here is the caller graph for this function:

maySeeResults()

ilPollBlock::maySeeResults

(

int

$a_user_id

)

Definition at line 113 of file class.ilPollBlock.php.

References ilObjPoll\VIEW_RESULTS_AFTER_PERIOD, ilObjPoll\VIEW_RESULTS_AFTER_VOTE, ilObjPoll\VIEW_RESULTS_ALWAYS, and ilObjPoll\VIEW_RESULTS_NEVER.

Referenced by hasAnyContent().

                                                 : bool
    {
        if (!$this->active) {
            return false;
        }

        switch ($this->poll->getViewResults()) {
            case ilObjPoll::VIEW_RESULTS_NEVER:
                return false;

            case ilObjPoll::VIEW_RESULTS_ALWAYS:
                // fallthrough

                // #12023 - see mayNotResultsYet()
            case ilObjPoll::VIEW_RESULTS_AFTER_PERIOD:
                return true;

            case ilObjPoll::VIEW_RESULTS_AFTER_VOTE:
                if ($this->poll->hasUserVoted($a_user_id)) {
                    return true;
                }
                return false;
        }
        return false;
    }

Here is the caller graph for this function:

mayVote()

ilPollBlock::mayVote

(

$a_user_id

)

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

References ANONYMOUS_USER_ID, and maySeeQuestion().

                                       : bool
    {
        return $this->maySeeQuestion($a_user_id) && $a_user_id != ANONYMOUS_USER_ID;
    }

Here is the call graph for this function:

setRefId()

ilPollBlock::setRefId

(

int

$a_id

)

Set ref id (needed for poll access)

Definition at line 46 of file class.ilPollBlock.php.

                                       : void
    {
        $this->poll = new ilObjPoll($a_id, true);
        $this->answers = $this->poll->getAnswers();
    }

showComments()

ilPollBlock::showComments

(

)

Are comments enabled or disabled.

Definition at line 169 of file class.ilPollBlock.php.

                                  : bool
    {
        return $this->poll->getShowComments();
    }

showResultsAs()

ilPollBlock::showResultsAs

(

)

Show Results as (Barchart or Piechart)

Definition at line 161 of file class.ilPollBlock.php.

                                   : int
    {
        return $this->poll->getShowResultsAs();
    }

Field Documentation

$active

bool ilPollBlock::$active = false

protected

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

$answers

array ilPollBlock::$answers = []

protected

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

$lng

ilLanguage ilPollBlock::$lng

protected

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

$poll

ilObjPoll ilPollBlock::$poll

protected

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

Referenced by getPoll().

$visible

bool ilPollBlock::$visible = false

protected

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

---

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

• Modules/Poll/classes/class.ilPollBlock.php