Namespaces
namespace	Breadcrumbs

namespace	Button
	This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

namespace	Card

namespace	Chart

namespace	Counter

namespace	Deck

namespace	Divider

namespace	Dropdown

namespace	Dropzone

namespace	Entity

namespace	Image

namespace	Input
	This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

namespace	Item

namespace	Launcher

namespace	Layout

namespace	Legacy

namespace	Link

namespace	Listing

namespace	MainControls

namespace	Menu

namespace	MessageBox

namespace	Modal

namespace	Navigation

namespace	Panel

namespace	Player

namespace	Popover

namespace	Progress

namespace	Prompt

namespace	Symbol

namespace	Table

namespace	Toast

namespace	Tree

namespace	ViewControl

Data Structures
class	ReplaceContentSignal
	Class ReplaceContentSignal. More...

class	ReplaceSignal
	Replace Signal. More...

class	Signal

class	SignalGenerator

interface	SignalGeneratorInterface

class	TriggeredSignal

Functions
	withContentLanguage (LanguageTag $content_language)

	getContentLanguage ()

	withHelpTopics (Topic ... $topics)

	withAdditionalHelpTopics (Topic ... $topics)

	getHelpTopics ()

	withOnLoadCode (Closure $binder)

	withAdditionalOnLoadCode (Closure $binder)

	getOnLoadCode ()

	checkBinder (Closure $binder)

	appendTriggeredSignal (C\Signal $signal, string $event)
	Append a triggered signal to other signals of the same event. More...

	withTriggeredSignal (C\Signal $signal, string $event)
	Add a triggered signal, replacing any other signals registered on the same event. More...

	setTriggeredSignal (C\Signal $signal, string $event)
	Add a triggered signal, replacing any other signals registered on the same event. More...

	getTriggeredSignals ()

	getTriggeredSignalsFor (string $event)
	Get signals that are triggered for a certain event. More...

	withResetTriggeredSignals ()

	flattenArray (array $array)
	Flatten a multidimensional array to a single dimension. More...

Variables
trait	HasContentLanguage

trait	HasHelpTopics

trait	JavaScriptBindable
	Trait for components implementing JavaScriptBindable providing standard implementation. More...

trait	Triggerer

Function Documentation

◆ appendTriggeredSignal()

ILIAS\UI\Implementation\Component\appendTriggeredSignal	(	C\Signal	$signal,
		string	$event
	)

protected

Append a triggered signal to other signals of the same event.

Returns: static

Definition at line 47 of file Triggerer.php.

    {
        $clone = clone $this;
        if (!isset($clone->triggered_signals[$event])) {
            $clone->triggered_signals[$event] = array();
        }
        $clone->triggered_signals[$event][] = new TriggeredSignal($signal, $event);
        return $clone;
    }

Here is the caller graph for this function:

◆ checkBinder()

ILIAS\UI\Implementation\Component\checkBinder ( Closure $binder )

private

Exceptions

InvalidArgumentException if closure does not take one argument

Definition at line 71 of file JavaScriptBindable.php.

                                                 : void
    {
        $refl = new ReflectionFunction($binder);
        $args = array_map(fn ($arg) => $arg->name, $refl->getParameters());
        if (array("id") !== $args) {
            throw new InvalidArgumentException('Expected closure "$binder" to have exactly one argument "$id".');
        }
    }

Referenced by ILIAS\UI\Implementation\Component\withAdditionalOnLoadCode(), and ILIAS\UI\Implementation\Component\withOnLoadCode().

Here is the caller graph for this function:

◆ flattenArray()

ILIAS\UI\Implementation\Component\flattenArray ( array $array )

private

Flatten a multidimensional array to a single dimension.

Definition at line 115 of file Triggerer.php.

                                               : array
    {
        $flatten = array();
        array_walk_recursive($array, function ($a) use (&$flatten) {
            $flatten[] = $a;
        });
        return $flatten;
    }

References Vendor\Package\$a.

Referenced by ILIAS\UI\Implementation\Component\getTriggeredSignals().

Here is the caller graph for this function:

◆ getContentLanguage()

ILIAS\UI\Implementation\Component\getContentLanguage ( )

Definition at line 36 of file HasContentLanguage.php.

                                        : ?LanguageTag
    {
        return $this->content_language;
    }

