LSControlBuilder Class Reference

Inheritance diagram for LSControlBuilder:

Collaboration diagram for LSControlBuilder:

Public Member Functions
	__construct (Factory $ui_factory, LSURLBuilder $url_builder, ilLanguage $language, LSGlobalSettings $global_settings, LSURLBuilder $lp_url_builder)
	getToggles ()
	getModeControls ()
	getControls ()
	getExitControl ()
	getPreviousControl ()
	getNextControl ()
	getDoneControl ()
	getToc ()
	getLocator ()
	exit (string $command)
	An exit control allows the user to gracefully leave the object providing the kiosk mode. More...
	next (string $command, ?int $parameter=null)
	A next control allows the user to progress to the next item in the object. More...
	previous (string $command, ?int $parameter=null)
	A previous control allows the user to go back to the previous item in the object. More...
	done (string $command, ?int $parameter=null)
	A done control allows the user to mark the object as done. More...
	generic (string $label, string $command, ?int $parameter=null)
	A generic control needs to have a label that tells what it does. More...
	genericWithSignal (string $label, Signal $signal)
	toggle (string $label, string $on_command, string $off_command)
	A toggle can be used to switch some behaviour in the view on or of. More...
	mode (string $command, array $labels)
	A mode control can be used to switch between different modes in the view. More...
	locator (string $command)
	A locator allows the user to see the path leading to her current location and jump back to previous items on that path. More...
	tableOfContent (string $label, string $command, ?int $parameter=null, $state=null)
	A table of content allows the user to get an overview over the generally available content in the object. More...
	start (string $label, string $url, int $obj_id)
	Add a "start"-button as primary. More...
	getStartControl ()
	getAdditionalJS ()
Public Member Functions inherited from ILIAS\KioskMode\ControlBuilder
	genericWithSignal (string $label, UI\Component\Signal $signal)
	A genericWithSignal will trigger the Signal rather than refreshing the View. More...

Data Fields
const	CMD_START_OBJECT = 'start_legacy_obj'
const	CMD_CHECK_CURRENT_ITEM_LP = 'ccilp'

Protected Member Functions
	setListenerJS (string $check_lp_url, string $on_lp_change_url)

Protected Attributes
array	$controls = []
array	$toggles = []
array	$mode_controls = []
Component	$exit_control = null
Component	$previous_control = null
Component	$next_control = null
Component	$done_control = null
TOCBuilder	$toc = null
LocatorBuilder	$loc = null
JavaScriptBindable	$start = null
string	$additional_js = null
Factory	$ui_factory
LSURLBuilder	$url_builder
ilLanguage	$lng
LSGlobalSettings	$global_settings
LSURLBuilder	$lp_url_builder

Detailed Description

Definition at line 29 of file LSControlBuilder.php.

Constructor & Destructor Documentation

__construct()

LSControlBuilder::__construct	(	Factory	$ui_factory,
		LSURLBuilder	$url_builder,
		ilLanguage	$language,
		LSGlobalSettings	$global_settings,
		LSURLBuilder	$lp_url_builder
	)

Definition at line 63 of file LSControlBuilder.php.

References $global_settings, $lp_url_builder, $ui_factory, $url_builder, and ILIAS\Repository\lng().

      {
        $this->ui_factory = $ui_factory;
        $this->url_builder = $url_builder;
        $this->lng = $language;
        $this->global_settings = $global_settings;
        $this->lp_url_builder = $lp_url_builder;
    }

Here is the call graph for this function:

Member Function Documentation

done()

LSControlBuilder::done	(	string	$command,
		?int	$parameter = null
	)

A done control allows the user to mark the object as done.

The $parameter can be used to pass additional information to View::updateGet if required, e.g. about a chapter in the content.

Exceptions

Implements ILIAS\KioskMode\ControlBuilder.

Definition at line 183 of file LSControlBuilder.php.

References ILIAS\Repository\lng().

