Namespaces
	Footer

	Layout
	PhpIncompatibleReturnTypeInspection

	MainMenu

	MetaBar

	Notification
	PhpIncompatibleReturnTypeInspection

	Toast

	Tool
	PhpIncompatibleReturnTypeInspection

Data Structures
interface	isDecorateable

interface	RenderFactory

Functions
	withTopics (Topic ... $topics)

	getTopics ()

	addComponentDecorator (Closure $component_decorator)

	getComponentDecorator ()

	addSymbolDecorator (Closure $symbol_decorator)

	getSymbolDecorator ()

	withVisibilityCallable (callable $is_visible)

	isVisible ()

	withAvailableCallable (callable $is_available)

	isAvailable ()

	isAlwaysAvailable ()

Variables
trait	ComponentDecoratorTrait

Closure	$component_decorator = null

Closure	$triggerer_decorator = null

Closure	$symbol_decorator = null

array	$topics = []

trait	VisibilityAvailabilityTrait

Closure	$visiblility_callable = null

bool	$is_visible_static = null

Function Documentation

◆ addComponentDecorator()

ILIAS\GlobalScreen\Scope\addComponentDecorator ( Closure $component_decorator )

Definition at line 53 of file ComponentDecoratorTrait.php.

References $c, and ILIAS\GlobalScreen\Scope\$component_decorator.

                                                                        : self
     {
         $this->checkClosureForSignature($component_decorator, Component::class);
 
         if ($this->component_decorator instanceof Closure) {
             $existing = $this->component_decorator;
             $this->component_decorator = static function (Component $c) use (
                 $component_decorator,
                 $existing
             ): Component {
                 $component = $existing($c);
 
                 return $component_decorator($component);
             };
         } else {
             $this->component_decorator = $component_decorator;
         }
 
         return $this;
     }

◆ addSymbolDecorator()

ILIAS\GlobalScreen\Scope\addSymbolDecorator ( Closure $symbol_decorator )

Definition at line 79 of file ComponentDecoratorTrait.php.

References $c, and ILIAS\GlobalScreen\Scope\$symbol_decorator.

                                                                  : isDecorateable
     {
         $this->checkClosureForSignature($symbol_decorator, Symbol::class);
 
         if ($this->symbol_decorator instanceof Closure) {
             $existing = $this->symbol_decorator;
             $this->symbol_decorator = static function (Symbol $c) use ($symbol_decorator, $existing): Symbol {
                 $component = $existing($c);
 
                 return $symbol_decorator($component);
             };
         } else {
             $this->symbol_decorator = $symbol_decorator;
         }
 
         return $this;
     }

◆ getComponentDecorator()

ILIAS\GlobalScreen\Scope\getComponentDecorator ( )

Definition at line 74 of file ComponentDecoratorTrait.php.

References ILIAS\GlobalScreen\Scope\$component_decorator.

                                            : ?Closure
     {
         return $this->component_decorator;
     }

◆ getSymbolDecorator()

ILIAS\GlobalScreen\Scope\getSymbolDecorator ( )

Definition at line 97 of file ComponentDecoratorTrait.php.

References ILIAS\GlobalScreen\Scope\$symbol_decorator.

                                         : ?Closure
     {
         return $this->symbol_decorator;
     }

◆ getTopics()

ILIAS\GlobalScreen\Scope\getTopics ( )

Definition at line 48 of file ComponentDecoratorTrait.php.

References ILIAS\GlobalScreen\Scope\$topics.

                                : array
     {
         return $this->topics;
     }

◆ isAlwaysAvailable()

ILIAS\GlobalScreen\Scope\isAlwaysAvailable ( )

Definition at line 85 of file VisibilityAvailabilityTrait.php.

Referenced by ILIAS\GlobalScreen\Scope\isAvailable().

                                        : bool
     {
         return false;
     }

Here is the caller graph for this function:

◆ isAvailable()

ILIAS\GlobalScreen\Scope\isAvailable ( )

Definition at line 71 of file VisibilityAvailabilityTrait.php.

References ILIAS\GlobalScreen\Scope\isAlwaysAvailable().

Referenced by ILIAS\GlobalScreen\Scope\isVisible().

                                  : bool
     {
         if ($this->isAlwaysAvailable() === true) {
             return true;
         }
         if (is_callable($this->available_callable)) {
             $callable = $this->available_callable;
 
             return (bool) $callable();
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isVisible()

ILIAS\GlobalScreen\Scope\isVisible ( )

Definition at line 44 of file VisibilityAvailabilityTrait.php.

References ILIAS\GlobalScreen\Scope\$is_visible_static, ILIAS\GlobalScreen\Scope\$visiblility_callable, and ILIAS\GlobalScreen\Scope\isAvailable().

Referenced by ILIAS\GlobalScreen\Scope\MainMenu\Factory\Item\LinkList\isVisible(), and ilObject2GUI\isVisible().

                                : bool
     {
         if (isset($this->is_visible_static)) {
             return $this->is_visible_static;
         }
         if (!$this->isAvailable()) {
             return $this->is_visible_static = false;
         }
         if (is_callable($this->visiblility_callable)) {
             $callable = $this->visiblility_callable;
 
             $value = (bool) $callable();
 
             return $this->is_visible_static = $value;
         }
 
         return $this->is_visible_static = true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withAvailableCallable()

ILIAS\GlobalScreen\Scope\withAvailableCallable ( callable $is_available )

Definition at line 63 of file VisibilityAvailabilityTrait.php.

Referenced by ILIAS\Notifications\Provider\NotificationCenterProvider\getMetaBarItems(), ILIAS\Portfolio\Provider\PortfolioMainBarProvider\getStaticSubItems(), ILIAS\Administration\AdministrationMainBarProvider\getStaticSubItems(), ILIAS\GlobalScreen\Provider\Provider\CalendarMainBarProvider\getStaticSubItems(), ILIAS\PersonalWorkspace\Provider\WorkspaceMainBarProvider\getStaticSubItems(), ILIAS\Tagging\Provider\TaggingMainBarProvider\getStaticSubItems(), ILIAS\LearningProgress\LPMainBarProvider\getStaticSubItems(), ILIAS\EmployeeTalk\Provider\MyStaffListEntryProvider\getStaticSubItems(), ILIAS\OnScreenChat\Provider\OnScreenChatProvider\getStaticSubItems(), and ILIAS\MainMenu\Provider\StandardTopItemsProvider\getStaticTopItems().

                                                                  : self
     {
         $clone = clone($this);
         $clone->available_callable = $is_available;
 
         return $clone;
     }

Here is the caller graph for this function:

◆ withTopics()

ILIAS\GlobalScreen\Scope\withTopics ( Topic ... $topics )

Definition at line 41 of file ComponentDecoratorTrait.php.

References ILIAS\GlobalScreen\Scope\$topics.

                                                 : self
     {
         $this->topics = $topics;
 
         return $this;
     }

◆ withVisibilityCallable()

ILIAS\GlobalScreen\Scope\withVisibilityCallable ( callable $is_visible )

Definition at line 35 of file VisibilityAvailabilityTrait.php.

References null.

                                                                 : self
     {
         $clone = clone($this);
         $clone->visiblility_callable = $is_visible;
         $clone->is_visible_static = null;
 
         return $clone;
     }