Collaboration diagram for ilKioskPageRenderer:

Public Member Functions
	__construct (MetaContent $layout_meta_content, Factory $ui_factory, Renderer $ui_renderer, ilLanguage $lng, ilTemplate $kiosk_template, ilLSTOCGUI $toc_gui, ilLSLocatorGUI $loc_gui, string $window_base_title)

	buildLearningMapEntry (string $map_html)
	The learning map entry of the main bar. More...

	buildToCSlate (LSTOCBuilder $toc, Icon $icon)

	addOnLoadCode (string $code, int $batch=2)

	addJs (string $path, bool $add_version_number=false, int $batch=2)

	addCss (string $path)

	render (LSControlBuilder $control_builder, string $obj_title, string $obj_description, Component $icon, array $content, string $obj_rating_html='')

Data Fields
const	LEARNING_MAP_LABEL = 'learning_map'

Protected Attributes
MetaContent	$layout_meta_content

Factory	$ui_factory

Renderer	$ui_renderer

ilLanguage	$lng

ilTemplate	$tpl

ilLSTOCGUI	$toc_gui

ilLSLocatorGUI	$loc_gui

string	$window_base_title

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilKioskPageRenderer::__construct	(	MetaContent	$layout_meta_content,
		Factory	$ui_factory,
		Renderer	$ui_renderer,
		ilLanguage	$lng,
		ilTemplate	$kiosk_template,
		ilLSTOCGUI	$toc_gui,
		ilLSLocatorGUI	$loc_gui,
		string	$window_base_title
	)

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

      {
        $this->layout_meta_content = $layout_meta_content;
        $this->ui_factory = $ui_factory;
        $this->ui_renderer = $ui_renderer;
        $this->lng = $lng;
        $this->tpl = $kiosk_template;
        $this->toc_gui = $toc_gui;
        $this->loc_gui = $loc_gui;
        $this->window_base_title = $window_base_title;
    }

References $layout_meta_content, $lng, $loc_gui, $toc_gui, $ui_factory, $ui_renderer, $window_base_title, and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ addCss()

ilKioskPageRenderer::addCss ( string $path )

Definition at line 116 of file class.ilKioskPageRenderer.php.

                                        : void
    {
        $this->layout_meta_content->addCss($path);
    }

◆ addJs()

ilKioskPageRenderer::addJs	(	string	$path,
		bool	$add_version_number = `false`,
		int	$batch = `2`
	)

Definition at line 111 of file class.ilKioskPageRenderer.php.

                                                                                         : void
    {
        $this->layout_meta_content->addJs($path, $add_version_number, $batch);
    }

◆ addOnLoadCode()

ilKioskPageRenderer::addOnLoadCode	(	string	$code,
		int	$batch = `2`
	)

Definition at line 106 of file class.ilKioskPageRenderer.php.

                                                               : void
    {
        $this->layout_meta_content->addOnloadCode($code, $batch);
    }

◆ buildLearningMapEntry()

ilKioskPageRenderer::buildLearningMapEntry ( string $map_html )

The learning map entry of the main bar.

There used to be a slate here (holding the curriculum); now the entry is a plain button that opens the map in a modal - the modal has to be rendered along with the page.

Returns: array{0: Bulky, 1: RoundTrip} the main bar entry and its modal

Definition at line 70 of file class.ilKioskPageRenderer.php.

                                                           : array
    {
        $f = $this->ui_factory;
        // one single modal for both operation modes: its size is set by the
        // script of the map, which measures the map and writes the measures
        // onto the dialog element (see sizeModal() in lso_learning_map.js).
        // The wrapper is only the marker the script and the css look for.
        $modal = $f->modal()->roundtrip(
            $this->lng->txt(self::LEARNING_MAP_LABEL),
            [
                $f->legacy()->content(
                    '<div class="lso-learning-map-modal">' . $map_html . '</div>'
                )
            ]
        );
        $button = $f->button()->bulky(
            $f->symbol()->icon()->standard('lso', $this->lng->txt(self::LEARNING_MAP_LABEL)),
            $this->lng->txt(self::LEARNING_MAP_LABEL),
            '#'
        )->withOnClick($modal->getShowSignal());
 
        return [$button, $modal];
    }

References Vendor\Package\$f, $ui_factory, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ buildToCSlate()

ilKioskPageRenderer::buildToCSlate	(	LSTOCBuilder	$toc,
		Icon	$icon
	)

