class.ilPollBlockGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once("./Services/Block/classes/class.ilBlockGUI.php");
include_once("./Modules/Poll/classes/class.ilObjPoll.php");

class ilPollBlockGUI extends ilBlockGUI
{
    public static $block_type = "poll";

    protected $poll_block; // [ilPollBlock]

    public static $js_init = false;

    public function __construct()
    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->access = $DIC->access();
        $lng = $DIC->language();

        parent::__construct();

        $lng->loadLanguageModule("poll");
        $this->setRowTemplate("tpl.block.html", "Modules/Poll");
    }

    public function getBlockType() : string
    {
        return self::$block_type;
    }

    protected function isRepositoryObject() : bool
    {
        return true;
    }

    protected function getRepositoryObjectGUIName()
    {
        return "ilobjpollgui";
    }

    public static function getScreenMode()
    {
        return IL_SCREEN_SIDE;
    }

    public function setBlock($a_block)
    {
        $this->setBlockId($a_block->getId());
        $this->poll_block = $a_block;
    }

    public function executeCommand()
    {
        $ilCtrl = $this->ctrl;

        $next_class = $ilCtrl->getNextClass();
        $cmd = $ilCtrl->getCmd("getHTML");

        switch ($next_class) {
            default:
                return $this->$cmd();
        }
    }

    public function fillRow($a_poll)
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilUser = $this->user;
        $tpl = $this->main_tpl;


        // handle messages

        $mess = $this->poll_block->getMessage($ilUser->getId());
        if ($mess) {
            $this->tpl->setVariable("TXT_QUESTION", $mess);
            return;
        }


        // nested form problem
        if (!$_SESSION["il_cont_admin_panel"]) {
            // vote

            if ($this->poll_block->maySeeQuestion($ilUser->getId())) {
                $this->tpl->setCurrentBlock("mode_info_bl");
                if ($this->poll_block->getPoll()->getNonAnonymous()) {
                    $mode_info = $lng->txt("poll_non_anonymous_warning");
                } else {
                    $mode_info = $lng->txt("poll_anonymous_warning");
                }
                $this->tpl->setVariable("MODE_INFO", $mode_info);
                $this->tpl->parseCurrentBlock();

                $is_multi_answer = ($this->poll_block->getPoll()->getMaxNumberOfAnswers() > 1);

                if (isset($_SESSION["last_poll_vote"][$this->poll_block->getPoll()->getId()])) {
                    $last_vote = $_SESSION["last_poll_vote"][$this->poll_block->getPoll()->getId()];
                    unset($_SESSION["last_poll_vote"][$this->poll_block->getPoll()->getId()]);

                    if ($is_multi_answer) {
                        $error = sprintf(
                            $lng->txt("poll_vote_error_multi"),
                            $this->poll_block->getPoll()->getMaxNumberOfAnswers()
                        );
                    } else {
                        $error = $lng->txt("poll_vote_error_single");
                    }

                    $this->tpl->setCurrentBlock("error_bl");
                    $this->tpl->setVariable("FORM_ERROR", $error);
                    $this->tpl->parseCurrentBlock();
                }

                $this->tpl->setCurrentBlock("answer");
                foreach ($a_poll->getAnswers() as $item) {
                    $status = [];
                    if (!$is_multi_answer) {
                        $this->tpl->setVariable("ANSWER_INPUT", "radio");
                        $this->tpl->setVariable("ANSWER_NAME", "aw");
                    } else {
                        $this->tpl->setVariable("ANSWER_INPUT", "checkbox");
                        $this->tpl->setVariable("ANSWER_NAME", "aw[]");

                        if (is_array($last_vote) && in_array($item["id"], $last_vote)) {
                            $status[] = 'checked="checked"';
                        }
                    }

                    if (!$this->poll_block->mayVote($ilUser->getId())) {
                        $status[] = 'disabled';
                    }

                    if (!empty($status)) {
                        $this->tpl->setVariable("ANSWER_STATUS", implode(' ', $status));
                    }

                    $this->tpl->setVariable("VALUE_ANSWER", $item["id"]);
                    $this->tpl->setVariable("TXT_ANSWER_VOTE", nl2br($item["answer"]));
                    $this->tpl->parseCurrentBlock();
                }

                if ($this->poll_block->mayVote($ilUser->getId())) {
                    $ilCtrl->setParameterByClass(
                        $this->getRepositoryObjectGUIName(),
                        "ref_id",
                        $this->getRefId()
                    );
                    $url = $ilCtrl->getLinkTargetByClass(
                        array("ilrepositorygui", $this->getRepositoryObjectGUIName()),
                        "vote"
                    );
                    $ilCtrl->clearParametersByClass($this->getRepositoryObjectGUIName());

                    $url .= "#poll" . $a_poll->getID();

                    $this->tpl->setVariable("URL_FORM", $url);
                    $this->tpl->setVariable("CMD_FORM", "vote");
                    $this->tpl->setVariable("TXT_SUBMIT", $lng->txt("poll_vote"));
                }

                if ($this->poll_block->getPoll()->getVotingPeriod()) {
                    $this->tpl->setVariable(
                        "TXT_VOTING_END_PERIOD",
                        sprintf(
                            $lng->txt("poll_voting_period_info"),
                            ilDatePresentation::formatDate(new ilDateTime($this->poll_block->getPoll()->getVotingPeriodEnd(), IL_CAL_UNIX))
                        )
                    );
                }
            }


            // result
            if ($this->poll_block->maySeeResults($ilUser->getId())) {
                if (!$this->poll_block->mayNotResultsYet($ilUser->getId())) {
                    $answers = array();
                    foreach ($a_poll->getAnswers() as $item) {
                        $answers[$item["id"]] = $item["answer"];
                    }

                    $perc = $this->poll_block->getPoll()->getVotePercentages();
                    $total = $perc["total"];
                    $perc = $perc["perc"];

                    $this->tpl->setVariable("TOTAL_ANSWERS", sprintf($lng->txt("poll_population"), $total));

                    if ($total) {
                        // sort results by votes / original position
                        if ($this->poll_block->getPoll()->getSortResultByVotes()) {
                            $order = array_keys(ilUtil::sortArray($perc, "abs", "desc", true, true));

                            foreach (array_keys($answers) as $answer_id) {
                                if (!in_array($answer_id, $order)) {
                                    $order[] = $answer_id;
                                }
                            }
                        } else {
                            $order = array_keys($answers);
                        }

                        // pie chart
                        if ($this->poll_block->showResultsAs() == ilObjPoll::SHOW_RESULTS_AS_PIECHART) {
                            include_once("./Services/Chart/classes/class.ilChart.php");

                            $chart = ilChart::getInstanceByType(ilCHart::TYPE_PIE, "poll_results_pie_" . $this->getRefId());
                            $chart->setSize("100%", 200);
                            $chart->setAutoResize(true);

                            $chart_data = $chart->getDataInstance();

                            foreach ($order as $answer_id) {
                                $chart_data->addPoint(
                                    round($perc[$answer_id]["perc"]),
                                    nl2br($answers[$answer_id])
                                );
                            }

                            // disable legend, use inner labels - currently not preferred
                            // $chart_data->setLabelRadius(0.8);

                            $chart->addData($chart_data);

                            $pie_legend_id = "poll_legend_" . $this->getRefId();
                            $legend = new ilChartLegend();
                            $legend->setContainer($pie_legend_id);
                            $chart->setLegend($legend);

                            $this->tpl->setVariable("PIE_LEGEND_ID", $pie_legend_id);
                            $this->tpl->setVariable("PIE_CHART", $chart->getHTML());
                        } // bar chart
                        else {
                            include_once "Services/UIComponent/ProgressBar/classes/class.ilProgressBar.php";

                            $this->tpl->setCurrentBlock("answer_result");
                            foreach ($order as $answer_id) {
                                $pbar = ilProgressBar::getInstance();
                                $pbar->setCurrent(round($perc[$answer_id]["perc"]));
                                $this->tpl->setVariable("PERC_ANSWER_RESULT", $pbar->render());
                                $this->tpl->setVariable("TXT_ANSWER_RESULT", nl2br($answers[$answer_id]));
                                $this->tpl->parseCurrentBlock();
                            }
                        }
                    }
                } else {
                    $rel = ilDatePresentation::useRelativeDates();
                    ilDatePresentation::setUseRelativeDates(false);
                    $end = $this->poll_block->getPoll()->getVotingPeriodEnd();
                    $end = ilDatePresentation::formatDate(new ilDateTime($end, IL_CAL_UNIX));
                    ilDatePresentation::setUseRelativeDates($rel);

                    // #14607
                    $info = "";
                    if ($this->poll_block->getPoll()->hasUserVoted($ilUser->getId())) {
                        $info .= $lng->txt("poll_block_message_already_voted") . " ";
                    }

                    $this->tpl->setVariable("TOTAL_ANSWERS", $info .
                        sprintf($lng->txt("poll_block_results_available_on"), $end));
                }
            } elseif ($this->poll_block->getPoll()->hasUserVoted($ilUser->getId())) {
                $this->tpl->setVariable("TOTAL_ANSWERS", $lng->txt("poll_block_message_already_voted"));
            }
        }

        if (!$this->poll_block->maySeeQuestion($ilUser->getId()) && !$this->poll_block->getPoll()->hasUserVoted($ilUser->getId())) {
            if ($this->poll_block->getPoll()->getVotingPeriod()) {
                $this->tpl->setVariable(
                    "TXT_VOTING_PERIOD",
                    sprintf(
                        $lng->txt("poll_voting_period_full_info"),
                        ilDatePresentation::formatDate(new ilDateTime($this->poll_block->getPoll()->getVotingPeriodBegin(), IL_CAL_UNIX)),
                        ilDatePresentation::formatDate(new ilDateTime($this->poll_block->getPoll()->getVotingPeriodEnd(), IL_CAL_UNIX))
                    )
                );
            }
        } else {
            $this->tpl->setVariable("TXT_QUESTION", nl2br(trim($a_poll->getQuestion())));

            $img = $a_poll->getImageFullPath();
            if ($img) {
                require_once('./Services/WebAccessChecker/classes/class.ilWACSignedPath.php');
                $this->tpl->setVariable("URL_IMAGE", ilWACSignedPath::signFile($img));
            }
        }


        $this->tpl->setVariable("ANCHOR_ID", $a_poll->getID());
        //$this->tpl->setVariable("TXT_QUESTION", nl2br(trim($a_poll->getQuestion())));

        $desc = trim($a_poll->getDescription());
        if ($desc) {
            $this->tpl->setVariable("TXT_DESC", nl2br($desc));
        }


        if ($ilUser->getId() == ANONYMOUS_USER_ID) {
            $this->tpl->setCurrentBlock("anon_warning");
            $this->tpl->setVariable("ANON_WARNING", $this->lng->txt('no_access_item_public'));
            $this->tpl->parseCurrentBlock();
        }


        if ($this->poll_block->showComments()) {
            $this->tpl->setCurrentBlock("comment_link");
            $this->tpl->setVariable("LANG_COMMENTS", $lng->txt('poll_comments'));
            $this->tpl->setVariable("COMMENT_JSCALL", $this->commentJSCall());
            $this->tpl->setVariable("COMMENTS_COUNT_ID", $this->getRefId());

            $comments_count = $this->getNumberOfComments($this->getRefId());

            if ($comments_count > 0) {
                $this->tpl->setVariable("COMMENTS_COUNT", "(" . $comments_count . ")");
            }

            if (!self::$js_init) {
                $redraw_url = $ilCtrl->getLinkTarget(
                    $this,
                    "getNumberOfCommentsForRedraw",
                    "",
                    true,
                    false
                );
                $this->tpl->setVariable("COMMENTS_REDRAW_URL", $redraw_url);

                $tpl->addJavaScript("Modules/Poll/js/ilPoll.js");
                self::$js_init = true;
            }
        }
    }

    public function getHTML()
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilAccess = $this->access;
        $ilUser = $this->user;

        $this->poll_block->setRefId($this->getRefId());
        $this->may_write = $ilAccess->checkAccess("write", "", $this->getRefId());
        $this->has_content = $this->poll_block->hasAnyContent($ilUser->getId(), $this->getRefId());

        #22078 and 22079 it always contains something.
        /*if(!$this->may_write && !$this->has_content)
        {
            return "";
        }*/

        $poll_obj = $this->poll_block->getPoll();
        $this->setTitle($poll_obj->getTitle());
        $this->setData(array($poll_obj));

        $ilCtrl->setParameterByClass(
            $this->getRepositoryObjectGUIName(),
            "ref_id",
            $this->getRefId()
        );

        if (!$this->poll_block->getMessage($ilUser->getId())) {
            // notification
            include_once "./Services/Notification/classes/class.ilNotification.php";
            if (ilNotification::hasNotification(ilNotification::TYPE_POLL, $ilUser->getId(), $this->poll_block->getPoll()->getId())) {
                $this->addBlockCommand(
                    $ilCtrl->getLinkTargetByClass(
                        array("ilrepositorygui", $this->getRepositoryObjectGUIName()),
                        "unsubscribe"
                    ),
                    $lng->txt("poll_notification_unsubscribe")
                );
            } else {
                $this->addBlockCommand(
                    $ilCtrl->getLinkTargetByClass(
                        array("ilrepositorygui", $this->getRepositoryObjectGUIName()),
                        "subscribe"
                    ),
                    $lng->txt("poll_notification_subscribe")
                );
            }
        }

        if ($this->may_write) {
            // edit
            $this->addBlockCommand(
                $ilCtrl->getLinkTargetByClass(
                    array("ilrepositorygui", $this->getRepositoryObjectGUIName()),
                    "render"
                ),
                $lng->txt("edit_content")
            );
            $this->addBlockCommand(
                $ilCtrl->getLinkTargetByClass(
                    array("ilrepositorygui", $this->getRepositoryObjectGUIName()),
                    "edit"
                ),
                $lng->txt("settings")
            );
        }

        $ilCtrl->clearParametersByClass($this->getRepositoryObjectGUIName());

        return parent::getHTML();
    }

    private function commentJSCall()
    {
        include_once("./Services/Notes/classes/class.ilNoteGUI.php");
        include_once("./Services/Object/classes/class.ilCommonActionDispatcherGUI.php");

        $refId = $this->getRefId();
        $objectId = ilObject2::_lookupObjectId($refId);

        $ajaxHash = ilCommonActionDispatcherGUI::buildAjaxHash(
            ilCommonActionDispatcherGUI::TYPE_REPOSITORY,
            $refId,
            "poll",
            $objectId
        );


        $comment = new ilNoteGUI();
        $jsCall = $comment->getListCommentsJSCall($ajaxHash, "ilPoll.redrawComments(" . $refId . ");");

        return $jsCall;
    }

    public function getNumberOfCommentsForRedraw()
    {
        $number = $this->getNumberOfComments($_GET["poll_id"]);

        if ($number > 0) {
            echo "(" . $number . ")";
        } else {
            echo "";
        }

        exit();
    }

    public function getNumberOfComments($ref_id)
    {
        include_once("./Services/Notes/classes/class.ilNote.php");

        $obj_id = ilObject2::_lookupObjectId($ref_id);
        $number = ilNote::_countNotesAndComments($obj_id);

        if (count($number) == 0) {
            return 0;
        }

        return $number[$obj_id][IL_NOTE_PUBLIC];
    }

    public function fillDataSection()
    {
        $this->setDataSection($this->getLegacyContent());
    }

    //
    // New rendering
    //

    protected $new_rendering = true;


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