ilHTMLExportViewLayoutProvider Class Reference

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

Inheritance diagram for ilHTMLExportViewLayoutProvider:

Collaboration diagram for ilHTMLExportViewLayoutProvider:

Public Member Functions
	isInterestedInContexts ()
	@inheritDoc More...
	getMetaBarModification (CalledContexts $called_contexts)
	@inheritDoc No meta bar in HTML exports More...
	getMainBarModification (CalledContexts $called_contexts)
	@inheritDoc No main bar in HTML exports More...
	getBreadCrumbsModification (CalledContexts $called_contexts)
	@inheritDoc 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 (protected Container $dic)
	getFullyQualifiedClassName ()
	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	HTML_EXPORT_RENDERING = '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
ContextCollection	$context_collection
DataFactory	$data
ModificationFactory	$factory

Detailed Description

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 36 of file class.ilHTMLExportViewLayoutProvider.php.

Member Function Documentation

getBreadCrumbsModification()

ilHTMLExportViewLayoutProvider::getBreadCrumbsModification

(

CalledContexts

$called_contexts

)

@inheritDoc No breadcrumbs in HTML exports

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

Definition at line 91 of file class.ilHTMLExportViewLayoutProvider.php.

                                                                               : ?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;
        }
    }

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

Here is the call graph for this function:

getMainBarModification()

ilHTMLExportViewLayoutProvider::getMainBarModification

(

CalledContexts

$called_contexts

)

@inheritDoc No main bar in HTML exports

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

Definition at line 71 of file class.ilHTMLExportViewLayoutProvider.php.

                                                                           : ?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;
        }
    }

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

Here is the call graph for this function:

getMetaBarModification()

ilHTMLExportViewLayoutProvider::getMetaBarModification

(

CalledContexts

$called_contexts

)

@inheritDoc No meta bar in HTML exports

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

Definition at line 52 of file class.ilHTMLExportViewLayoutProvider.php.

                                                                           : ?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;
    }

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

Here is the call graph for this function:

isInterestedInContexts()

ilHTMLExportViewLayoutProvider::isInterestedInContexts

(

)

@inheritDoc

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 43 of file class.ilHTMLExportViewLayoutProvider.php.

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

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

Here is the call graph for this function:

Field Documentation

HTML_EXPORT_RENDERING

const ilHTMLExportViewLayoutProvider::HTML_EXPORT_RENDERING = 'html_export_rendering'

Definition at line 38 of file class.ilHTMLExportViewLayoutProvider.php.

Referenced by ILIAS\Glossary\Export\GlossaryHtmlExport\__construct(), ILIAS\Notes\Export\NotesHtmlExport\__construct(), ILIAS\Wiki\Export\WikiHtmlExport\buildExportFile(), and ILIAS\components\Export\HTML\Util\initGlobalScreen().

---

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

• components/ILIAS/Export/HTML/GlobalScreen/classes/class.ilHTMLExportViewLayoutProvider.php