Definition at line 94 of file class.ilKioskPageRenderer.php.

                                                                : Slate
    {
        $html = $this->toc_gui
            ->withStructure($toc->toJSON())
            ->getHTML();
        return $this->ui_factory->maincontrols()->slate()->legacy(
            $this->lng->txt('lso_mainbar_button_label_toc'),
            $icon->withSize("small"),
            $this->ui_factory->legacy()->content($html)
        );
    }

References ILIAS\Repository\lng(), LSTOCBuilder\toJSON(), and ILIAS\UI\Component\Symbol\Icon\Icon\withSize().

Here is the call graph for this function:

◆ render()

ilKioskPageRenderer::render	(	LSControlBuilder	$control_builder,
		string	$obj_title,
		string	$obj_description,
		Component	$icon,
		array	$content,
		string	$obj_rating_html = `''`
	)

Definition at line 121 of file class.ilKioskPageRenderer.php.

     : string {
        $this->tpl->setVariable(
            "OBJECT_ICON",
            $this->ui_renderer->render($icon)
        );
        $this->tpl->setVariable("OBJECT_TITLE", $obj_title);
 
        $obj_description = trim($obj_description);
        if ($obj_description !== '') {
            $this->tpl->setCurrentBlock('obj_desc');
            $this->tpl->setVariable(
                'OBJECT_DESCRIPTION',
                nl2br($obj_description)
            );
            $this->tpl->parseCurrentBlock();
        }
        $this->tpl->setVariable('OBJECT_RATING', $obj_rating_html);
 
        $this->tpl->setVariable(
            "PLAYER_NAVIGATION",
            $this->ui_renderer->render(array_values(array_filter([
                $control_builder->getPreviousControl(),
                $control_builder->getNextControl()
            ])))
        );
 
        $controls = $control_builder->getControls();
 
        //ensure done control is first element
        if ($control_builder->getDoneControl()) {
            array_unshift($controls, $control_builder->getDoneControl());
        }
        //also shift start control up front - this is for legacy-views only!
        if ($control_builder->getStartControl()) {
            array_unshift($controls, $control_builder->getStartControl());
            $this->tpl->setVariable("JS_INLINE", $control_builder->getAdditionalJS());
        }
 
        //TODO: insert toggles
 
        $this->tpl->setVariable(
            "OBJ_NAVIGATION",
            $this->ui_renderer->render($controls)
        );
 
 
        $this->tpl->setVariable(
            "VIEW_MODES",
            $this->ui_renderer->render($control_builder->getModeControls())
        );
 
        if ($control_builder->getLocator()) {
            $this->tpl->setVariable(
                'LOCATOR',
                $this->ui_renderer->render(
                    $this->loc_gui
                        ->withItems($control_builder->getLocator()->getItems())
                        ->getComponent()
                )
            );
        }
 
        $this->tpl->setVariable(
            'CONTENT',
            $this->ui_renderer->render($content)
        );
 
        return $this->tpl->get();
    }

Field Documentation

◆ $layout_meta_content

MetaContent ilKioskPageRenderer::$layout_meta_content

protected

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

Referenced by __construct().

◆ $lng

ilLanguage ilKioskPageRenderer::$lng

protected

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

Referenced by __construct().

◆ $loc_gui

ilLSLocatorGUI ilKioskPageRenderer::$loc_gui

protected

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

Referenced by __construct().

◆ $toc_gui

ilLSTOCGUI ilKioskPageRenderer::$toc_gui

protected

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

Referenced by __construct().

◆ $tpl

ilTemplate ilKioskPageRenderer::$tpl

protected

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

◆ $ui_factory

Factory ilKioskPageRenderer::$ui_factory

protected

Definition at line 35 of file class.ilKioskPageRenderer.php.

Referenced by __construct(), and buildLearningMapEntry().

◆ $ui_renderer

Renderer ilKioskPageRenderer::$ui_renderer

protected

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

Referenced by __construct().

◆ $window_base_title

string ilKioskPageRenderer::$window_base_title

protected

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

Referenced by __construct().

◆ LEARNING_MAP_LABEL

const ilKioskPageRenderer::LEARNING_MAP_LABEL = 'learning_map'

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

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

components/ILIAS/LearningSequence/classes/Player/class.ilKioskPageRenderer.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCss()

◆ addJs()

◆ addOnLoadCode()

◆ buildLearningMapEntry()

◆ buildToCSlate()

◆ render()

Field Documentation

◆ $layout_meta_content

◆ $lng

◆ $loc_gui

◆ $toc_gui

◆ $tpl

◆ $ui_factory

◆ $ui_renderer

◆ $window_base_title

◆ LEARNING_MAP_LABEL