class.ilLearningModuleKioskModeView.php

Go to the documentation of this file.

<?php

use ILIAS\KioskMode\ControlBuilder;
use ILIAS\KioskMode\State;
use ILIAS\KioskMode\URLBuilder;
use ILIAS\UI\Component\Component;
use ILIAS\UI\Component\MessageBox\MessageBox;
use ILIAS\UI\Factory;
use ILIAS\UI\Renderer;
use Psr\Http\Message\ServerRequestInterface;

class ilLearningModuleKioskModeView extends ilKioskModeView
{
    public const CMD_TOGGLE_LEARNING_PROGRESS = 'toggleManualLearningProgress';
    protected ilPageObject $contentPageObject;

    protected ilObjLearningModule $lm;
    protected ilLMPresentationService $lm_pres_service;
    protected ?ilLMPresentationGUI $lm_pres = null;
    protected ilObjUser $user;
    protected Factory $uiFactory;
    protected Renderer $uiRenderer;
    protected ilGlobalTemplateInterface $mainTemplate;
    protected ServerRequestInterface $httpRequest;
    protected ilTabsGUI $tabs;
    protected array $messages = [];
    protected ?int $current_page_id = 0;
    protected array $additional_content = [];
    protected ?array $menu_entries = null;

    protected function getObjectClass(): string
    {
        return \ilObjLearningModule::class;
    }

    protected function setObject(\ilObject $object): void
    {
        global $DIC;

        $this->lm = $object;
        $this->ctrl = $DIC->ctrl();
        $this->mainTemplate = $DIC->ui()->mainTemplate();
        $this->uiFactory = $DIC->ui()->factory();
        $this->uiRenderer = $DIC->ui()->renderer();
        $this->httpRequest = $DIC->http()->request();
        $this->tabs = $DIC->tabs();
        $this->user = $DIC->user();
    }

    public function updateGet(
        State $state,
        string $command,
        int $parameter = null
    ): State {
        switch ($command) {
            case "layout":
                if ($parameter > 0) {
                    $this->current_page_id = $parameter;
                    $state = $state->withValueFor("current_page", (string) $this->current_page_id);
                }
                break;
            case self::CMD_TOGGLE_LEARNING_PROGRESS:
                $this->toggleLearningProgress($command);
                break;
        }

        //$this->initLMService($this->current_page_id);

        return $state;
    }

    // Init learning module presentation service
    protected function initLMService(?int $current_page): void
    {
        if (is_object($this->lm_pres)) {
            return;
        }
        $this->lm_pres = new ilLMPresentationGUI(
            "",
            false,
            "",
            false,
            ["ref_id" => $this->lm->getRefId(),
             "obj_id" => (int) $current_page],
            true
        );

        $this->lm_pres_service = $this->lm_pres->getService();
    }

    protected function hasPermissionToAccessKioskMode(): bool
    {
        return $this->access->checkAccess('read', '', $this->lm->getRefId());
    }

    public function buildInitialState(State $empty_state): State
    {
        return $empty_state->withValueFor("current_page", "");
    }

    public function buildControls(
        State $state,
        ControlBuilder $builder
    ): ControlBuilder {
        global $DIC;

        $main_tpl = $DIC->ui()->mainTemplate();

        // this may be necessary if updateGet has not been processed

        // THIS currently fails
        $this->initLMService((int) $state->getValueFor("current_page"));
        $nav_stat = $this->lm_pres_service->getNavigationStatus();

        // next
        $succ_id = $nav_stat->getSuccessorPageId();
        if ($succ_id > 0) {
            $builder->next("layout", $succ_id);
        }

        // previous
        $prev_id = $nav_stat->getPredecessorPageId();
        if ($prev_id > 0) {
            $builder->previous("layout", $prev_id);
        }

        $toc = $builder->tableOfContent($this->lm->getTitle(), 'layout', 0);
        $lm_toc_renderer = new ilLMSlateTocRendererGUI($this->lm_pres_service);
        $lm_toc_renderer->renderLSToc($toc);

        // learning progress
        $builder = $this->maybeBuildLearningProgressToggleControl($builder);

        // menu
        foreach ($this->getMenuEntries() as $entry) {
            if (is_object($entry["signal"])) {
                $builder = $builder->genericWithSignal(
                    $entry["label"],
                    $entry["signal"]
                );
            }
            if ($entry["on_load"] != "") {
                $main_tpl->addOnLoadCode($entry["on_load"]);
            }
        }

        //$builder = $this->addPrintViewSelectionMenuButton($builder);

        return $builder;
    }

    protected function getMenuEntries(): array
    {
        if (is_null($this->menu_entries)) {
            $menu = new \ILIAS\LearningModule\Menu\ilLMMenuGUI($this->lm_pres_service);
            $this->menu_entries = $menu->getEntries();
        }
        return $this->menu_entries;
    }

    protected function maybeBuildLearningProgressToggleControl(
        ControlBuilder $builder
    ): ControlBuilder {
        $learningProgress = \ilObjectLP::getInstance($this->lm->getId());
        if ($learningProgress->getCurrentMode() == \ilLPObjSettings::LP_MODE_MANUAL) {
            $isCompleted = \ilLPMarks::_hasCompleted($this->user->getId(), $this->lm->getId());

            $this->lng->loadLanguageModule('lm');
            $learningProgressToggleCtrlLabel = $this->lng->txt('lm_btn_lp_toggle_state_completed');
            if (!$isCompleted) {
                $learningProgressToggleCtrlLabel = $this->lng->txt('lm_btn_lp_toggle_state_not_completed');
            }
            $builder = $builder->generic(
                $learningProgressToggleCtrlLabel,
                self::CMD_TOGGLE_LEARNING_PROGRESS,
                1
            );
        }
        return $builder;
    }

    protected function toggleLearningProgress(
        string $command
    ): void {
        if (self::CMD_TOGGLE_LEARNING_PROGRESS === $command) {
            $learningProgress = \ilObjectLP::getInstance($this->lm->getId());
            if ($learningProgress->getCurrentMode() == \ilLPObjSettings::LP_MODE_MANUAL) {
                $marks = new \ilLPMarks($this->lm->getId(), $this->user->getId());
                $marks->setCompleted(!$marks->getCompleted());
                $marks->update();

                \ilLPStatusWrapper::_updateStatus($this->lm->getId(), $this->user->getId());

                $this->lng->loadLanguageModule('trac');
                $this->messages[] = $this->uiFactory->messageBox()->success(
                    $this->lng->txt('trac_updated_status')
                );
            }
        }
    }

    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 {
        $this->initLMService((int) $state->getValueFor("current_page"));

        $additional_content = [];
        foreach ($this->getMenuEntries() as $entry) {
            if (is_object($entry["modal"])) {
                $additional_content[] = $entry["modal"];
            }
        }

        $this->ctrl->setParameterByClass("illmpresentationgui", 'ref_id', $this->lm->getRefId());
        $content = $this->uiRenderer->render($this->messages);
        $content .= $this->ctrl->getHTML($this->lm_pres, ["cmd" => "layout"], ["illmpresentationgui"]);
        $content .= $this->uiRenderer->render($additional_content);
        return $factory->legacy($content);
    }
}