ILIAS\GlobalScreen\Scope Namespace Reference

Namespaces
namespace	Layout
	@noinspection PhpIncompatibleReturnTypeInspection
namespace	Notification
	@noinspection PhpIncompatibleReturnTypeInspection
namespace	Toast
namespace	Tool
	@noinspection PhpIncompatibleReturnTypeInspection

Data Structures
interface	RenderFactory

Functions
	addComponentDecorator (Closure $component_decorator)
	getComponentDecorator ()
	checkClosure (Closure $c)
	addSymbolDecorator (Closure $symbol_decorator)
	getSymbolDecorator ()

Variables
trait	ComponentDecoratorTrait
trait	SymbolDecoratorTrait

Function Documentation

addComponentDecorator()

ILIAS\GlobalScreen\Scope\addComponentDecorator

(

Closure

$component_decorator

)

Parameters

Closure

$component_decorator

Returns

isGlobalScreenItem

Definition at line 44 of file ComponentDecoratorTrait.php.

                                                                       : isGlobalScreenItem
    {
        if (!$this->checkClosure($component_decorator)) {
            throw new LogicException('first argument and return value of closure must be type-hinted to \ILIAS\UI\Component\Component');
        }
        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;
    }

References $c, and ILIAS\GlobalScreen\Scope\checkClosure().

Here is the call graph for this function:

addSymbolDecorator()

ILIAS\GlobalScreen\Scope\addSymbolDecorator

(

Closure

$symbol_decorator

)

Parameters

Closure

$symbol_decorator

Returns

isGlobalScreenItem

Definition at line 45 of file SymbolDecoratorTrait.php.

                                                                 : isGlobalScreenItem
    {
        if (!$this->checkClosure($symbol_decorator)) {
            throw new LogicException('first argument and return type of closure must be type-hinted to \ILIAS\UI\Component\Symbol\Symbol');
        }
        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;
    }

References $c, and ILIAS\GlobalScreen\Scope\checkClosure().

Here is the call graph for this function:

checkClosure()

ILIAS::GlobalScreen::Scope::checkClosure ( Closure  $c )

private

Definition at line 71 of file ComponentDecoratorTrait.php.

                                             : bool
    {
        try {
            $r = new ReflectionFunction($c);
            if (count($r->getParameters()) !== 1) {
                return false;
            }
            $first_param_type = $r->getParameters()[0]->getType();
            if ($first_param_type instanceof ReflectionType && $first_param_type->getName() !== Component::class) {
                return false;
            }
            $return_type = $r->getReturnType();
            if ($return_type === null) {
                return false;
            }
            if ($return_type->getName() !== Component::class) {
                return false;
            }
 
            return true;
        } catch (Throwable $i) {
            return false;
        }
    }

References $c, and $i.

Referenced by ILIAS\GlobalScreen\Scope\addComponentDecorator(), and ILIAS\GlobalScreen\Scope\addSymbolDecorator().

Here is the caller graph for this function:

getComponentDecorator()

ILIAS\GlobalScreen\Scope\getComponentDecorator

(

)

Returns

Closure|null

Definition at line 66 of file ComponentDecoratorTrait.php.

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

getSymbolDecorator()

ILIAS\GlobalScreen\Scope\getSymbolDecorator

(

)

Returns

Closure|null

Definition at line 67 of file SymbolDecoratorTrait.php.

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

Variable Documentation

ComponentDecoratorTrait

trait ILIAS::GlobalScreen::Scope\ComponentDecoratorTrait

Initial value:

{
    private ?Closure $component_decorator = null

Definition at line 36 of file ComponentDecoratorTrait.php.

SymbolDecoratorTrait

trait ILIAS::GlobalScreen::Scope\SymbolDecoratorTrait

Initial value:

{
    private ?Closure $symbol_decorator = null

Definition at line 37 of file SymbolDecoratorTrait.php.