ilPollResultsRenderer Class Reference

Collaboration diagram for ilPollResultsRenderer:

Public Member Functions
	__construct (int $ref_id, Refinery $refinery, DataFactory $data_factory, UIFactory $ui_factory, UIRenderer $ui_renderer, ilLanguage $lng)
	render (ilTemplate $tpl, ilPollResultsHandler $results, int $presentation_mode)

Protected Member Functions
	renderStackedChart (ilTemplate $tpl, ilPollResultsHandler $results)
	renderBarChart (ilTemplate $tpl, ilPollResultsHandler $results)
	htmlSpecialCharsAsEntities (string $string)

Protected Attributes
const	SINGLE_BAR_WIDTH = 0.65
const	SINGLE_BAR_COLOR = '#4C6586'
const	STACKED_BAR_WIDTH = 0.95
const	STACKED_BAR_COLORS
int	$ref_id
Refinery	$refinery
DataFactory	$data_factory
UIFactory	$ui_factory
UIRenderer	$ui_renderer
ilLanguage	$lng

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilPollResultsRenderer::__construct	(	int	$ref_id,
		Refinery	$refinery,
		DataFactory	$data_factory,
		UIFactory	$ui_factory,
		UIRenderer	$ui_renderer,
		ilLanguage	$lng
	)

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

References $data_factory, $lng, $ref_id, $refinery, $ui_factory, $ui_renderer, ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

      {
        $this->ref_id = $ref_id;
        $this->refinery = $refinery;
        $this->data_factory = $data_factory;
        $this->ui_factory = $ui_factory;
        $this->ui_renderer = $ui_renderer;
        $this->lng = $lng;
    }

Here is the call graph for this function:

Member Function Documentation

htmlSpecialCharsAsEntities()

ilPollResultsRenderer::htmlSpecialCharsAsEntities ( string  $string )

protected

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

References ILIAS\Repository\refinery().

Referenced by renderBarChart(), and renderStackedChart().

                                                                 : string
    {
        return $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform(nl2br($string));
    }

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 67 of file class.ilPollResultsRenderer.php.

References renderBarChart(), renderStackedChart(), and ilObjPoll\SHOW_RESULTS_AS_STACKED_CHART.

     : void {
        if ($presentation_mode === ilObjPoll::SHOW_RESULTS_AS_STACKED_CHART) {
            $this->renderStackedChart($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 129 of file class.ilPollResultsRenderer.php.

References $id, ilPollResultsHandler\getAnswerPercentage(), ilPollResultsHandler\getAnswerText(), ilPollResultsHandler\getAnswerTotal(), ilPollResultsHandler\getOrderedAnswerIds(), htmlSpecialCharsAsEntities(), ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by render().

     : void {
        $votes_label = $this->lng->txt('poll_chart_votes');
        $c_dimension = $this->data_factory->dimension()->cardinal();
        $dataset = $this->data_factory->dataset([$votes_label => $c_dimension]);

        foreach ($results->getOrderedAnswerIds() as $id) {
            $label = $this->htmlSpecialCharsAsEntities($results->getAnswerText($id));
            $total_votes = $results->getAnswerTotal($id);
            $tooltip = $total_votes . ' (' . round($results->getAnswerPercentage($id)) . '%)';
            $dataset = $dataset->withPoint($label, [$votes_label => $total_votes])
                               ->withAlternativeInformation($label, [$votes_label => $tooltip]);
        }

        $bar_config = new BarConfig();
        $bar_config = $bar_config->withColor($this->data_factory->color(self::SINGLE_BAR_COLOR))
                                 ->withRelativeWidth(self::SINGLE_BAR_WIDTH);
        $chart = $this->ui_factory->chart()->bar()->horizontal('', $dataset)
                                                  ->withTitleVisible(false)
                                                  ->withLegendVisible(false)
                                                  ->withBarConfigs([$votes_label => $bar_config]);
        $tpl->setVariable('CHART', $this->ui_renderer->render($chart));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderStackedChart()

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

protected

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

References $id, ilPollResultsHandler\getAnswerPercentage(), ilPollResultsHandler\getAnswerText(), ilPollResultsHandler\getAnswerTotal(), ilPollResultsHandler\getOrderedAnswerIds(), htmlSpecialCharsAsEntities(), ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by render().

     : void {
        $votes_label = $this->lng->txt('poll_chart_votes');
        $c_dimension = $this->data_factory->dimension()->cardinal();

        $dimensions = [];
        $data_values = [];
        $bar_configs = [];
        $tooltips = [];
        $color_index = 0;
        foreach ($results->getOrderedAnswerIds() as $id) {
            $label = $this->htmlSpecialCharsAsEntities($results->getAnswerText($id));
            $total_votes = $results->getAnswerTotal($id);
            $tooltip = $total_votes . ' (' . round($results->getAnswerPercentage($id)) . '%)';
            $bar_config = new BarConfig();

            $dimensions[$label] = $c_dimension;
            $data_values[$label] = $total_votes;
            $bar_configs[$label] = $bar_config->withColor(
                $this->data_factory->color(self::STACKED_BAR_COLORS[$color_index])
            )->withRelativeWidth(self::STACKED_BAR_WIDTH);
            $tooltips[$label] = $tooltip;

            $color_index = ($color_index + 1) >= count(self::STACKED_BAR_COLORS) ? 0 : ($color_index + 1);
        }

        $dimension_group = $this->data_factory->dimension()->group();
        $dataset = $this->data_factory->dataset(
            $dimensions,
            ['stacked' => $this->data_factory->dimension()->group(...array_keys($dimensions))]
        )->withPoint(
            $votes_label,
            $data_values
        )->withAlternativeInformation(
            $votes_label,
            $tooltips
        );

        $group_config = new GroupConfig();
        $group_config = $group_config->withStacked(true);
        $chart = $this->ui_factory->chart()->bar()->horizontal('', $dataset)
                                  ->withTitleVisible(false)
                                  ->withLegendVisible(true)
                                  ->withBarConfigs($bar_configs)
                                  ->withGroupConfigs(['stacked' => $group_config]);
        $tpl->setVariable('CHART', $this->ui_renderer->render($chart));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$data_factory

DataFactory ilPollResultsRenderer::$data_factory

protected

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

Referenced by __construct().

$lng

ilLanguage ilPollResultsRenderer::$lng

protected

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

Referenced by __construct().

$ref_id

int ilPollResultsRenderer::$ref_id

protected

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

Referenced by __construct().

$refinery

Refinery ilPollResultsRenderer::$refinery

protected

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

Referenced by __construct().

$ui_factory

UIFactory ilPollResultsRenderer::$ui_factory

protected

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

Referenced by __construct().

$ui_renderer

UIRenderer ilPollResultsRenderer::$ui_renderer

protected

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

Referenced by __construct().

SINGLE_BAR_COLOR

const ilPollResultsRenderer::SINGLE_BAR_COLOR = '#4C6586'

protected

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

SINGLE_BAR_WIDTH

const ilPollResultsRenderer::SINGLE_BAR_WIDTH = 0.65

protected

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

STACKED_BAR_COLORS

const ilPollResultsRenderer::STACKED_BAR_COLORS

protected

Initial value:

= [
        '#35485F',
        '#F06B05',
        '#374E1D',
        '#A18BB6',
        '#2C2C2C',
        '#3D9FAE',
        '#663D00',
        '#F75E82'
    ]

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

STACKED_BAR_WIDTH

const ilPollResultsRenderer::STACKED_BAR_WIDTH = 0.95

protected

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

---

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

• components/ILIAS/Poll/classes/BlockGUI/Results/class.ilPollResultsRenderer.php