class.ilLegacyKioskModeView.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\KioskMode\ControlBuilder;
use ILIAS\KioskMode\State;
use ILIAS\KioskMode\URLBuilder;
use ILIAS\UI\Component\Component;
use ILIAS\UI\Factory;
use ILIAS\MetaData\Services\ServicesInterface as LOMServices;

class ilLegacyKioskModeView implements ILIAS\KioskMode\View
{
    public const GET_VIEW_CMD_FROM_LIST_GUI_FOR = ['sahs'];

    protected ilObject $object;
    protected ilLanguage $lng;
    protected ilAccess $access;
    protected LOMServices $lom_services;

    public function __construct(
        ilObject $object,
        ilLanguage $lng,
        ilAccess $access,
        LOMServices $lom_services
    ) {
        $this->object = $object;
        $this->lng = $lng;
        $this->access = $access;
        $this->lom_services = $lom_services;
    }

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

    protected function setObject(\ilObject $object): void
    {
        $this->object = $object;
    }

    protected function hasPermissionToAccessKioskMode(): bool
    {
        return true;
    }

    public function buildInitialState(State $empty_state): State
    {
        return $empty_state;
    }

    public function buildControls(State $state, ControlBuilder $builder): 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('&amp;', '&', $view_link);
            $view_link = ILIAS_HTTP_PATH . '/' . $view_link;
            $url = $view_link;
        }

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

        return $builder;
    }

    public function updateGet(State $state, string $command, ?int $parameter = null): State
    {
        return $state;
    }

    public function updatePost(State $state, string $command, array $post): State
    {
        return $state;
    }

    public function render(
        State $state,
        Factory $factory,
        URLBuilder $url_builder,
        ?array $post = null
    ): 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)
            ]
        );
    }

    //TODO: enhance metadata
    private function getMetadata(int $obj_id, string $type): 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;
    }

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