BlockGUI class for polls. More...

Inheritance diagram for ilPollBlockGUI:

Collaboration diagram for ilPollBlockGUI:

Public Member Functions
	__construct ()

	getBlockType ()

	setBlock (ilPollBlock $a_block)

	executeCommand ()

	fillRow (array $a_set)

	getHTML ()

	getNumberOfCommentsForRedraw ()

Public Member Functions inherited from ilBlockGUI
	__construct ()

	getBlockType ()

	setData (array $a_data)

	getData ()

	setPresentation (int $type)

	getPresentation ()

	setBlockId (string $a_block_id="0")

	getBlockId ()

	setGuiObject (object $a_gui_object)
	Set GuiObject. More...

	getGuiObject ()

	setTitle (string $a_title)

	getTitle ()

	setOffset (int $a_offset)

	getOffset ()

	checkOffset (int $offset)

	setLimit (int $a_limit)

	getLimit ()

	setEnableEdit (bool $a_enableedit)

	getEnableEdit ()

	setRepositoryMode (bool $a_repositorymode)

	getRepositoryMode ()

	setSubtitle (string $a_subtitle)

	getSubtitle ()

	setRefId (int $a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...

	getRefId ()

	setAdminCommands (bool $a_admincommands)

	getAdminCommands ()

	setEnableNumInfo (bool $a_enablenuminfo)

	getEnableNumInfo ()

	setProperties (array $a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...

	getProperty (string $a_property)

	setProperty (string $a_property, string $a_value)

	setRowTemplate (string $a_rowtemplatename, string $a_rowtemplatedir="")
	Set Row Template Name. More...

	getNavParameter ()

	getConfigParameter ()

	getMoveParameter ()

	getRowTemplateName ()

	getRowTemplateDir ()

	addBlockCommand (string $a_href, string $a_text, string $a_onclick="", ?RoundTrip $modal=null)

	getBlockCommands ()

	getHTML ()

	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...

	getPaginationViewControl ()
	Fill previous/next row. More...

	getViewControlsForPanel ()

	sortObject ()

	addSortOption (string $option, string $label, bool $active)

	setSortTarget (string $target)

	addPresentation (string $label, string $target, bool $active)

	getNoItemFoundContent ()

Static Public Attributes
static string	$block_type = "poll"

static bool	$js_init = false

Protected Member Functions
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...

	getRepositoryObjectGUIName ()

	initContentRenderer ()

	initJS ()

	getCommentsRedrawURL ()

	getVoteURL ()

	getLegacyContent ()
	Get legacy content. More...

Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...

	specialCharsAsEntities (string $string)

	initCommands ()

	preloadData (array $data)
	Can be overwritten in subclasses. More...

	getLegacyContent ()
	Get legacy content. More...

	getListItemForData (array $data)
	Get list item for data array. More...

	handleNavigation ()
	Handle navigation. More...

	loadData ()
	Load data for current page. More...

	getListItemGroups ()
	Get items. More...

	addRepoCommands ()
	Add repo commands. More...

	getActionsForPanel ()

	send (string $output)
	Send. More...

Protected Attributes
ilPollBlock	$poll_block

UIFactory	$ui_factory

UIRenderer	$ui_renderer

Refinery	$refinery

DataFactory	$data_factory

ilPollStateInfo	$state

ilPollCommentsHandler	$comments

ilPollImageFactoryInterface	$poll_image_factory

Protected Attributes inherited from ilBlockGUI
ILIAS UI Renderer	$renderer

Factory	$factory

object	$gui_object

ILIAS Container Block StandardGUIRequest	$request

ILIAS Container Block BlockManager	$block_manager

bool	$repositorymode = false

ILIAS DI UIServices	$ui

array	$data = array()

bool	$enablenuminfo = true

array	$footer_links = array()

string	$block_id = "0"

bool	$allow_moving = true

array	$move = array("left" => false, "right" => false, "up" => false, "down" => false)

array	$block_commands = array()

int	$max_count = 0

bool	$close_command = false

bool	$image = false

array	$property = []

string	$nav_value = ""

string	$css_row = ""

string	$title = ""

bool	$admincommands = false

array	$dropdown

ilTemplate	$tpl

ilGlobalTemplateInterface	$main_tpl

ilObjUser	$user

ilCtrl	$ctrl

ilAccessHandler	$access

ilLanguage	$lng

ilObjectDefinition	$obj_def

int	$presentation

int	$requested_ref_id

Additional Inherited Members
Static Public Member Functions inherited from ilBlockGUI
static	getScreenMode ()

Data Fields inherited from ilBlockGUI
const	PRES_MAIN_LEG = 0

const	PRES_SEC_LEG = 1

const	PRES_SEC_LIST = 2

const	PRES_MAIN_LIST = 3

const	PRES_MAIN_TILE = 4

Detailed Description

BlockGUI class for polls.

Author: Jörg Lützenkirchen @ilCtrl_IsCalledBy ilPollBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilPollBlockGUI::__construct ( )

Reimplemented from ilBlockGUI.

Definition at line 47 of file class.ilPollBlockGUI.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->access = $DIC->access();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->data_factory = new DataFactory();
        $this->refinery = $DIC->refinery();
 
        parent::__construct();
 
        $this->lng->loadLanguageModule("poll");
        $this->setRowTemplate("tpl.block.html", "components/ILIAS/Poll");
        $this->poll_image_factory = new ilPollImageFactory();
        $this->comments = new ilPollCommentsHandler(
            $DIC->notes(),
            $DIC->http(),
            $DIC->refinery(),
            $this->getCommentsRedrawURL()
        );
        $this->state = new ilPollStateInfo();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilBlockGUI\setRowTemplate(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilPollBlockGUI::executeCommand ( )

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

                                    : void
    {
        $next_class = $this->ctrl->getNextClass();
        $cmd = $this->ctrl->getCmd("getHTML");
 
        switch ($next_class) {
            default:
                $this->$cmd();
                break;
        }
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ fillRow()

ilPollBlockGUI::fillRow ( array $a_set )

Definition at line 107 of file class.ilPollBlockGUI.php.

                                         : void
    {
        if ($this->poll_block->getPoll()->getShowComments()) {
            $this->initJS();
        }
 
        $this->initContentRenderer()->render(
            $this->tpl,
            $this->getRefId(),
            $this->user->getId(),
            $this->poll_block->getPoll(),
            $this->getAdminCommands()
        );
    }

References ilBlockGUI\getRefId(), initContentRenderer(), initJS(), and ILIAS\Repository\user().

Referenced by getLegacyContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBlockType()

ilPollBlockGUI::getBlockType ( )

Reimplemented from ilBlockGUI.

Definition at line 74 of file class.ilPollBlockGUI.php.

                                  : string
    {
        return self::$block_type;
    }

References $block_type.

◆ getCommentsRedrawURL()

ilPollBlockGUI::getCommentsRedrawURL ( )

protected

Definition at line 235 of file class.ilPollBlockGUI.php.

                                             : string
    {
        return $this->ctrl->getLinkTarget(
            $this,
            "getNumberOfCommentsForRedraw",
            "",
            true
        );
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getHTML()

ilPollBlockGUI::getHTML ( )

Reimplemented from ilBlockGUI.

Definition at line 122 of file class.ilPollBlockGUI.php.

                             : string
    {
        $this->poll_block->setRefId($this->getRefId());
        $may_write = $this->access->checkAccess("write", "", $this->getRefId());
 
        $poll_obj = $this->poll_block->getPoll();
        $this->setTitle($poll_obj->getTitle());
        $this->setData([[$poll_obj]]);
 
        $this->ctrl->setParameterByClass(
            $this->getRepositoryObjectGUIName(),
            "ref_id",
            $this->getRefId()
        );
 
        if (
            !$this->state->isOfflineOrUnavailable($this->poll_block->getPoll()) &&
            !$this->user->isAnonymous()
        ) {
            // notification
            if (ilNotification::hasNotification(ilNotification::TYPE_POLL, $this->user->getId(), $this->poll_block->getPoll()->getId())) {
                $this->addBlockCommand(
                    $this->ctrl->getLinkTargetByClass(
                        array("ilrepositorygui", $this->getRepositoryObjectGUIName()),
                        "unsubscribe"
                    ),
                    $this->lng->txt("poll_notification_unsubscribe")
                );
            } else {
                $this->addBlockCommand(
                    $this->ctrl->getLinkTargetByClass(
                        array("ilrepositorygui", $this->getRepositoryObjectGUIName()),
                        "subscribe"
                    ),
                    $this->lng->txt("poll_notification_subscribe")
                );
            }
        }
 
        if ($may_write) {
            // edit
            $this->addBlockCommand(
                $this->ctrl->getLinkTargetByClass(
                    array("ilrepositorygui", $this->getRepositoryObjectGUIName()),
                    "render"
                ),
                $this->lng->txt("poll_edit_question")
            );
            $this->addBlockCommand(
                $this->ctrl->getLinkTargetByClass(
                    array("ilrepositorygui", $this->getRepositoryObjectGUIName()),
                    "edit"
                ),
                $this->lng->txt("settings")
            );
            $this->addBlockCommand(
                $this->ctrl->getLinkTargetByClass(
                    array("ilrepositorygui", $this->getRepositoryObjectGUIName()),
                    "showParticipants"
                ),
                $this->lng->txt("poll_result")
            );
        }
 
        $this->ctrl->clearParametersByClass($this->getRepositoryObjectGUIName());
 
        return parent::getHTML();
    }

References ILIAS\Repository\access(), ilBlockGUI\addBlockCommand(), ILIAS\Repository\ctrl(), ilBlockGUI\getRefId(), getRepositoryObjectGUIName(), ilNotification\hasNotification(), ILIAS\Repository\lng(), ilBlockGUI\setData(), ilBlockGUI\setTitle(), ilNotification\TYPE_POLL, and ILIAS\Repository\user().

Here is the call graph for this function:

◆ getLegacyContent()

ilPollBlockGUI::getLegacyContent ( )

protected

Get legacy content.

Returns: string

Reimplemented from ilBlockGUI.

Definition at line 266 of file class.ilPollBlockGUI.php.

                                         : string
    {
        $this->tpl = new ilTemplate(
            $this->getRowTemplateName(),
            true,
            true,
            $this->getRowTemplateDir()
        );
        $this->fillRow(current($this->getData()));
        return $this->tpl->get();
    }

References fillRow(), ilBlockGUI\getData(), ilBlockGUI\getRowTemplateDir(), and ilBlockGUI\getRowTemplateName().

Here is the call graph for this function:

◆ getNumberOfCommentsForRedraw()

ilPollBlockGUI::getNumberOfCommentsForRedraw ( )

Definition at line 261 of file class.ilPollBlockGUI.php.

                                                  : void
    {
        $this->comments->getNumberOfCommentsForRedraw();
    }

◆ getRepositoryObjectGUIName()

ilPollBlockGUI::getRepositoryObjectGUIName ( )

protected

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

                                                   : string
    {
        return "ilobjpollgui";
    }

Referenced by getHTML(), and getVoteURL().

Here is the caller graph for this function:

◆ getVoteURL()

ilPollBlockGUI::getVoteURL ( )

protected

Definition at line 245 of file class.ilPollBlockGUI.php.

                                   : string
    {
        $this->ctrl->setParameterByClass(
            $this->getRepositoryObjectGUIName(),
            "ref_id",
            $this->getRefId()
        );
        $url = $this->ctrl->getLinkTargetByClass(
            array("ilrepositorygui", $this->getRepositoryObjectGUIName()),
            "vote"
        );
        $this->ctrl->clearParametersByClass($this->getRepositoryObjectGUIName());
 
        return $url .= "#poll" . $this->poll_block->getPoll()->getID();
    }

References $url, ILIAS\Repository\ctrl(), ilBlockGUI\getRefId(), and getRepositoryObjectGUIName().

Here is the call graph for this function:

◆ initContentRenderer()

ilPollBlockGUI::initContentRenderer ( )

protected

Definition at line 191 of file class.ilPollBlockGUI.php.

                                            : ilPollContentRenderer
    {
        $answers = new ilPollAnswersHandler(
            $this->poll_block->getPoll(),
            $this->getVoteURL(),
            'vote'
        );
        $results = new ilPollResultsHandler(
            $this->poll_block->getPoll(),
            $answers
        );
        return new ilPollContentRenderer(
            $this->lng,
            $this->ui_factory,
            $this->ui_renderer,
            $this->refinery,
            $this->state,
            $this->comments,
            $answers,
            new ilPollAnswersRenderer(
                $this->lng,
                $this->refinery
            ),
            $results,
            new ilPollResultsRenderer(
                $this->getRefId(),
                $this->refinery,
                $this->data_factory,
                $this->ui_factory,
                $this->ui_renderer,
                $this->lng
            ),
            $this->poll_image_factory
        );
    }

References $results, ilBlockGUI\getRefId(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initJS()

ilPollBlockGUI::initJS ( )

protected

Definition at line 227 of file class.ilPollBlockGUI.php.

                               : void
    {
        if (!self::$js_init) {
            $this->main_tpl->addJavaScript("assets/js/ilPoll.js");
            self::$js_init = true;
        }
    }

Referenced by fillRow().

Here is the caller graph for this function:

◆ isRepositoryObject()

ilPollBlockGUI::isRepositoryObject ( )

protected

Returns whether block has a corresponding repository object.

Reimplemented from ilBlockGUI.

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

                                           : bool
    {
        return true;
    }

◆ setBlock()

ilPollBlockGUI::setBlock ( ilPollBlock $a_block )

Definition at line 89 of file class.ilPollBlockGUI.php.

                                                  : void
    {
        $this->setBlockId((string) $a_block->getId());
        $this->poll_block = $a_block;
    }

References ilCustomBlock\getId(), and ilBlockGUI\setBlockId().

Here is the call graph for this function:

Field Documentation

◆ $block_type

string ilPollBlockGUI::$block_type = "poll"

static

Definition at line 36 of file class.ilPollBlockGUI.php.

Referenced by getBlockType().

◆ $comments

ilPollCommentsHandler ilPollBlockGUI::$comments

protected

Definition at line 44 of file class.ilPollBlockGUI.php.

◆ $data_factory

DataFactory ilPollBlockGUI::$data_factory

protected

Definition at line 42 of file class.ilPollBlockGUI.php.

◆ $js_init

bool ilPollBlockGUI::$js_init = false

static

Definition at line 38 of file class.ilPollBlockGUI.php.

◆ $poll_block

ilPollBlock ilPollBlockGUI::$poll_block

protected

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

◆ $poll_image_factory

ilPollImageFactoryInterface ilPollBlockGUI::$poll_image_factory

protected

Definition at line 45 of file class.ilPollBlockGUI.php.

◆ $refinery

Refinery ilPollBlockGUI::$refinery

protected

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

◆ $state

ilPollStateInfo ilPollBlockGUI::$state

protected

Definition at line 43 of file class.ilPollBlockGUI.php.

◆ $ui_factory

UIFactory ilPollBlockGUI::$ui_factory

protected

Definition at line 39 of file class.ilPollBlockGUI.php.

◆ $ui_renderer

UIRenderer ilPollBlockGUI::$ui_renderer

protected

Definition at line 40 of file class.ilPollBlockGUI.php.

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

components/ILIAS/Poll/classes/BlockGUI/class.ilPollBlockGUI.php

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ fillRow()

◆ getBlockType()

◆ getCommentsRedrawURL()

◆ getHTML()

◆ getLegacyContent()

◆ getNumberOfCommentsForRedraw()

◆ getRepositoryObjectGUIName()

◆ getVoteURL()

◆ initContentRenderer()

◆ initJS()

◆ isRepositoryObject()

◆ setBlock()

Field Documentation

◆ $block_type

◆ $comments

◆ $data_factory

◆ $js_init

◆ $poll_block

◆ $poll_image_factory

◆ $refinery

◆ $state

◆ $ui_factory

◆ $ui_renderer