ilLegacyKioskModeView Class Reference

Inheritance diagram for ilLegacyKioskModeView:

Collaboration diagram for ilLegacyKioskModeView:

Public Member Functions
	__construct (ilObject $object, ilLanguage $lng, ilAccess $access, LOMServices $lom_services)
	buildInitialState (State $empty_state)
	buildControls (State $state, ControlBuilder $builder)
	updateGet (State $state, string $command, ?int $parameter=null)
	updatePost (State $state, string $command, array $post)
	render (State $state, Factory $factory, URLBuilder $url_builder, ?array $post=null)
Public Member Functions inherited from ILIAS\KioskMode\View
	render (State $state, UI\Factory $factory, URLBuilder $url_builder, ?array $post=null)
	Render a state using the ui-factory and URLs from the builder. More...

Data Fields
const	GET_VIEW_CMD_FROM_LIST_GUI_FOR = ['sahs']

Protected Member Functions
	getObjectTitle ()
	setObject (\ilObject $object)
	hasPermissionToAccessKioskMode ()

Protected Attributes
ilObject	$object
ilLanguage	$lng
ilAccess	$access
LOMServices	$lom_services

Private Member Functions
	getMetadata (int $obj_id, string $type)
	getTitleByType (string $type)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilLegacyKioskModeView::__construct	(	ilObject	$object,
		ilLanguage	$lng,
		ilAccess	$access,
		LOMServices	$lom_services
	)

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

References $access, $lng, $lom_services, $object, ILIAS\Repository\access(), and ILIAS\Repository\lng().

      {
        $this->object = $object;
        $this->lng = $lng;
        $this->access = $access;
        $this->lom_services = $lom_services;
    }

Here is the call graph for this function:

Member Function Documentation

buildControls()

ilLegacyKioskModeView::buildControls	(	State	$state,
		ControlBuilder	$builder
	)

Implements ILIAS\KioskMode\View.

Definition at line 75 of file class.ilLegacyKioskModeView.php.

References $ref_id, $url, ilObjectListGUIFactory\_getListGUIByType(), ilLink\_getStaticLink(), getTitleByType(), and ILIAS\Repository\lng().

                                                                        : ControlBuilder
    {
        if (!$builder instanceof LSControlBuilder) {
            throw new LogicException("The Legacy Mode in the Learning Sequence requires an LSControlBuilder explicitely.", 1);
        }

        $ref_id = $this->object->getRefId();
        $type = $this->object->getType();

        $label = sprintf(
            $this->lng->txt('lso_start_item'),
            $this->getTitleByType($type)
        );

        $url = \ilLink::_getStaticLink(
            $ref_id,
            $type
        );

        $obj_id = $this->object->getId();
        if (in_array($type, self::GET_VIEW_CMD_FROM_LIST_GUI_FOR)) {
            $item_list_gui = \ilObjectListGUIFactory::_getListGUIByType($type);
            $item_list_gui->initItem($ref_id, $obj_id, $type);
            $view_link = $item_list_gui->getCommandLink('view');
            $view_link = str_replace('&', '&', $view_link);
            $view_link = ILIAS_HTTP_PATH . '/' . $view_link;
            $url = $view_link;
        }

        $builder->start($label, $url, $obj_id);

        return $builder;
    }

Here is the call graph for this function:

buildInitialState()

ilLegacyKioskModeView::buildInitialState

(

State

$empty_state

)

Implements ILIAS\KioskMode\View.

Definition at line 67 of file class.ilLegacyKioskModeView.php.

                                                         : State
    {
        return $empty_state;
    }

getMetadata()

ilLegacyKioskModeView::getMetadata ( int  $obj_id, string  $type  )

private

Returns

array<string, string>|[]

Definition at line 159 of file class.ilLegacyKioskModeView.php.

References ILIAS\Repository\lng().