Referenced by setListenerJS().

                                                                 : ControlBuilder
    {
        if ($this->done_control) {
            throw new \LogicException("Only one done-control per view...", 1);
        }
        $label = $this->lng->txt('lso_player_done');
        $cmd = $this->url_builder->getHref($command, $parameter);
        $btn = $this->ui_factory->button()->primary($label, $cmd);
        $this->done_control = $btn;
        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exit()

LSControlBuilder::exit

(

string

$command

)

An exit control allows the user to gracefully leave the object providing the kiosk mode.

Exceptions

Implements ILIAS\KioskMode\ControlBuilder.

Definition at line 131 of file LSControlBuilder.php.

References ILIAS\Repository\lng(), and ilLSPlayer\LSO_CMD_FINISH.

Referenced by ilLSPlayer\buildDefaultControls().

                                         : ControlBuilder
    {
        if ($this->exit_control) {
            throw new \LogicException("Only one exit-control per view...", 1);
        }
        $cmd = $this->url_builder->getHref($command);

        $label = 'lso_player_suspend';
        if ($command === ilLSPlayer::LSO_CMD_FINISH) {
            $label = 'lso_player_finish';
        }

        $exit_button = $this->ui_factory->button()->bulky(
            $this->ui_factory->symbol()->glyph()->close(),
            $this->lng->txt($label),
            $cmd
        );

        $this->exit_control = $exit_button;
        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

generic()

LSControlBuilder::generic	(	string	$label,
		string	$command,
		?int	$parameter = null
	)

A generic control needs to have a label that tells what it does.

The $parameter can be used to pass additional information to View::updateGet if required, e.g. about a chapter in the content.

Implements ILIAS\KioskMode\ControlBuilder.

Definition at line 195 of file LSControlBuilder.php.

                                                                                   : ControlBuilder
    {
        $cmd = $this->url_builder->getHref($command, $parameter);
        $this->controls[] = $this->ui_factory->button()->standard($label, $cmd);
        return $this;
    }

genericWithSignal()

LSControlBuilder::genericWithSignal	(	string	$label,
		Signal	$signal
	)

Definition at line 202 of file LSControlBuilder.php.

                                                                    : ControlBuilder
    {
        $this->controls[] = $this->ui_factory->button()->standard($label, '')
            ->withOnClick($signal);
        return $this;
    }

getAdditionalJS()

LSControlBuilder::getAdditionalJS

(

)

Definition at line 283 of file LSControlBuilder.php.

References $additional_js.

Referenced by ilKioskPageRenderer\render().

                                     : ?string
    {
        return $this->additional_js;
    }

Here is the caller graph for this function:

getControls()

LSControlBuilder::getControls

(

)

Returns

[]

Definition at line 96 of file LSControlBuilder.php.

References $controls.

Referenced by ilKioskPageRenderer\render().

                                 : array
    {
        return $this->controls;
    }

Here is the caller graph for this function:

getDoneControl()

LSControlBuilder::getDoneControl

(

)

Definition at line 116 of file LSControlBuilder.php.

References $done_control.

Referenced by ilKioskPageRenderer\render().

                                    : ?Component
    {
        return $this->done_control;
    }

Here is the caller graph for this function:

getExitControl()

LSControlBuilder::getExitControl

(

)

Definition at line 101 of file LSControlBuilder.php.

References $exit_control.

Referenced by ilLSPlayer\buildDefaultControls().

                                    : ?Component
    {
        return $this->exit_control;
    }

Here is the caller graph for this function:

getLocator()

LSControlBuilder::getLocator

(

)

Definition at line 126 of file LSControlBuilder.php.

References $loc.

Referenced by ilKioskPageRenderer\render().

                                : ?LocatorBuilder
    {
        return $this->loc;
    }

Here is the caller graph for this function:

getModeControls()

LSControlBuilder::getModeControls

(

)

Returns

[]

Definition at line 88 of file LSControlBuilder.php.

References $mode_controls.

Referenced by ilKioskPageRenderer\render().

                                     : array
    {
        return $this->mode_controls;
    }

Here is the caller graph for this function:

getNextControl()

LSControlBuilder::getNextControl

(

)

Definition at line 111 of file LSControlBuilder.php.

References $next_control.

Referenced by ilLSPlayer\buildDefaultControls(), and ilKioskPageRenderer\render().

                                    : ?Component
    {
        return $this->next_control;
    }

Here is the caller graph for this function:

getPreviousControl()

LSControlBuilder::getPreviousControl

(

)

Definition at line 106 of file LSControlBuilder.php.

References $previous_control.

Referenced by ilLSPlayer\buildDefaultControls(), and ilKioskPageRenderer\render().

                                        : ?Component
    {
        return $this->previous_control;
    }

Here is the caller graph for this function:

getStartControl()

LSControlBuilder::getStartControl

(

)

Definition at line 278 of file LSControlBuilder.php.

References $start.

Referenced by ilKioskPageRenderer\render().

                                     : ?JavaScriptBindable
    {
        return $this->start;
    }

Here is the caller graph for this function:

getToc()

LSControlBuilder::getToc

(

)

Definition at line 121 of file LSControlBuilder.php.

References $toc.

                            : ?TOCBuilder
    {
        return $this->toc;
    }

getToggles()

LSControlBuilder::getToggles

(

)

Returns

[]

Definition at line 80 of file LSControlBuilder.php.

References $toggles.

                                : array
    {
        return $this->toggles;
    }

locator()

LSControlBuilder::locator

(

string

$command

)

A locator allows the user to see the path leading to her current location and jump back to previous items on that path.

The command will be enhanced with a parameter defined in the locator builder.

Exceptions

Implements ILIAS\KioskMode\ControlBuilder.

Definition at line 224 of file LSControlBuilder.php.

References $loc.

                                            : LocatorBuilder
    {
        if ($this->loc) {
            throw new \LogicException("Only one locator per view...", 1);
        }
        $this->loc = new LSLocatorBuilder($command, $this);
        return $this->loc;
    }

mode()

LSControlBuilder::mode	(	string	$command,
		array	$labels
	)

A mode control can be used to switch between different modes in the view.

Uses the indizes of the labels in the array as parameter for the command.

Implements ILIAS\KioskMode\ControlBuilder.

Definition at line 214 of file LSControlBuilder.php.

References ILIAS\KioskMode\ControlBuilder\mode().

                                                        : ControlBuilder
    {
        $actions = [];
        foreach ($labels as $parameter => $label) {
            $actions[$label] = $this->url_builder->getHref($command, $parameter);
        }
        $this->mode_controls[] = $this->ui_factory->viewControl()->mode($actions, '');
        return $this;
    }

Here is the call graph for this function:

next()

LSControlBuilder::next	(	string	$command,
		?int	$parameter = null
	)

A next control allows the user to progress to the next item in the object.

The $parameter can be used to pass additional information to View::updateGet if required, e.g. about a chapter in the content.

Exceptions

Implements ILIAS\KioskMode\ControlBuilder.

Definition at line 153 of file LSControlBuilder.php.

References ILIAS\Repository\lng().

Referenced by ilLSPlayer\buildDefaultControls().

                                                                 : ControlBuilder
    {
        if ($this->next_control) {
            throw new \LogicException("Only one next-control per view...", 1);
        }
        $label = $this->lng->txt('lso_player_next');
        $cmd = $this->url_builder->getHref($command, $parameter);
        $btn = $this->ui_factory->button()->standard($label, $cmd);
        if ($command === '') {
            $btn = $btn->withUnavailableAction();
        }
        $this->next_control = $btn;
        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

previous()

LSControlBuilder::previous	(	string	$command,
		?int	$parameter = null
	)

A previous control allows the user to go back to the previous item in the object.

The $parameter can be used to pass additional information to View::updateGet if required, e.g. about a chapter in the content.

Exceptions

Implements ILIAS\KioskMode\ControlBuilder.

Definition at line 168 of file LSControlBuilder.php.

References ILIAS\Repository\lng().

Referenced by ilLSPlayer\buildDefaultControls().

                                                                     : ControlBuilder
    {
        if ($this->previous_control) {
            throw new \LogicException("Only one previous-control per view...", 1);
        }
        $label = $this->lng->txt('lso_player_previous');
        $cmd = $this->url_builder->getHref($command, $parameter);
        $btn = $this->ui_factory->button()->standard($label, $cmd);
        if ($command === '') {
            $btn = $btn->withUnavailableAction();
        }
        $this->previous_control = $btn;
        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setListenerJS()

LSControlBuilder::setListenerJS ( string  $check_lp_url, string  $on_lp_change_url  )

protected

Definition at line 288 of file LSControlBuilder.php.

References done(), and if.

Referenced by start().

     : void {
        $this->additional_js =
<<<JS
function lso_checkLPOfObject()
{
    if(! il.UICore.isPageVisible()) {
        return;
    }

        $.ajax({
                url: "$check_lp_url",
        }).done(function(data) {
                if(window._lso_current_item_lp === -1) {
                        window._lso_current_item_lp = data;
                }
                if (window._lso_current_item_lp !== data) {
                        location.replace('$on_lp_change_url');
                }
        });
}
JS;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

start()

LSControlBuilder::start	(	string	$label,
		string	$url,
		int	$obj_id
	)

Add a "start"-button as primary.

This is NOT regular behavior, but a special feature for the LegacyView of LearningSequence's sub-objects that do not implement a KioskModeView.

The start-control is exclusively used to open an ILIAS-Object in a new windwow/tab.

Definition at line 253 of file LSControlBuilder.php.

References $id, and setListenerJS().

                                                                  : ControlBuilder
    {
        if ($this->start) {
            throw new \LogicException("Only one start-control per view...", 1);
        }

        $this_cmd = $this->url_builder->getHref(self::CMD_START_OBJECT, 0);
        $lp_cmd = $this->lp_url_builder->getHref(self::CMD_CHECK_CURRENT_ITEM_LP, $obj_id);

        $this->setListenerJS($lp_cmd, $this_cmd);
        $this->start = $this->ui_factory->button()
            ->primary($label, '')
            ->withOnLoadCode(function ($id) use ($url) {
                $interval = $this->global_settings->getPollingIntervalMilliseconds();
                return "$('#$id').on('click', function(ev) {
                    var _lso_win = window.open('$url');
                                });
                window._lso_current_item_lp = -1;
                window.setInterval(lso_checkLPOfObject, $interval);
                ";
            });

        return $this;
    }

Here is the call graph for this function:

tableOfContent()

LSControlBuilder::tableOfContent	(	string	$label,
		string	$command,
		?int	$parameter = null,
			$state = null
	)

A table of content allows the user to get an overview over the generally available content in the object.

The command will be enhanced with a parameter defined here on in the locator builder.

If a parameter is defined here, the view provides an overview-page.

Exceptions

Implements ILIAS\KioskMode\ControlBuilder.

Definition at line 233 of file LSControlBuilder.php.

References $toc.

     : TOCBuilder {
        if ($this->toc) {
            throw new \LogicException("Only one ToC per view...", 1);
        }
        $this->toc = new LSTOCBuilder($this, $command, $label, $parameter, $state);
        return $this->toc;
    }

toggle()

LSControlBuilder::toggle	(	string	$label,
		string	$on_command,
		string	$off_command
	)

A toggle can be used to switch some behaviour in the view on or of.

Implements ILIAS\KioskMode\ControlBuilder.

Definition at line 209 of file LSControlBuilder.php.

                                                                                  : ControlBuilder
    {
        throw new \Exception("NYI: Toggles", 1);
    }

Field Documentation

$additional_js

string LSControlBuilder::$additional_js = null

protected

Definition at line 56 of file LSControlBuilder.php.

Referenced by getAdditionalJS().

$controls

array LSControlBuilder::$controls = []

protected

Definition at line 37 of file LSControlBuilder.php.

Referenced by getControls().

$done_control

Component LSControlBuilder::$done_control = null

protected

Definition at line 52 of file LSControlBuilder.php.

Referenced by getDoneControl().

$exit_control

Component LSControlBuilder::$exit_control = null

protected

Definition at line 49 of file LSControlBuilder.php.

Referenced by getExitControl().

$global_settings

LSGlobalSettings LSControlBuilder::$global_settings

protected

Definition at line 60 of file LSControlBuilder.php.

Referenced by __construct().

$lng

ilLanguage LSControlBuilder::$lng

protected

Definition at line 59 of file LSControlBuilder.php.

$loc

LocatorBuilder LSControlBuilder::$loc = null

protected

Definition at line 54 of file LSControlBuilder.php.

Referenced by getLocator(), and locator().

$lp_url_builder

LSURLBuilder LSControlBuilder::$lp_url_builder

protected

Definition at line 61 of file LSControlBuilder.php.

Referenced by __construct().

$mode_controls

array LSControlBuilder::$mode_controls = []

protected

Definition at line 47 of file LSControlBuilder.php.

Referenced by getModeControls().

$next_control

Component LSControlBuilder::$next_control = null

protected

Definition at line 51 of file LSControlBuilder.php.

Referenced by getNextControl().

$previous_control

Component LSControlBuilder::$previous_control = null

protected

Definition at line 50 of file LSControlBuilder.php.

Referenced by getPreviousControl().

$start

JavaScriptBindable LSControlBuilder::$start = null

protected

Definition at line 55 of file LSControlBuilder.php.

Referenced by getStartControl().

$toc

TOCBuilder LSControlBuilder::$toc = null

protected

Definition at line 53 of file LSControlBuilder.php.

Referenced by getToc(), and tableOfContent().

$toggles

array LSControlBuilder::$toggles = []

protected

Definition at line 42 of file LSControlBuilder.php.

Referenced by getToggles().

$ui_factory

Factory LSControlBuilder::$ui_factory

protected

Definition at line 57 of file LSControlBuilder.php.

Referenced by __construct().

$url_builder

LSURLBuilder LSControlBuilder::$url_builder

protected

Definition at line 58 of file LSControlBuilder.php.

Referenced by __construct().

CMD_CHECK_CURRENT_ITEM_LP

const LSControlBuilder::CMD_CHECK_CURRENT_ITEM_LP = 'ccilp'

Definition at line 32 of file LSControlBuilder.php.

Referenced by ilObjLearningSequenceLPPollingGUI\executeCommand(), and ilLSLocalDI\init().

CMD_START_OBJECT

const LSControlBuilder::CMD_START_OBJECT = 'start_legacy_obj'

Definition at line 31 of file LSControlBuilder.php.

---

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

• components/ILIAS/LearningSequence/classes/Player/LSControlBuilder.php