◆ getHelpTopics()

ILIAS\UI\Implementation\Component\getHelpTopics ( )

See also: ILIAS\UI\Component\HasHelpTopicgetHelpTopics

Definition at line 55 of file HasHelpTopics.php.

                                   : array
    {
        return $this->help_topics;
    }

◆ getOnLoadCode()

ILIAS\UI\Implementation\Component\getOnLoadCode ( )

See also: \ILIAS\UI\Component\JavaScriptBindablegetOnLoadCode

Definition at line 63 of file JavaScriptBindable.php.

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

Referenced by ILIAS\Repository\Form\FormAdapterGUI\initJavascript(), ILIAS\Repository\Form\FormAdapterGUI\render(), and ILIAS\UI\Implementation\Component\withAdditionalOnLoadCode().

Here is the caller graph for this function:

◆ getTriggeredSignals()

ILIAS\UI\Implementation\Component\getTriggeredSignals ( )

Returns: TriggeredSignal[]

Definition at line 84 of file Triggerer.php.

                                         : array
    {
        return $this->flattenArray($this->triggered_signals);
    }

References ILIAS\UI\Implementation\Component\flattenArray().

Here is the call graph for this function:

◆ getTriggeredSignalsFor()

ILIAS\UI\Implementation\Component\getTriggeredSignalsFor ( string $event )

Get signals that are triggered for a certain event.

Returns: C\Signal[]

Definition at line 94 of file Triggerer.php.

                                                         : array
    {
        if (!isset($this->triggered_signals[$event])) {
            return [];
        }
        return array_map(
            fn ($ts) => $ts->getSignal(),
            $this->triggered_signals[$event]
        );
    }

Referenced by ILIAS\UI\Implementation\Component\Button\Button\getAction(), ILIAS\UI\Implementation\Component\Image\Image\getAction(), ILIAS\UI\Implementation\Component\Button\Toggle\getActionOff(), ILIAS\UI\Implementation\Component\Button\Toggle\getActionOn(), and ILIAS\UI\Implementation\Component\Card\Card\getTitleAction().

Here is the caller graph for this function:

◆ setTriggeredSignal()

ILIAS\UI\Implementation\Component\setTriggeredSignal	(	C\Signal	$signal,
		string	$event
	)

protected

Add a triggered signal, replacing any other signals registered on the same event.

ATTENTION: This mutates the original object and should only be used when there is no other possibility.

Definition at line 75 of file Triggerer.php.

                                                                          : void
    {
        $this->triggered_signals[$event] = array();
        $this->triggered_signals[$event][] = new TriggeredSignal($signal, $event);
    }

Referenced by ILIAS\UI\Implementation\Component\Button\Button\__construct(), ILIAS\UI\Implementation\Component\Button\Toggle\__construct(), and Triggerermock\_setTriggeredSignal().

Here is the caller graph for this function:

◆ withAdditionalHelpTopics()

ILIAS\UI\Implementation\Component\withAdditionalHelpTopics ( Topic ... $topics )

See also: ILIAS\UI\Component\HasHelpTopicwithAdditionalHelpTopics

Definition at line 44 of file HasHelpTopics.php.

                                                              : static
    {
        $clone = clone $this;
        $clone->help_topics = array_unique(array_merge($this->help_topics, $topics), SORT_REGULAR);
        sort($clone->help_topics);
        return $clone;
    }

References ILIAS\GlobalScreen\Scope\$topics, and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Here is the call graph for this function:

◆ withAdditionalOnLoadCode()

ILIAS\UI\Implementation\Component\withAdditionalOnLoadCode ( Closure $binder )

See also: \ILIAS\UI\Component\JavaScriptBindablewithAdditionalOnLoadCode

Definition at line 49 of file JavaScriptBindable.php.

    {
        $current_binder = $this->getOnLoadCode();
        if ($current_binder === null) {
            return $this->withOnLoadCode($binder);
        }
 
        $this->checkBinder($binder);
        return $this->withOnLoadCode(fn ($id) => $current_binder($id) . "\n" . $binder($id));
    }

References $id, ILIAS\UI\Implementation\Component\checkBinder(), ILIAS\UI\Implementation\Component\getOnLoadCode(), and ILIAS\UI\Implementation\Component\withOnLoadCode().

