class.ilLMHtmlExportViewLayoutProvider.php

Go to the documentation of this file.

<?php

use ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider;
use ILIAS\GlobalScreen\Scope\Layout\Provider\ModificationProvider;
use ILIAS\GlobalScreen\Scope\Layout\Factory\MetaBarModification;
use ILIAS\GlobalScreen\Scope\Layout\Factory\MainBarModification;
use ILIAS\GlobalScreen\Scope\Layout\Factory\BreadCrumbsModification;
use ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts;
use ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection;
use ILIAS\UI\Component\MainControls\MetaBar;
use ILIAS\UI\Component\MainControls\MainBar;
use ILIAS\UI\Component\Breadcrumbs\Breadcrumbs;

class ilLMHtmlExportViewLayoutProvider extends AbstractModificationProvider implements ModificationProvider
{
    public const LM_HTML_EXPORT_RENDERING = 'lm_html_export_rendering';

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

    public function getMetaBarModification(CalledContexts $screen_context_stack): ?MetaBarModification
    {
        $additional_data = $screen_context_stack->current()->getAdditionalData();
        if ($additional_data->is(self::LM_HTML_EXPORT_RENDERING, true)) {
            return $this->globalScreen()
                ->layout()
                ->factory()
                ->metabar()
                ->withModification(function (?MetaBar $current = null): ?MetaBar {
                    return null;
                })->withHighPriority();
        }
        return null;
    }

    public function getMainBarModification(CalledContexts $screen_context_stack): ?MainBarModification
    {
        $additional_data = $screen_context_stack->current()->getAdditionalData();
        if ($additional_data->is(self::LM_HTML_EXPORT_RENDERING, true)) {
            return $this->globalScreen()
                ->layout()
                ->factory()
                ->mainbar()
                ->withModification(function (?MainBar $current = null): ?MainBar {
                    if ($current === null) {
                        return null;
                    }
                    global $DIC;

                    $lng = $DIC->language();
                    $f = $DIC->ui()->factory();

                    // create an offline main bar
                    $offline_main_bar = new \ILIAS\UI\Implementation\Component\MainControls\MainBar(
                        new \ILIAS\UI\Implementation\Component\SignalGenerator()
                    );
                    $grid_icon = $f->symbol()->icon()->custom(\ilUtil::getImagePath("standard/icon_tool.svg"), $lng->txt("more"));
                    $tools_button = $f->button()->bulky($grid_icon, $lng->txt("tools"), "#")->withEngagedState(true);
                    $offline_main_bar = $offline_main_bar->withToolsButton($tools_button);

                    // get tool ids for offline use from lm tools provider
                    $lm_tools = new ilLMGSToolProvider($DIC);
                    $ids = $lm_tools->getOfflineToolIds();

                    // copy all offline tools from original main bar to offline main bar
                    foreach ($current->getToolEntries() as $id => $te) {
                        if (in_array($id, $ids)) {
                            $offline_main_bar = $offline_main_bar->withAdditionalToolEntry(
                                $id,
                                $te
                            );
                        }
                    }

                    return $offline_main_bar;
                })->withHighPriority();
        } else {
            return null;
        }
    }

    public function getBreadCrumbsModification(CalledContexts $screen_context_stack): ?BreadCrumbsModification
    {
        $additional_data = $screen_context_stack->current()->getAdditionalData();
        if ($additional_data->is(self::LM_HTML_EXPORT_RENDERING, true)) {
            return $this->globalScreen()
                ->layout()
                ->factory()
                ->breadcrumbs()
                ->withModification(function (?Breadcrumbs $current = null): ?Breadcrumbs {
                    return null;
                })->withHighPriority();
        } else {
            return null;
        }
    }
}