Referenced by render().

                                                           : array
    {
        $paths = $this->lom_services->paths();
        $data_helper = $this->lom_services->dataHelper();
        $reader = $this->lom_services->read(
            $obj_id,
            0,
            $type,
            $paths->custom()->withNextStep('general')->get()
        );

        $meta_data = [];

        $languages = $data_helper->makePresentableAsList(
            ', ',
            ...$reader->allData($paths->languages())
        );
        if ($languages !== '') {
            $meta_data[$this->lng->txt('language')] = $languages;
        }

        $keywords = $data_helper->makePresentableAsList(
            ', ',
            ...$reader->allData($paths->keywords())
        );
        if ($keywords !== '') {
            $meta_data[$this->lng->txt('keywords')] = $keywords;
        }

        return $meta_data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectTitle()

ilLegacyKioskModeView::getObjectTitle ( )

protected

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

                                       : string
    {
        return $this->object->getTitle();
    }

getTitleByType()

ilLegacyKioskModeView::getTitleByType ( string  $type )

private

Definition at line 191 of file class.ilLegacyKioskModeView.php.

References ILIAS\Repository\lng().

Referenced by buildControls().

                                                 : string
    {
        return $this->lng->txt("obj_" . $type);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasPermissionToAccessKioskMode()

ilLegacyKioskModeView::hasPermissionToAccessKioskMode ( )

protected

Definition at line 59 of file class.ilLegacyKioskModeView.php.

                                                       : bool
    {
        return true;
    }

render()

ilLegacyKioskModeView::render	(	State	$state,
		Factory	$factory,
		URLBuilder	$url_builder,
		?array	$post = null
	)

Definition at line 128 of file class.ilLegacyKioskModeView.php.

References getMetadata(), ILIAS\UI\Factory\item(), ILIAS\Repository\lng(), ILIAS\UI\Factory\messageBox(), ILIAS\Repository\object(), ILIAS\UI\Factory\panel(), and ILIAS\UI\Factory\symbol().

     : Component {
        $obj_type = $this->object->getType();
        $obj_type_txt = $this->lng->txt('obj_' . $obj_type);
        $icon = $factory->symbol()->icon()->standard($obj_type, $obj_type_txt, 'large');

        $props = array_merge(
            [$this->lng->txt('obj_type') => $obj_type_txt],
            $this->getMetadata($this->object->getId(), $obj_type)
        );

        return $factory->panel()->standard(
            $this->object->getTitle(),
            [
                $factory->messageBox()->info($this->lng->txt('lso_legacy_info')),
                $factory->item()->standard($this->object->getTitle())
                    ->withLeadIcon($icon)
                    ->withDescription($this->object->getDescription())
                    ->withProperties($props)
            ]
        );
    }

Here is the call graph for this function:

setObject()

ilLegacyKioskModeView::setObject ( \ilObject  $object )

protected

Definition at line 54 of file class.ilLegacyKioskModeView.php.

References $object.

                                                   : void
    {
        $this->object = $object;
    }

updateGet()

ilLegacyKioskModeView::updateGet	(	State	$state,
		string	$command,
		?int	$parameter = null
	)

Implements ILIAS\KioskMode\View.

Definition at line 112 of file class.ilLegacyKioskModeView.php.

                                                                                    : State
    {
        return $state;
    }

updatePost()

ilLegacyKioskModeView::updatePost	(	State	$state,
		string	$command,
		array	$post
	)

Implements ILIAS\KioskMode\View.

Definition at line 120 of file class.ilLegacyKioskModeView.php.

                                                                          : State
    {
        return $state;
    }

Field Documentation

$access

ilAccess ilLegacyKioskModeView::$access

protected

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

Referenced by __construct().

$lng

ilLanguage ilLegacyKioskModeView::$lng

protected

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

Referenced by __construct().

$lom_services

LOMServices ilLegacyKioskModeView::$lom_services

protected

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

Referenced by __construct().

$object

ilObject ilLegacyKioskModeView::$object

protected

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

Referenced by __construct(), and setObject().

GET_VIEW_CMD_FROM_LIST_GUI_FOR

const ilLegacyKioskModeView::GET_VIEW_CMD_FROM_LIST_GUI_FOR = ['sahs']

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

---

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

• components/ILIAS/LearningSequence/classes/Player/class.ilLegacyKioskModeView.php