Referenced by ILIAS\ILIASObject\Properties\MultiPropertiesManipulator\getAvailabilityPeriodButton(), and JavaScriptBindableTest\testWithAdditionalOnLoadCode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withContentLanguage()

ILIAS\UI\Implementation\Component\withContentLanguage ( LanguageTag $content_language )

Definition at line 29 of file HasContentLanguage.php.

                                                                      : self
    {
        $clone = clone $this;
        $clone->content_language = $content_language;
        return $clone;
    }

◆ withHelpTopics()

ILIAS\UI\Implementation\Component\withHelpTopics ( Topic ... $topics )

See also: ILIAS\UI\Component\HasHelpTopicwithHelpTopics

Definition at line 33 of file HasHelpTopics.php.

                                                    : static
    {
        $clone = clone $this;
        $clone->help_topics = array_unique($topics, SORT_REGULAR);
        sort($clone->help_topics);
        return $clone;
    }

References ILIAS\GlobalScreen\Scope\$topics, and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Here is the call graph for this function:

◆ withOnLoadCode()

ILIAS\UI\Implementation\Component\withOnLoadCode ( Closure $binder )

See also: \ILIAS\UI\Component\JavaScriptBindablewithOnLoadCode

Definition at line 38 of file JavaScriptBindable.php.

    {
        $this->checkBinder($binder);
        $clone = clone $this;
        $clone->on_load_code_binder = $binder;
        return $clone;
    }

References ILIAS\UI\Implementation\Component\checkBinder().

Referenced by ilHelpGUI\showPage(), and ILIAS\UI\Implementation\Component\withAdditionalOnLoadCode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withResetTriggeredSignals()

ILIAS\UI\Implementation\Component\withResetTriggeredSignals ( )

Definition at line 105 of file Triggerer.php.

                                               : C\Triggerer
    {
        $clone = clone $this;
        $clone->triggered_signals = array();
        return $clone;
    }

◆ withTriggeredSignal()

ILIAS\UI\Implementation\Component\withTriggeredSignal	(	C\Signal	$signal,
		string	$event
	)

protected

Add a triggered signal, replacing any other signals registered on the same event.

Returns: static

Definition at line 62 of file Triggerer.php.

    {
        $clone = clone $this;
        $clone->setTriggeredSignal($signal, $event);
        return $clone;
    }

Here is the caller graph for this function:

Variable Documentation

◆ HasContentLanguage

trait ILIAS::UI::Implementation::Component\HasContentLanguage

Initial value:

{

protected ?LanguageTag $content_language = null

Definition at line 25 of file HasContentLanguage.php.

◆ HasHelpTopics

trait ILIAS::UI::Implementation::Component\HasHelpTopics

Initial value:

{
    
    protected array $help_topics = []

Definition at line 25 of file HasHelpTopics.php.

Referenced by HasHelpTopicsTest\setUp().

◆ JavaScriptBindable

trait ILIAS::UI::Implementation::Component\JavaScriptBindable

Initial value:

{

private ?Closure $on_load_code_binder = null

Trait for components implementing JavaScriptBindable providing standard implementation.

Examples: /usr/local/src/ilias/trunk/components/ILIAS/UI/src/Component/JavaScriptBindable.php.

Definition at line 31 of file JavaScriptBindable.php.

◆ Triggerer

trait ILIAS::UI::Implementation::Component\Triggerer

Initial value:

{
    
    private array $triggered_signals = array()

Definition at line 35 of file Triggerer.php.

Namespaces

Data Structures

Functions

Variables

Function Documentation

◆ appendTriggeredSignal()

◆ checkBinder()

◆ flattenArray()

◆ getContentLanguage()

◆ getHelpTopics()

◆ getOnLoadCode()

◆ getTriggeredSignals()

◆ getTriggeredSignalsFor()

◆ setTriggeredSignal()

◆ withAdditionalHelpTopics()

◆ withAdditionalOnLoadCode()

◆ withContentLanguage()

◆ withHelpTopics()

◆ withOnLoadCode()

◆ withResetTriggeredSignals()

◆ withTriggeredSignal()

Variable Documentation

◆ HasContentLanguage

◆ HasHelpTopics

◆ JavaScriptBindable

◆ Triggerer