class.ilPollResultsRenderer.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilPollResultsRenderer
{
    protected int $ref_id;

    public function __construct(
        int $ref_id
    ) {
        $this->ref_id = $ref_id;
    }

    public function render(
        ilTemplate $tpl,
        ilPollResultsHandler $results,
        int $presentation_mode
    ): void {
        if ($presentation_mode === ilObjPoll::SHOW_RESULTS_AS_PIECHART) {
            $this->renderPieChart($tpl, $results);
        } else {
            $this->renderBarChart($tpl, $results);
        }
    }

    protected function renderPieChart(
        ilTemplate $tpl,
        ilPollResultsHandler $results
    ): void {
        $chart = $this->getPieChart();
        $chart->setSize("400", "200");
        $chart->setAutoResize(true);

        $chart_data = $chart->getDataInstance();

        foreach ($results->getOrderedAnswerIds() as $id) {
            $chart_data->addPiePoint(
                (int) round($results->getAnswerPercentage($id)),
                $this->specialCharsAsEntities(nl2br($results->getAnswerText($id)))
            );
        }

        $chart->addData($chart_data);

        $pie_legend_id = "poll_legend_" . $this->ref_id;
        $legend = $this->getLegend();
        $legend->setContainer($pie_legend_id);
        $chart->setLegend($legend);

        $tpl->setVariable("PIE_LEGEND_ID", $pie_legend_id);
        $tpl->setVariable("PIE_CHART", $chart->getHTML());
    }

    protected function renderBarChart(
        ilTemplate $tpl,
        ilPollResultsHandler $results
    ): void {
        $tpl->setCurrentBlock("answer_result");
        foreach ($results->getOrderedAnswerIds() as $id) {
            $pbar = $this->getProgressBar();
            $pbar->setCurrent(round($results->getAnswerPercentage($id)));
            $pbar->setCaption('(' . $results->getAnswerTotal($id) . ')');
            $tpl->setVariable("PERC_ANSWER_RESULT", $pbar->render());
            $tpl->setVariable(
                "TXT_ANSWER_RESULT",
                $this->specialCharsAsEntities(nl2br($results->getAnswerText($id)))
            );
            $tpl->parseCurrentBlock();
        }
    }

    protected function getLegend(): ilChartLegend
    {
        return new ilChartLegend();
    }

    protected function getPieChart(): ilChart
    {
        return ilChart::getInstanceByType(
            ilChart::TYPE_PIE,
            "poll_results_pie_" . $this->ref_id
        );
    }

    protected function getProgressBar(): ilProgressBar
    {
        return ilProgressBar::getInstance();
    }

    protected function specialCharsAsEntities(string $string): string
    {
        // Should be replaced by a proper refinery transformation once https://github.com/ILIAS-eLearning/ILIAS/pull/6314 is merged
        return  htmlspecialchars(
            $string,
            ENT_QUOTES | ENT_SUBSTITUTE,
            'utf-8'
        );
    }
}