ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection Class Reference

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

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

Public Member Functions
	__construct (protected ContextRepository $repo)
	push (ScreenContext $context)
	getLast ()
	getStack ()
	getStackAsArray ()
	hasMatch (ContextCollection $other_collection)
	main ()
	desktop ()
	repository ()
	administration ()
	external ()
	lti ()

Data Fields
function return	$this: self { $this->push($this->repo->internal())

Protected Attributes
array	$stack = []

Detailed Description

Definition at line 30 of file ContextCollection.php.

Constructor & Destructor Documentation

__construct()

ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection::__construct

(

protected ContextRepository

$repo

)

Definition at line 37 of file ContextCollection.php.

    {
    }

Member Function Documentation

administration()

ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection::administration

(

)

Definition at line 114 of file ContextCollection.php.

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

                                    : self
    {
        $this->push($this->repo->administration());

        return $this;
    }

Here is the call graph for this function:

desktop()

ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection::desktop

(

)

Definition at line 100 of file ContextCollection.php.

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

Referenced by DashboardLayoutProvider\isInterestedInContexts().

                             : self
    {
        $this->push($this->repo->desktop());

        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

external()

ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection::external

(

)

Definition at line 128 of file ContextCollection.php.

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

Referenced by ILIAS\Init\Provider\StartUpModificationProvider\isInterestedInContexts(), and ILIAS\Repository\Provider\RepositoryOpenGraphExposer\isInterestedInContexts().

                              : self
    {
        $this->push($this->repo->external());

        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLast()

ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection::getLast

(

)

Definition at line 56 of file ContextCollection.php.

References null.

Referenced by ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), ILIAS\Mail\Provider\MailGlobalScreenToolProvider\getToolsForContextStack(), and ILIAS\MetaData\Editor\Tree\MDEditorToolProvider\getToolsForContextStack().

                             : ?ScreenContext
    {
        $last = end($this->stack);
        if ($last instanceof ScreenContext) {
            return $last;
        }
        return null;
    }

Here is the caller graph for this function:

getStack()

ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection::getStack

(

)

Returns

ScreenContext[]

Definition at line 68 of file ContextCollection.php.

References ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\$stack.

Referenced by ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\hasMatch().

                              : array
    {
        return $this->stack;
    }

Here is the caller graph for this function:

getStackAsArray()

ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection::getStackAsArray

(

)

Definition at line 73 of file ContextCollection.php.

                                     : array
    {
        $return = [];
        foreach ($this->stack as $item) {
            $return[] = $item->getUniqueContextIdentifier();
        }

        return $return;
    }

hasMatch()

ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection::hasMatch

(

ContextCollection

$other_collection

)

Definition at line 83 of file ContextCollection.php.

References $c, ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\getStack(), and ILIAS\GlobalScreen\ScreenContext\ScreenContext\getUniqueContextIdentifier().

Referenced by ILIAS\Repository\Provider\RepositoryOpenGraphExposer\ensureRepoContext().

                                                                 : bool
    {
        $mapper = (static fn(ScreenContext $c): string => $c->getUniqueContextIdentifier());
        $mine = array_map($mapper, $this->getStack());
        $theirs = array_map($mapper, $other_collection->getStack());

        return (array_intersect($mine, $theirs) !== []);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lti()

ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection::lti

(

)

Definition at line 135 of file ContextCollection.php.

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

Referenced by ILIAS\LTI\Screen\LtiViewLayoutProvider\isInterestedInContexts().

                         : self
    {
        $this->push($this->repo->lti());
        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

main()

ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection::main

(

)

Definition at line 92 of file ContextCollection.php.

References $context, ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\$this, and ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\push().

Referenced by ilTestPlayerToolProvider\isInterestedInContexts(), ilMediaPoolGSToolProvider\isInterestedInContexts(), ilWorkspaceGSToolProvider\isInterestedInContexts(), ilAdminGSToolProvider\isInterestedInContexts(), ilCOPageEditGSToolProvider\isInterestedInContexts(), ILIAS\Mail\Provider\MailGlobalScreenToolProvider\isInterestedInContexts(), ilExerciseGSToolProvider\isInterestedInContexts(), ilHelpGSToolProvider\isInterestedInContexts(), ilTaxonomyGSToolProvider\isInterestedInContexts(), ilLMEditGSToolProvider\isInterestedInContexts(), ilLMGSToolProvider\isInterestedInContexts(), ILIAS\Test\Presentation\PrintLayoutProvider\isInterestedInContexts(), ilHelpViewLayoutProvider\isInterestedInContexts(), ILIAS\Init\StartupSequence\StartUpSequenceLayoutProvider\isInterestedInContexts(), ILIAS\OrgUnit\Provider\OrgUnitToolProvider\isInterestedInContexts(), ilSkillGSToolProvider\isInterestedInContexts(), ilHTMLExportViewLayoutProvider\isInterestedInContexts(), ILIAS\MetaData\Editor\Tree\MDEditorToolProvider\isInterestedInContexts(), ilLSViewLayoutProvider\isInterestedInContexts(), ilTestPlayerLayoutProvider\isInterestedInContexts(), and ILIAS\UICore\PageContentProvider\isInterestedInContexts().

                          : self
    {
        $context = $this->repo->main();
        $this->push($context);

        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

push()

ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection::push

(

ScreenContext

$context

)

Definition at line 41 of file ContextCollection.php.

References $context, $ref_id, ILIAS\GlobalScreen\ScreenContext\ScreenContext\withAdditionalData(), and ILIAS\GlobalScreen\ScreenContext\ScreenContext\withReferenceId().

Referenced by ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\administration(), ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\desktop(), ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\external(), ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\lti(), ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\main(), and ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\repository().

                                                : void
    {
        $current = end($this->stack);
        if ($current instanceof ScreenContext) {
            if ($current->hasReferenceId()) {
                $reference_id = $current->getReferenceId();
                $ref_id = $reference_id->toInt();
                $context = $context->withReferenceId($reference_id);
            }
            $context = $context->withAdditionalData($current->getAdditionalData());
        }

        $this->stack[] = $context;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

repository()

ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection::repository

(

)

Definition at line 107 of file ContextCollection.php.

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

Referenced by ILIAS\Repository\Provider\RepositoryOpenGraphExposer\ensureRepoContext(), ilLMHtmlExportViewLayoutProvider\isInterestedInContexts(), ilMDKeywordExposer\isInterestedInContexts(), ILIAS\Container\Screen\MemberViewLayoutProvider\isInterestedInContexts(), and ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider\isInterestedInContexts().

                                : self
    {
        $this->push($this->repo->repository());

        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$stack

array ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection::$stack = []

protected

Definition at line 35 of file ContextCollection.php.

Referenced by ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\getStack().

$this

function return ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection::$this

Definition at line 123 of file ContextCollection.php.

Referenced by ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\administration(), ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\desktop(), ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\external(), ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\external(), ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\lti(), ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\main(), and ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\repository().

---

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

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