LSControlBuilder Class Reference

Class LSControlBuilder. More...

Inheritance diagram for LSControlBuilder:

Collaboration diagram for LSControlBuilder:

Public Member Functions
	__construct (Factory $ui_factory, LSURLBuilder $url_builder, ilLanguage $language, LSGlobalSettings $global_settings)
	getExitControl ()
	getPreviousControl ()
	getNextControl ()
	getDoneControl ()
	getToggles ()
	getModeControls ()
	getControls ()
	getLocator ()
	getToc ()
	exit (string $command)
	An exit control allows the user to gracefully leave the object providing the kiosk mode. Exceptions More...
	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 More...
	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 More...
	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 More...
	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. More...
	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.Uses the indizes of the labels in the array as parameter for the command. 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.The command will be enhanced with a parameter defined in the locator builder. Exceptions 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.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 More...
	start (string $label, string $url, int $parameter=null)
	Add a "start"-button as primary. More...
	getStartControl ()
	getAdditionalJS ()

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

Protected Member Functions
	getStartSignal ()
	This is a hack and not supposed to be considered as a common way to inject JS-Code and bind it to a button. More...
	setListenerJS (string $signal_id, string $new_win_url, string $check_lp_url, string $on_lp_change_url)

Protected Attributes
	$exit_control
	$previous_control
	$next_control
	$done_control
	$controls = []
	$toggles = []
	$mode_controls = []
	$toc
	$loc
	$ui_factory
	$url_builder
	$start
	$additional_js
	$global_settings

Detailed Description

Class LSControlBuilder.

Definition at line 15 of file LSControlBuilder.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 91 of file LSControlBuilder.php.

References $global_settings, $language, $ui_factory, and $url_builder.

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

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 211 of file LSControlBuilder.php.

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 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 151 of file LSControlBuilder.php.

References 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()->shy(
            $this->lng->txt($label),
            $cmd
        );

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

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 226 of file LSControlBuilder.php.

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

getAdditionalJS()

LSControlBuilder::getAdditionalJS

(

)

Definition at line 339 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

(

)

Definition at line 133 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 118 of file LSControlBuilder.php.

References $done_control.

Referenced by ilKioskPageRenderer\render().

    {
        return $this->done_control;
    }

Here is the caller graph for this function:

getExitControl()

LSControlBuilder::getExitControl

(

)

Definition at line 103 of file LSControlBuilder.php.

References $exit_control.

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

    {
        return $this->exit_control;
    }

Here is the caller graph for this function:

getLocator()

LSControlBuilder::getLocator

(

)

Definition at line 138 of file LSControlBuilder.php.

References $loc.

Referenced by ilKioskPageRenderer\render().

    {
        return $this->loc;
    }

Here is the caller graph for this function:

getModeControls()

LSControlBuilder::getModeControls

(

)

Definition at line 128 of file LSControlBuilder.php.

References $mode_controls.

Referenced by ilKioskPageRenderer\render().

    {
        return $this->mode_controls;
    }

Here is the caller graph for this function:

getNextControl()

LSControlBuilder::getNextControl

(

)

Definition at line 113 of file LSControlBuilder.php.

References $next_control.

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

    {
        return $this->next_control;
    }

Here is the caller graph for this function:

getPreviousControl()

LSControlBuilder::getPreviousControl

(

)

Definition at line 108 of file LSControlBuilder.php.

References $previous_control.

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

    {
        return $this->previous_control;
    }

Here is the caller graph for this function:

getStartControl()

LSControlBuilder::getStartControl

(

)

Definition at line 320 of file LSControlBuilder.php.

References $start.

Referenced by ilKioskPageRenderer\render().

    {
        return $this->start;
    }

Here is the caller graph for this function:

getStartSignal()

LSControlBuilder::getStartSignal ( )

protected

This is a hack and not supposed to be considered as a common way to inject JS-Code and bind it to a button.

However, for the time beeing and the lack of a general alternative, I think it's OK to do this for legacy(!)-objects here...

Definition at line 331 of file LSControlBuilder.php.

References $id.

Referenced by start().

                                        : ILIAS\UI\Component\Signal
    {
        $id = uniqid();
        $signal = new ILIAS\UI\Implementation\Component\Signal($id);
        return $signal;
    }

Here is the caller graph for this function:

getToc()

LSControlBuilder::getToc

(

)

Definition at line 143 of file LSControlBuilder.php.

References $toc.

Referenced by ilKioskPageRenderer\render().

    {
        return $this->toc;
    }

Here is the caller graph for this function:

getToggles()

LSControlBuilder::getToggles

(

)

Definition at line 123 of file LSControlBuilder.php.

