Custom block for polls. More...

Inheritance diagram for ilPollBlock:

Collaboration diagram for ilPollBlock:

Public Member Functions
	__construct ($a_id=0)
	Constructor. More...

	setRefId ($a_id)
	Set ref id (needed for poll access) More...

	getPoll ()
	Get poll object. More...

	hasAnyContent ($a_user_id, $a_ref_id)
	Check if user will see any content (vote/result) More...

	mayVote ($a_user_id)

	mayNotResultsYet ()

	maySeeResults ($a_user_id)

	getMessage ($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 ($a_id=0)
	Constructor. More...

	setId ($a_id)
	Set Id. More...

	getId ()
	Get Id. More...

	setContextObjId ($a_context_obj_id)
	Set ContextObjId. More...

	getContextObjId ()
	Get ContextObjId. More...

	setContextObjType ($a_context_obj_type)
	Set ContextObjType. More...

	getContextObjType ()
	Get ContextObjType. More...

	setContextSubObjId ($a_context_sub_obj_id)
	Set ContextSubObjId. More...

	getContextSubObjId ()
	Get ContextSubObjId. More...

	setContextSubObjType ($a_context_sub_obj_type)
	Set ContextSubObjType. More...

	getContextSubObjType ()
	Get ContextSubObjType. More...

	setType ($a_type)
	Set Type. More...

	getType ()
	Get Type. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	create ()
	Create new item. More...

	read ()
	Read item from database. More...

	update ()
	Update item in database. More...

	delete ()
	Delete item from database. More...

	querygetBlocksForContext ()
	Query getBlocksForContext. More...

	queryBlocksForContext ($a_include_sub_obj=true)
	Query BlocksForContext. More...

	queryTitleForId ()
	Query TitleForId. More...

	queryCntBlockForContext ()
	Query CntBlockForContext. More...

Protected Attributes
	$lng

	$poll

	$answers

	$visible

	$active

Protected Attributes inherited from ilCustomBlock
	$db

	$id

	$context_obj_id

	$context_obj_type

	$context_sub_obj_id

	$context_sub_obj_type

	$type

	$title

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

Detailed Description

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilPollBlock::__construct ( $a_id = 0 )

Constructor.

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

References $DIC.

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

Member Function Documentation

◆ getMessage()

ilPollBlock::getMessage ( $a_user_id )

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

References $lng, ilDatePresentation\formatDate(), and IL_CAL_UNIX.

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

Here is the call graph for this function:

◆ getPoll()

ilPollBlock::getPoll ( )

Get poll object.

Returns: ilObjPoll

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

References $poll.

     {
         return $this->poll;
     }

◆ hasAnyContent()

ilPollBlock::hasAnyContent	(	$a_user_id,
		$a_ref_id
	)

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

Parameters

int $a_user_id

Returns: boolean

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

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

     {
         if (!sizeof($this->answers)) {
             return false;
         }
         
         include_once "Modules/Poll/classes/class.ilObjPollAccess.php";
         $this->active = ilObjPollAccess::_isActivated($a_ref_id);
         if (!$this->active) {
             return false;
         }
         
         if (!$this->mayVote($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 107 of file class.ilPollBlock.php.

References ilObjPoll\VIEW_RESULTS_AFTER_PERIOD.

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

◆ maySeeResults()

ilPollBlock::maySeeResults ( $a_user_id )

Definition at line 117 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().

     {
         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;
         }
     }

Here is the caller graph for this function:

◆ mayVote()

ilPollBlock::mayVote ( $a_user_id )

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

Referenced by hasAnyContent().

     {
         if (!$this->active) {
             return false;
         }
         
         if ($a_user_id == ANONYMOUS_USER_ID) {
             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:

◆ setRefId()

ilPollBlock::setRefId ( $a_id )

Set ref id (needed for poll access)

Parameters

int $a_id

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

     {
         include_once "Modules/Poll/classes/class.ilObjPoll.php";
         $this->poll = new ilObjPoll($a_id, true);
         $this->answers = $this->poll->getAnswers();
     }

◆ showComments()

ilPollBlock::showComments ( )

Are Comments enabled or disabled.

Returns: bool

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

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

◆ showResultsAs()

ilPollBlock::showResultsAs ( )

Show Results as (Barchart or Piechart)

Returns: int

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

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

Field Documentation

◆ $active

ilPollBlock::$active

protected

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

◆ $answers

ilPollBlock::$answers

protected

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

◆ $lng

ilPollBlock::$lng

protected

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

Referenced by getMessage().

◆ $poll

ilPollBlock::$poll

protected

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

Referenced by getPoll().

◆ $visible

ilPollBlock::$visible

protected

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

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

Modules/Poll/classes/class.ilPollBlock.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getMessage()

◆ getPoll()

◆ hasAnyContent()

◆ mayNotResultsYet()

◆ maySeeResults()

◆ mayVote()

◆ setRefId()

◆ showComments()

◆ showResultsAs()

Field Documentation

◆ $active

◆ $answers

◆ $lng

◆ $poll

◆ $visible