class.ilHTMLExportViewLayoutProvider.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
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;
use ILIAS\GlobalScreen\Scope\Layout\Factory\FooterModification;
use ILIAS\UI\Component\MainControls\Footer;
 
class ilHTMLExportViewLayoutProvider extends AbstractModificationProvider implements ModificationProvider
{
    public const HTML_EXPORT_RENDERING = 'html_export_rendering';
 
    public function isInterestedInContexts(): ContextCollection
    {
        return $this->context_collection->main();
    }
 
    public function getMetaBarModification(CalledContexts $called_contexts): ?MetaBarModification
    {
        $additional_data = $called_contexts->current()->getAdditionalData();
        if ($additional_data->is(self::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 $called_contexts): ?MainBarModification
    {
        $additional_data = $called_contexts->current()->getAdditionalData();
        if ($additional_data->is(self::HTML_EXPORT_RENDERING, true)) {
            return $this->globalScreen()
                        ->layout()
                        ->factory()
                        ->mainbar()
                        ->withModification(function (?MainBar $current = null): ?MainBar {
                            return null;
                        })->withHighPriority();
        } else {
            return null;
        }
    }
 
    public function getBreadCrumbsModification(CalledContexts $called_contexts): ?BreadCrumbsModification
    {
        $additional_data = $called_contexts->current()->getAdditionalData();
        if ($additional_data->is(self::HTML_EXPORT_RENDERING, true)) {
            return $this->globalScreen()
                        ->layout()
                        ->factory()
                        ->breadcrumbs()
                        ->withModification(function (?Breadcrumbs $current = null): ?Breadcrumbs {
                            return null;
                        })->withHighPriority();
        } else {
            return null;
        }
    }
 
    public function getFooterModification(CalledContexts $called_contexts): ?FooterModification
    {
        $additional_data = $called_contexts->current()->getAdditionalData();
        if ($additional_data->is(self::HTML_EXPORT_RENDERING, true)) {
            return $this->globalScreen()
                        ->layout()
                        ->factory()
                        ->footer()
                        ->withModification(function (?Footer $current = null): ?Footer {
                            return null;
                        })->withHighPriority();
        } else {
            return null;
        }
    }
}