LM HTML export view layout provider, hides main and meta bar. More...

Inheritance diagram for ilLMHtmlExportViewLayoutProvider:

Collaboration diagram for ilLMHtmlExportViewLayoutProvider:

Public Member Functions
	isInterestedInContexts ()
	@inheritDoc More...

	getMetaBarModification (CalledContexts $called_contexts)
	No meta bar in HTML exports. More...

	getMainBarModification (CalledContexts $called_contexts)
	No main bar in HTML exports. More...

	getBreadCrumbsModification (CalledContexts $called_contexts)
	No breadcrumbs in HTML exports. More...

Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
	__construct (Container $dic)
	@inheritDoc More...

	getContentModification (CalledContexts $screen_context_stack)
	@inheritDoc More...

	getLogoModification (CalledContexts $screen_context_stack)
	@inheritDoc More...

	getResponsiveLogoModification (CalledContexts $screen_context_stack)

	getMainBarModification (CalledContexts $screen_context_stack)
	@inheritDoc More...

	getMetaBarModification (CalledContexts $screen_context_stack)
	@inheritDoc More...

	getBreadCrumbsModification (CalledContexts $screen_context_stack)
	@inheritDoc More...

	getFooterModification (CalledContexts $screen_context_stack)
	@inheritDoc More...

	getPageBuilderDecorator (CalledContexts $screen_context_stack)
	@inheritDoc More...

	getTitleModification (CalledContexts $screen_context_stack)
	@inheritDoc More...

	getShortTitleModification (CalledContexts $screen_context_stack)
	@inheritDoc More...

	getViewTitleModification (CalledContexts $screen_context_stack)
	@inheritDoc More...

Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (Container $dic)
	@inheritDoc More...

	getFullyQualifiedClassName ()
	@inheritDoc More...

	getProviderNameForPresentation ()

	getFullyQualifiedClassName ()

	getProviderNameForPresentation ()

	getContentModification (CalledContexts $screen_context_stack)

	getLogoModification (CalledContexts $screen_context_stack)

	getResponsiveLogoModification (CalledContexts $screen_context_stack)

	getMainBarModification (CalledContexts $screen_context_stack)

	getMetaBarModification (CalledContexts $screen_context_stack)

	getBreadCrumbsModification (CalledContexts $screen_context_stack)

	getFooterModification (CalledContexts $screen_context_stack)

	getPageBuilderDecorator (CalledContexts $screen_context_stack)

	getTitleModification (CalledContexts $screen_context_stack)

	getShortTitleModification (CalledContexts $screen_context_stack)

	getViewTitleModification (CalledContexts $screen_context_stack)

	isInterestedInContexts ()

Data Fields
const	LM_HTML_EXPORT_RENDERING = 'lm_html_export_rendering'

Additional Inherited Members
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
	$context_collection

	$factory

Protected Attributes inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	$dic

Detailed Description

LM HTML export view layout provider, hides main and meta bar.

Author: killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 19 of file class.ilLMHtmlExportViewLayoutProvider.php.

Member Function Documentation

◆ getBreadCrumbsModification()

ilLMHtmlExportViewLayoutProvider::getBreadCrumbsModification ( CalledContexts $called_contexts )

No breadcrumbs in HTML exports.

Reimplemented from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider.

Definition at line 102 of file class.ilLMHtmlExportViewLayoutProvider.php.

                                                                                : ?BreadCrumbsModification
    {
        $additional_data = $called_contexts->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;
        }
    }

References ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), and ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen().

Here is the call graph for this function:

◆ getMainBarModification()

ilLMHtmlExportViewLayoutProvider::getMainBarModification ( CalledContexts $called_contexts )

No main bar in HTML exports.

Reimplemented from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider.

Definition at line 53 of file class.ilLMHtmlExportViewLayoutProvider.php.

                                                                            : ?MainBarModification
    {
        $additional_data = $called_contexts->current()->getAdditionalData();
        if ($additional_data->is(self::LM_HTML_EXPORT_RENDERING, true)) {
            return $this->globalScreen()
                ->layout()
                ->factory()
                ->mainbar()
                ->withModification(function (MainBar $current = null) : ?MainBar {
                    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("outlined/icon_tool.svg"), $lng->txt("more"));
                    $offline_main_bar = $offline_main_bar->withMoreButton(
                        $f->button()->bulky($grid_icon, $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;
        }
    }

References $DIC, Vendor\Package\$f, $lng, ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), ilUtil\getImagePath(), and ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen().

Here is the call graph for this function:

◆ getMetaBarModification()

ilLMHtmlExportViewLayoutProvider::getMetaBarModification ( CalledContexts $called_contexts )

No meta bar in HTML exports.

Reimplemented from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider.

Definition at line 35 of file class.ilLMHtmlExportViewLayoutProvider.php.

                                                                            : ?MetaBarModification
    {
        $additional_data = $called_contexts->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;
    }

References ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), and ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen().

Here is the call graph for this function:

◆ isInterestedInContexts()

ilLMHtmlExportViewLayoutProvider::isInterestedInContexts ( )

@inheritDoc

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 27 of file class.ilLMHtmlExportViewLayoutProvider.php.

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

References ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\repository().

Here is the call graph for this function:

Field Documentation

◆ LM_HTML_EXPORT_RENDERING

const ilLMHtmlExportViewLayoutProvider::LM_HTML_EXPORT_RENDERING = 'lm_html_export_rendering'

Definition at line 21 of file class.ilLMHtmlExportViewLayoutProvider.php.

Referenced by ILIAS\LearningModule\Export\LMHtmlExport\initGlobalScreen().

The documentation for this class was generated from the following file:

Modules/LearningModule/Export/class.ilLMHtmlExportViewLayoutProvider.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getBreadCrumbsModification()

◆ getMainBarModification()

◆ getMetaBarModification()

◆ isInterestedInContexts()

Field Documentation

◆ LM_HTML_EXPORT_RENDERING