References $toggles.

    {
        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 262 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 249 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 175 of file LSControlBuilder.php.

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 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 193 of file LSControlBuilder.php.

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 caller graph for this function:

setListenerJS()

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

protected

Definition at line 344 of file LSControlBuilder.php.

References data, done(), if, and Sabre\Event\on().

Referenced by start().

      {
        $interval = $this->global_settings->getPollingIntervalMilliseconds();
        $this->additional_js =
<<<JS
function lso_checkLPOfObject() {
        $.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');
                }
        });
}

$(document).on('{$signal_id}', function() {
        var il_ls_win = window.open('$new_win_url');
});
window._lso_current_item_lp = -1;
lso_checkLPOfObject();
window.setInterval(lso_checkLPOfObject, $interval);
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	$parameter = null
	)

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 294 of file LSControlBuilder.php.

References $url, getStartSignal(), 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 = str_replace(
            '&cmd=view&',
            '&cmd=' . self::CMD_CHECK_CURRENT_ITEM_LP . '&',
            $this_cmd
        );

        $current_obj_id = $parameter;
        $lp_cmd .= '&' . self::PARAM_LP_CURRENT_ITEM_OBJID . '=' . $current_obj_id;

        $signal = $this->getStartSignal();
        $this->setListenerJS($signal->getId(), $url, $lp_cmd, $this_cmd);

        $this->start = $this->ui_factory->button()
            ->primary($label, '')
            ->withOnClick($signal);

        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 274 of file LSControlBuilder.php.

References $state, and $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 236 of file LSControlBuilder.php.

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

        $cmd_on = $this->url_builder->getHref($on_command, 0);
        $cmd_off = $this->url_builder->getHref($off_command, 0);
        //build toggle and add to $this->toggles
        //return $this;
    }

Field Documentation

$additional_js

LSControlBuilder::$additional_js

protected

Definition at line 84 of file LSControlBuilder.php.

Referenced by getAdditionalJS().

$controls

LSControlBuilder::$controls = []

protected

Definition at line 44 of file LSControlBuilder.php.

Referenced by getControls().

$done_control

LSControlBuilder::$done_control

protected

Definition at line 39 of file LSControlBuilder.php.

Referenced by getDoneControl().

$exit_control

LSControlBuilder::$exit_control

protected

Definition at line 24 of file LSControlBuilder.php.

Referenced by getExitControl().

$global_settings

LSControlBuilder::$global_settings

protected

Definition at line 89 of file LSControlBuilder.php.

Referenced by __construct().

$loc

LSControlBuilder::$loc

protected

Definition at line 64 of file LSControlBuilder.php.

Referenced by getLocator(), and locator().

$mode_controls

LSControlBuilder::$mode_controls = []

protected

Definition at line 54 of file LSControlBuilder.php.

Referenced by getModeControls().

$next_control

LSControlBuilder::$next_control

protected

Definition at line 34 of file LSControlBuilder.php.

Referenced by getNextControl().

$previous_control

LSControlBuilder::$previous_control

protected

Definition at line 29 of file LSControlBuilder.php.

Referenced by getPreviousControl().

$start

LSControlBuilder::$start

protected

Definition at line 79 of file LSControlBuilder.php.

Referenced by getStartControl().

$toc

LSControlBuilder::$toc

protected

Definition at line 59 of file LSControlBuilder.php.

Referenced by getToc(), and tableOfContent().

$toggles

LSControlBuilder::$toggles = []

protected

Definition at line 49 of file LSControlBuilder.php.

Referenced by getToggles().

$ui_factory

LSControlBuilder::$ui_factory

protected

Definition at line 69 of file LSControlBuilder.php.

Referenced by __construct().

$url_builder

LSControlBuilder::$url_builder

protected

Definition at line 74 of file LSControlBuilder.php.

Referenced by __construct().

CMD_CHECK_CURRENT_ITEM_LP

const LSControlBuilder::CMD_CHECK_CURRENT_ITEM_LP = 'ccilp'

Definition at line 18 of file LSControlBuilder.php.

Referenced by ilObjLearningSequenceGUI\executeCommand().

CMD_START_OBJECT

const LSControlBuilder::CMD_START_OBJECT = 'start_legacy_obj'

Definition at line 17 of file LSControlBuilder.php.

PARAM_LP_CURRENT_ITEM_OBJID

const LSControlBuilder::PARAM_LP_CURRENT_ITEM_OBJID = 'ccilpobjid'

Definition at line 19 of file LSControlBuilder.php.

Referenced by ilObjLearningSequenceGUI\executeCommand().

---

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

• Modules/LearningSequence/classes/Player/LSControlBuilder.php