ilPollResultsRenderer Class Reference

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

Collaboration diagram for ilPollResultsRenderer:

Public Member Functions
	__construct (int $ref_id)
	render (ilTemplate $tpl, ilPollResultsHandler $results, int $presentation_mode)

Protected Member Functions
	renderPieChart (ilTemplate $tpl, ilPollResultsHandler $results)
	renderBarChart (ilTemplate $tpl, ilPollResultsHandler $results)
	getLegend ()
	getPieChart ()
	getProgressBar ()
	specialCharsAsEntities (string $string)

Protected Attributes
int	$ref_id

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

Definition at line 22 of file class.ilPollResultsRenderer.php.

Constructor & Destructor Documentation

__construct()

ilPollResultsRenderer::__construct

(

int

$ref_id

)

Definition at line 26 of file class.ilPollResultsRenderer.php.

References $ref_id.

      {
        $this->ref_id = $ref_id;
    }

Member Function Documentation

getLegend()

ilPollResultsRenderer::getLegend ( )

protected

Definition at line 90 of file class.ilPollResultsRenderer.php.

Referenced by renderPieChart().

                                  : ilChartLegend
    {
        return new ilChartLegend();
    }

Here is the caller graph for this function:

getPieChart()

ilPollResultsRenderer::getPieChart ( )

protected

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

References ilChart\getInstanceByType(), and ilChart\TYPE_PIE.

Referenced by renderPieChart().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getProgressBar()

ilPollResultsRenderer::getProgressBar ( )

protected

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

References ilProgressBar\getInstance().

Referenced by renderBarChart().

                                       : ilProgressBar
    {
        return ilProgressBar::getInstance();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

render()

ilPollResultsRenderer::render	(	ilTemplate	$tpl,
		ilPollResultsHandler	$results,
		int	$presentation_mode
	)

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

References renderBarChart(), renderPieChart(), and ilObjPoll\SHOW_RESULTS_AS_PIECHART.

     : void {
        if ($presentation_mode === ilObjPoll::SHOW_RESULTS_AS_PIECHART) {
            $this->renderPieChart($tpl, $results);
        } else {
            $this->renderBarChart($tpl, $results);
        }
    }

Here is the call graph for this function:

renderBarChart()

ilPollResultsRenderer::renderBarChart ( ilTemplate  $tpl, ilPollResultsHandler  $results  )

protected

Definition at line 72 of file class.ilPollResultsRenderer.php.

References $id, ilPollResultsHandler\getAnswerPercentage(), ilPollResultsHandler\getAnswerText(), ilPollResultsHandler\getAnswerTotal(), ilPollResultsHandler\getOrderedAnswerIds(), getProgressBar(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and specialCharsAsEntities().

Referenced by render().

     : 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();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderPieChart()

ilPollResultsRenderer::renderPieChart ( ilTemplate  $tpl, ilPollResultsHandler  $results  )

protected

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

References $id, $ref_id, ilPollResultsHandler\getAnswerPercentage(), ilPollResultsHandler\getAnswerText(), getLegend(), ilPollResultsHandler\getOrderedAnswerIds(), getPieChart(), HTML_Template_IT\setVariable(), and specialCharsAsEntities().

Referenced by render().

     : 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());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

specialCharsAsEntities()

ilPollResultsRenderer::specialCharsAsEntities ( string  $string )

protected

Definition at line 108 of file class.ilPollResultsRenderer.php.

Referenced by renderBarChart(), and renderPieChart().

                                                             : 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'
        );
    }

Here is the caller graph for this function:

Field Documentation

$ref_id

int ilPollResultsRenderer::$ref_id

protected

Definition at line 24 of file class.ilPollResultsRenderer.php.

Referenced by __construct(), and renderPieChart().

---

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

• Modules/Poll/classes/BlockGUI/Results/class.ilPollResultsRenderer.php