ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts Class Reference

Inheritance diagram for ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts:

Collaboration diagram for ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts:

Public Member Functions
	current ()
	push (ScreenContext $context)
	external ()
	clear ()
Public Member Functions inherited from ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection
	__construct (protected ContextRepository $repo)
	push (ScreenContext $context)
	getLast ()
	getStack ()
	getStackAsArray ()
	hasMatch (ContextCollection $other_collection)
	main ()
	desktop ()
	repository ()
	administration ()
	external ()
	lti ()

Protected Member Functions
	claim (ScreenContext $context, bool $silent=false)

Private Member Functions
	checkCallLocation (ScreenContext $context, bool $silent=false)

Private Attributes
array	$call_locations = []

Additional Inherited Members
Data Fields inherited from ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection
function return	$this: self { $this->push($this->repo->internal())
Protected Attributes inherited from ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection
array	$stack = []

Detailed Description

Definition at line 29 of file CalledContexts.php.

Member Function Documentation

checkCallLocation()

ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts::checkCallLocation ( ScreenContext  $context, bool  $silent = false  )

private

Definition at line 71 of file CalledContexts.php.

                                                                                    : void
    {
        $called_classes = array_filter(
            debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS),
            function ($item): bool {
                if (!isset($item['class'])) {
                    return false;
                }
 
                return (!in_array($item['class'], [CalledContexts::class, ContextCollection::class]));
            }
        );
        array_walk(
            $called_classes,
            function (& $item): void {
                $item = ($item['class'] ?? '') . ":" . ($item['line'] ?? '');
            }
        );
 
        $call_location = reset($called_classes);
 
        if (!$silent && isset($this->call_locations[$context->getUniqueContextIdentifier()])) {
            $first_location = $this->call_locations[$context->getUniqueContextIdentifier()];
            throw new LogicException("context '{$context->getUniqueContextIdentifier()}' already claimed in $first_location, second try in $call_location");
        }
        $this->call_locations[$context->getUniqueContextIdentifier()] = $call_location;
    }

References $context.

Referenced by ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\claim().

Here is the caller graph for this function:

claim()

ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts::claim ( ScreenContext  $context, bool  $silent = false  )

protected

Definition at line 61 of file CalledContexts.php.

                                                                          : void
    {
        $this->checkCallLocation($context, $silent);
 
        if (!$silent && in_array($context, $this->stack)) {
            throw new LogicException("A context can only be claimed once");
        }
        parent::push($context);
    }

References $context, and ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\checkCallLocation().

Referenced by ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\external(), and ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\push().

Here is the call graph for this function:

Here is the caller graph for this function:

clear()

ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts::clear

(

)

Definition at line 55 of file CalledContexts.php.

                           : void
    {
        $this->call_locations = [];
        $this->stack = [];
    }

current()

ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts::current

(

)

Definition at line 33 of file CalledContexts.php.

                             : ScreenContext
    {
        return $this->getLast();
    }

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

Referenced by ilHTMLExportViewLayoutProvider\getBreadCrumbsModification(), ilLMHtmlExportViewLayoutProvider\getBreadCrumbsModification(), ilMDKeywordExposer\getContentModification(), ilHTMLExportViewLayoutProvider\getMainBarModification(), ilTestPlayerLayoutProvider\getMainBarModification(), DashboardLayoutProvider\getMainBarModification(), ilLMHtmlExportViewLayoutProvider\getMainBarModification(), ilHTMLExportViewLayoutProvider\getMetaBarModification(), ilLMHtmlExportViewLayoutProvider\getMetaBarModification(), ILIAS\WOPI\Embed\EmbeddedApplicationGSProvider\getMetaBarModification(), ilTestPlayerLayoutProvider\getShortTitleModification(), ilTestPlayerLayoutProvider\getTitleModification(), ilAdminGSToolProvider\getToolsForContextStack(), ilCOPageEditGSToolProvider\getToolsForContextStack(), ilLMEditGSToolProvider\getToolsForContextStack(), ilMediaPoolGSToolProvider\getToolsForContextStack(), ILIAS\OrgUnit\Provider\OrgUnitToolProvider\getToolsForContextStack(), ilWorkspaceGSToolProvider\getToolsForContextStack(), ilSkillGSToolProvider\getToolsForContextStack(), ilTaxonomyGSToolProvider\getToolsForContextStack(), ilTestPlayerToolProvider\getToolsForContextStack(), ilTestPlayerLayoutProvider\getViewTitleModification(), ILIAS\Init\StartupSequence\StartUpSequenceLayoutProvider\isForcedStartupStep(), ilTestPlayerLayoutProvider\isKioskModeEnabled(), ilLSViewLayoutProvider\isKioskModeEnabled(), ILIAS\LTI\Screen\LtiViewLayoutProvider\isLTIExitMode(), and ILIAS\Test\Presentation\PrintLayoutProvider\isTestContextPrint().

Here is the call graph for this function:

Here is the caller graph for this function:

external()

ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts::external

(

)

Reimplemented from ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection.

Definition at line 48 of file CalledContexts.php.

                              : ContextCollection
    {
        $this->claim($this->repo->external(), true);
 
        return $this;
    }

References ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\$this, and ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\claim().

Here is the call graph for this function:

push()

ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts::push

(

ScreenContext

$context

)

Reimplemented from ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection.

Definition at line 39 of file CalledContexts.php.

                                                : void
    {
        $this->claim(
            $context,
            $context->getUniqueContextIdentifier() === 'external'
        ); // external can be claimed multiple times
    }

References $context, and ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\claim().

Here is the call graph for this function:

Field Documentation

$call_locations

array ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts::$call_locations = []

private

Definition at line 31 of file CalledContexts.php.

---

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

• components/ILIAS/GlobalScreen/src/ScreenContext/Stack/CalledContexts.php