Namespaces
	Breadcrumbs

	Button

	Card

	Chart

	Counter

	Deck

	Divider

	Dropdown

	Dropzone

	Glyph

	Icon

	Image

	Input

	Item

	Legacy

	Link

	Listing

	MessageBox

	Modal

	Panel

	Popover

	Table

	ViewControl

Data Structures
class	ReplaceContentSignal
	Class ReplaceContentSignal. More...

class	ReplaceSignal
	Replace Signal. More...

class	Signal

class	SignalGenerator

interface	SignalGeneratorInterface

class	TriggeredSignal

Functions
	withLoadingAnimationOnClick (bool $loading_animation_on_click=true)

	hasLoadingAnimationOnClick ()

	getCanonicalName ()
	Default implementation uses the namespace of the component up to and excluding "Component", reverses the order and adds spaces. More...

	getCanonicalNameByFullyQualifiedName ()
	Does the calculation required for getCanonicalName. More...

	checkArg ($which, $check, $message)
	/** Throw an InvalidArgumentException containing the message if $check is false. More...

	checkIntArg ($which, $value)
	Throw an InvalidArgumentException if $value is no int. More...

	checkStringArg ($which, $value)
	Throw an InvalidArgumentException if $value is no string. More...

	checkStringOrSignalArg ($which, $value)
	Throw an InvalidArgumentException if $value is no string or Signal. More...

	checkFloatArg ($which, $value)
	Throw an InvalidArgumentException if $value is not a float. More...

	checkBoolArg ($which, $value)
	Throw an InvalidArgumentException if $value is not a bool. More...

	checkArgInstanceOf ($which, $value, $class)
	Throw an InvalidArgumentException if $value is not an instance of $class. More...

	checkArgIsElement ($which, $value, $array, $name)
	Throw an InvalidArgumentException if $value is not an element of array. More...

	checkArgList ($which, array &$values, \Closure $check, \Closure $message)
	Check every key and value of the list with a supplied closure. More...

	checkArgListElements ($which, array &$values, &$classes)
	Check every element of the list if it is an instance of one of the given classes. More...

	toArray ($value)
	Wrap the given value in an array if it is no array. More...

	wrongTypeMessage ($expected, $value)

	withOnLoadCode (\Closure $binder)

	withAdditionalOnLoadCode (\Closure $binder)

	getOnLoadCode ()

	checkBinder (\Closure $binder)

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

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

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

	getTriggeredSignals ()

	getTriggeredSignalsFor ($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	LoadingAnimationOnClick
	Implements LoadingAnimationOnClick interface. More...

trait	ComponentHelper
	Provides common functionality for component implementations. More...

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

trait	Triggerer

Function Documentation

◆ appendTriggeredSignal()

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

protected

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

Parameters

Component\Signal	$signal
string	$event

Returns: $this

Definition at line 31 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:

◆ checkArg()

ILIAS\UI\Implementation\Component\checkArg	(	$which,
		$check,
		$message
	)

protected

/** Throw an InvalidArgumentException containing the message if $check is false.

Parameters

string	$which
bool	$check
string	$message

Exceptions

Definition at line 61 of file ComponentHelper.php.

Referenced by ILIAS\UI\Implementation\Component\Listing\Workflow\Step\__construct(), ComponentMock\_checkArg(), ILIAS\UI\Implementation\Component\Table\PresentationRow\withAction(), ILIAS\UI\Implementation\Component\Input\Field\withGroupValues(), and ILIAS\UI\Implementation\Component\Input\Field\Input\withValue().

     {
         assert(is_string($which));
         assert(is_bool($check));
         assert(is_string($message));
         if (!$check) {
             throw new \InvalidArgumentException("Argument '$which': $message");
         }
     }

Here is the caller graph for this function:

◆ checkArgInstanceOf()

ILIAS\UI\Implementation\Component\checkArgInstanceOf	(	$which,
		$value,
		$class
	)

protected

Throw an InvalidArgumentException if $value is not an instance of $class.

Parameters

string	$which
mixed	$value
string	$class

Exceptions

Definition at line 149 of file ComponentHelper.php.

Referenced by ILIAS\UI\Implementation\Component\ViewControl\Section\__construct(), ILIAS\UI\Implementation\Component\Modal\LightboxImagePage\__construct(), ComponentMock\_checkArgInstanceOf(), ILIAS\UI\Implementation\Component\Breadcrumbs\Breadcrumbs\withAppendedItem(), ILIAS\UI\Implementation\Component\Button\Tag\withBackgroundColor(), ILIAS\UI\Implementation\Component\Dropzone\File\File\withFileSizeLimit(), and ILIAS\UI\Implementation\Component\Button\Tag\withForegroundColor().

     {
         $this->checkArg($which, $value instanceof $class, $this->wrongTypeMessage($class, $value));
     }

Here is the caller graph for this function:

◆ checkArgIsElement()

ILIAS\UI\Implementation\Component\checkArgIsElement	(	$which,
		$value,
		$array,
		$name
	)

protected

Throw an InvalidArgumentException if $value is not an element of array.

Parameters

string	$which
mixed	$value
array	$array
string	$name	used in the exception

Exceptions

Definition at line 164 of file ComponentHelper.php.

     {
         if (!is_object($value)) {
             $message = "expected $name, got '$value'";
         } else {
             $message = "expected $name, got object.";
         }
         $message =
         $this->checkArg($which, in_array($value, $array), $message);
     }

Here is the caller graph for this function:

◆ checkArgList()

ILIAS\UI\Implementation\Component\checkArgList	(		$which,
		array &	$values,
		\Closure	$check,
		\Closure	$message
	)

protected

Check every key and value of the list with a supplied closure.

Parameters

string	$which
	mixed[]	&$values
\Closure	$check	takes key and value, should return false if those don't fit
\Closure	$message	create an error message from key and value

Exceptions

Definition at line 185 of file ComponentHelper.php.

Referenced by ILIAS\UI\Implementation\Component\Listing\Descriptive\__construct(), ComponentMock\_checkArgList(), and ILIAS\UI\Implementation\Component\Listing\Descriptive\withItems().

     {
         $failed_k = null;
         $failed_v = null;
         foreach ($values as $key => $value) {
             $ok = $check($key, $value);
             if (!$ok) {
                 $failed_k = $key;
                 $failed_v = $value;
                 break;
             }
         }
 
         if ($failed_k !== null) {
             $m = $message($failed_k, $failed_v);
         } else {
             $m = "";
         }
 
         $this->checkArg($which, $failed_k === null, $m);
     }

Here is the caller graph for this function:

◆ checkArgListElements()

ILIAS\UI\Implementation\Component\checkArgListElements	(		$which,
		array &	$values,
		&	$classes
	)

protected

Check every element of the list if it is an instance of one of the given classes.

Throw an InvalidArgumentException if that is not the case.

Parameters

string	$which
	mixed[]	&$values
	string\|string[]	$classes name(s) of classes

Exceptions

Definition at line 217 of file ComponentHelper.php.

     {
         $classes = $this->toArray($classes);
         $this->checkArgList($which, $values, function ($_, $value) use (&$classes) {
             foreach ($classes as $cls) {
                 if ($cls === "string" && is_string($value)) {
                     return true;
                 }
                 if ($cls === "int" && is_int($value)) {
                     return true;
                 } elseif ($value instanceof $cls) {
                     return true;
                 }
             }
             return false;
         }, function ($_, $failed) use (&$classes) {
             return $this->wrongTypeMessage(implode(", ", $classes), $failed);
         });
     }

Here is the caller graph for this function:

◆ checkBinder()

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

private

Parameters

\Closure $binder

Exceptions

Definition at line 58 of file JavaScriptBindable.php.

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

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

Here is the caller graph for this function:

◆ checkBoolArg()

ILIAS\UI\Implementation\Component\checkBoolArg	(	$which,
		$value
	)

protected

Throw an InvalidArgumentException if $value is not a bool.

Parameters

string	$which
mixed	$value

Exceptions

Definition at line 135 of file ComponentHelper.php.

Referenced by ILIAS\UI\Implementation\Component\Icon\Custom\__construct(), ILIAS\UI\Implementation\Component\Button\Toggle\__construct(), ILIAS\UI\Implementation\Component\Icon\Standard\__construct(), ComponentMock\_checkBoolArg(), ILIAS\UI\Implementation\Component\Icon\Icon\withDisabled(), ILIAS\UI\Implementation\Component\Button\Bulky\withEngagedState(), ILIAS\UI\Implementation\Component\Input\Field\Input\withRequired(), ILIAS\UI\Implementation\Component\Input\Field\Password\withRevelation(), and ILIAS\UI\Implementation\Component\Input\Field\Password\withStandardConstraints().

     {
         $this->checkArg($which, is_bool($value), $this->wrongTypeMessage("bool", $value));
     }

Here is the caller graph for this function:

◆ checkFloatArg()

ILIAS\UI\Implementation\Component\checkFloatArg	(	$which,
		$value
	)

protected

Throw an InvalidArgumentException if $value is not a float.

Parameters

string	$which
mixed	$value

Exceptions

Definition at line 122 of file ComponentHelper.php.

Referenced by ComponentMock\_checkFloatArg().

     {
         $this->checkArg($which, is_float($value), $this->wrongTypeMessage("float", $value));
     }

Here is the caller graph for this function:

◆ checkIntArg()

ILIAS\UI\Implementation\Component\checkIntArg	(	$which,
		$value
	)

protected

Throw an InvalidArgumentException if $value is no int.

Parameters

string	$which
mixed	$value

Exceptions

Definition at line 79 of file ComponentHelper.php.

     {
         $this->checkArg($which, is_int($value), $this->wrongTypeMessage("integer", $value));
     }

Here is the caller graph for this function:

◆ checkStringArg()

ILIAS\UI\Implementation\Component\checkStringArg	(	$which,
		$value
	)

protected

Throw an InvalidArgumentException if $value is no string.

Parameters

string	$which
mixed	$value

Exceptions

Definition at line 92 of file ComponentHelper.php.

     {
         $this->checkArg($which, is_string($value), $this->wrongTypeMessage("string", $value));
     }

Here is the caller graph for this function:

◆ checkStringOrSignalArg()

ILIAS\UI\Implementation\Component\checkStringOrSignalArg	(	$which,
		$value
	)

protected

Throw an InvalidArgumentException if $value is no string or Signal.

Parameters

string	$which
mixed	$value

Exceptions

Definition at line 105 of file ComponentHelper.php.

Referenced by ILIAS\UI\Implementation\Component\Button\Toggle\__construct(), ILIAS\UI\Implementation\Component\Button\Button\__construct(), and ILIAS\UI\Implementation\Component\Image\Image\withAction().

     {
         $this->checkArg(
             $which,
             is_string($value) || $value instanceof Signal,
             $this->wrongTypeMessage("string or Signal", gettype($value))
         );
     }

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.

Parameters

array $array

Returns: array

Definition at line 114 of file Triggerer.php.

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

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

Here is the caller graph for this function:

◆ getCanonicalName()

ILIAS\UI\Implementation\Component\getCanonicalName ( )

Default implementation uses the namespace of the component up to and excluding "Component", reverses the order and adds spaces.

Also does caching.

Returns: string

Definition at line 25 of file ComponentHelper.php.

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

     {
         if ($this->canonical_name === null) {
             $this->canonical_name = $this->getCanonicalNameByFullyQualifiedName();
         }
         return $this->canonical_name;
     }

Here is the call graph for this function:

◆ getCanonicalNameByFullyQualifiedName()

ILIAS\UI\Implementation\Component\getCanonicalNameByFullyQualifiedName ( )

protected

Does the calculation required for getCanonicalName.

Returns: string

Definition at line 38 of file ComponentHelper.php.

References $name.

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

     {
         $cls = explode("\\", get_class($this));
         $name = [];
         $cur = array_pop($cls);
         while ($cur !== "Component" && count($cls) > 0) {
             $name[] = preg_replace("%([a-z])([A-Z])%", "$1 $2", $cur);
             $cur = array_pop($cls);
         }
         return implode(" ", $name);
     }

Here is the caller graph for this function:

◆ getOnLoadCode()

ILIAS\UI\Implementation\Component\getOnLoadCode ( )

See also: getOnLoadCode

Definition at line 48 of file JavaScriptBindable.php.

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

     {
         return $this->on_load_code_binder;
     }

Here is the caller graph for this function:

◆ getTriggeredSignals()

ILIAS\UI\Implementation\Component\getTriggeredSignals ( )

Returns: []

Definition at line 74 of file Triggerer.php.

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

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

Here is the call graph for this function:

◆ getTriggeredSignalsFor()

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

Get signals that are triggered for a certain event.

Parameters

string

Returns: []

Definition at line 85 of file Triggerer.php.

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

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

Here is the caller graph for this function:

◆ hasLoadingAnimationOnClick()

ILIAS\UI\Implementation\Component\hasLoadingAnimationOnClick ( )

Definition at line 32 of file LoadingAnimationOnClick.php.

                                                  : bool
     {
         return $this->loading_animation_on_click;
     }

◆ setTriggeredSignal()

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

protected

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

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

Parameters

Component\Signal	$signal
string	$event

Returns: void

Definition at line 65 of file Triggerer.php.

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

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

Here is the caller graph for this function:

◆ toArray()

ILIAS\UI\Implementation\Component\toArray ( $value )

protected

Wrap the given value in an array if it is no array.

Parameters

mixed $value

Returns: array

Definition at line 243 of file ComponentHelper.php.

     {
         if (is_array($value)) {
             return $value;
         }
         return array($value);
     }

Here is the caller graph for this function:

◆ withAdditionalOnLoadCode()

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

See also: withAdditionalOnLoadCode

Definition at line 32 of file JavaScriptBindable.php.

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

Referenced by ilNoteGUI\getCommentsWidget(), and JavaScriptBindableTest\test_withAdditionalOnLoadCode().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withLoadingAnimationOnClick()

ILIAS\UI\Implementation\Component\withLoadingAnimationOnClick ( bool $loading_animation_on_click = true )

Definition at line 22 of file LoadingAnimationOnClick.php.

Referenced by ilLearningHistoryGUI\renderButton(), and ilContainerRenderer\renderHelperGeneric().

     {
         $clone = clone $this;
         $clone->loading_animation_on_click = $loading_animation_on_click;
         return $clone;
     }

Here is the caller graph for this function:

◆ withOnLoadCode()

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

See also: withOnLoadCode

Definition at line 21 of file JavaScriptBindable.php.

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

Referenced by ilCalendarBlockGUI\addMiniMonth(), ilGroupAddToGroupActionGUI\confirmAddUser(), ilGroupAddToGroupActionGUI\confirmCreateGroupAndAddUser(), ilExerciseManagementGUI\getEvaluationModal(), ilOnScreenChatMenuGUI\getMainMenuHTML(), ilInternalLinkGUI\getUserSearchResult(), ilExerciseManagementGUI\listTextAssignmentObject(), ilGroupAddToGroupActionGUI\sendResponse(), ilGroupAddToGroupActionGUI\show(), and ILIAS\UI\Implementation\Component\withAdditionalOnLoadCode().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withResetTriggeredSignals()

ILIAS\UI\Implementation\Component\withResetTriggeredSignals ( )

Returns: $this

Definition at line 101 of file Triggerer.php.

     {
         $clone = clone $this;
         $clone->triggered_signals = array();
         return $clone;
     }

◆ withTriggeredSignal()

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

protected

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

Parameters

Component\Signal	$signal
string	$event

Returns: $this

Definition at line 48 of file Triggerer.php.

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

Here is the caller graph for this function:

◆ wrongTypeMessage()

ILIAS\UI\Implementation\Component\wrongTypeMessage	(	$expected,
		$value
	)

protected

Definition at line 251 of file ComponentHelper.php.

Referenced by ILIAS\UI\Implementation\Component\Listing\Workflow\Step\__construct(), and ILIAS\UI\Implementation\Component\Table\PresentationRow\withAction().

     {
         $type = gettype($value);
         if (!is_object($value) && !is_array($value)) {
             return "expected $expected, got $type '$value'";
         } else {
             if (is_object($value)) {
                 $type = get_class($value);
             }
             return "expected $expected, got $type";
         }
     }

Here is the caller graph for this function:

Variable Documentation

◆ ComponentHelper

trait ILIAS::UI::Implementation::Component\ComponentHelper

Initial value:

{
    
    private $canonical_name = null

Provides common functionality for component implementations.

Definition at line 13 of file ComponentHelper.php.

◆ JavaScriptBindable

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

Initial value:

{
    
    private $on_load_code_binder = null

Trait for components implementing JavaScriptBindable providing standard implementation.

Definition at line 12 of file JavaScriptBindable.php.

◆ LoadingAnimationOnClick

trait ILIAS::UI::Implementation::Component\LoadingAnimationOnClick

Initial value:

{
    
    protected $loading_animation_on_click = false

Implements LoadingAnimationOnClick interface.

Author: killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 12 of file LoadingAnimationOnClick.php.

◆ Triggerer

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

Initial value:

{
    
    private $triggered_signals = array()

Definition at line 17 of file Triggerer.php.

Namespaces

Data Structures

Functions

Variables

Function Documentation

◆ appendTriggeredSignal()

◆ checkArg()

◆ checkArgInstanceOf()

◆ checkArgIsElement()

◆ checkArgList()

◆ checkArgListElements()

◆ checkBinder()

◆ checkBoolArg()

◆ checkFloatArg()

◆ checkIntArg()

◆ checkStringArg()

◆ checkStringOrSignalArg()

◆ flattenArray()

◆ getCanonicalName()

◆ getCanonicalNameByFullyQualifiedName()

◆ getOnLoadCode()

◆ getTriggeredSignals()

◆ getTriggeredSignalsFor()

◆ hasLoadingAnimationOnClick()

◆ setTriggeredSignal()

◆ toArray()

◆ withAdditionalOnLoadCode()

◆ withLoadingAnimationOnClick()

◆ withOnLoadCode()

◆ withResetTriggeredSignals()

◆ withTriggeredSignal()

◆ wrongTypeMessage()

Variable Documentation

◆ ComponentHelper

◆ JavaScriptBindable

◆ LoadingAnimationOnClick

◆ Triggerer