LtiViewLayoutProvider.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\LTI\Screen;

use ILIAS\GlobalScreen\Scope\Layout\Provider\PagePart\PagePartProvider;
use ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider;
use ILIAS\GlobalScreen\Scope\Layout\Provider\ModificationProvider;
use ILIAS\GlobalScreen\Scope\Layout\Builder\StandardPageBuilder;
use ILIAS\GlobalScreen\Scope\Layout\Factory\PageBuilderModification;
use ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts;
use ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection;
use ILIAS\UI\Component\Layout\Page\Page;
use ILIAS\UI\Component\MainControls\MetaBar;
use ILIAS\UI\Component\MainControls\MainBar;
use ILIAS\GlobalScreen\Scope\Layout\Factory\MainBarModification;
use ILIAS\GlobalScreen\Scope\Layout\Factory\MetaBarModification;
use ILIAS\GlobalScreen\Scope\Layout\Factory\TitleModification;
use ILIAS\Container\Screen\MemberViewLayoutProvider;

class LtiViewLayoutProvider extends AbstractModificationProvider implements ModificationProvider
{
    public const GS_EXIT_LTI = 'lti_exit_mode';

    private const MODIFICATION_PRIORITY = 63;

    public function isInterestedInContexts(): ContextCollection
    {
        return $this->context_collection->lti();
    }

    public function getPageBuilderDecorator(CalledContexts $screen_context_stack): ?PageBuilderModification
    {
        $this->globalScreen()->layout()->meta()->addCss('./Services/LTI/templates/default/lti.css');
        $is_exit_mode = $this->isLTIExitMode($screen_context_stack);
        $external_css = ($is_exit_mode) ? '' : $this->dic["lti"]->getExternalCss();
        if ($external_css !== '') {
            $this->globalScreen()->layout()->meta()->addCss($external_css);
        }

        return $this->factory->page()
                             ->withModification(
                                 function (PagePartProvider $parts): Page {
                                     $p = new StandardPageBuilder();
                                     $page = $p->build($parts);

                                     $mv_modeinfo = MemberViewLayoutProvider::getMemberViewModeInfo($this->dic);
                                     if ($mv_modeinfo) {
                                         $page = $page->withModeInfo($mv_modeinfo);
                                     }

                                     return $page->withNoFooter();
                                 }
                             )
                             ->withPriority(self::MODIFICATION_PRIORITY);
    }

    protected function isLTIExitMode(CalledContexts $screen_context_stack): bool
    {
        $data_collection = $screen_context_stack->current()->getAdditionalData();
        $is_exit_mode = $data_collection->is(self::GS_EXIT_LTI, true);
        return $is_exit_mode;
    }

    public function getMainBarModification(CalledContexts $screen_context_stack): ?MainBarModification
    {
        $is_exit_mode = $this->isLTIExitMode($screen_context_stack);

        return $this->globalScreen()->layout()->factory()->mainbar()
                    ->withModification(
                        function (?MainBar $mainbar) use ($is_exit_mode): ?MainBar {
                            $tools = $mainbar->getToolEntries();
                            $mainbar = $mainbar->withClearedEntries();
                            if ($is_exit_mode) {
                                return $mainbar;
                            }
                            foreach ($tools as $id => $entry) {
                                $mainbar = $mainbar->withAdditionalToolEntry($id, $entry);
                            }
                            //$mainbar = $mainbar->withAdditionalEntry('lti_home', $lti_home);
                            return $mainbar;
                        }
                    )
                    ->withPriority(self::MODIFICATION_PRIORITY);
    }

    public function getMetaBarModification(CalledContexts $screen_context_stack): ?MetaBarModification
    {
        $is_exit_mode = $this->isLTIExitMode($screen_context_stack);

        return $this->globalScreen()->layout()->factory()->metabar()
                    ->withModification(
                        function (?MetaBar $metabar) use ($is_exit_mode, $screen_context_stack): ?Metabar {
                            $metabar = $metabar->withClearedEntries();
                            if ($is_exit_mode) {
                                return $metabar;
                            }
                            $f = $this->dic->ui()->factory();
                            $exit_symbol = $f->symbol()->glyph()->close();
                            $exit_txt = $this->dic['lti']->lng->txt('lti_exit');
                            $exit = $f->button()->bulky($exit_symbol, $exit_txt, $this->dic["lti"]->getCmdLink('exit'));
                            $metabar = $metabar->withAdditionalEntry('exit', $exit);
                            return $metabar;
                        }
                    )
                    ->withPriority(self::MODIFICATION_PRIORITY);
    }

    public function getTitleModification(CalledContexts $screen_context_stack): ?TitleModification
    {
        $is_exit_mode = $this->isLTIExitMode($screen_context_stack);

        return $this->globalScreen()->layout()->factory()->title()
                    ->withModification(
                        function (?string $content) use ($is_exit_mode): string {
                            if ($is_exit_mode) {
                                return $this->dic["lti"]->getTitleForExitPage();
                            }
                            return $this->dic["lti"]->getTitle();
                        }
                    )
                    ->withPriority(self::MODIFICATION_PRIORITY);
    }
}