Namespaces
	Breadcrumbs

	Button

	Card

	Chart

	Counter

	Deck

	Divider

	Dropdown

	Dropzone

	Glyph

	Icon

	Image

	Item

	Legacy

	Link

	Listing

	Modal

	Panel

	Popover

	ViewControl

Data Structures
class	Signal

class	SignalGenerator

interface	SignalGeneratorInterface

class	TriggeredSignal

interface	TriggeredSignalInterface

Functions
	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...

	checkFloatArg ($which, $value)
	Throw an InvalidArgumentException if $value is not a float. 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...

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

	getTriggeredSignals ()

	withResetTriggeredSignals ()

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

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

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

trait	Triggerer

Function Documentation

◆ addTriggeredSignal()

ILIAS\UI\Implementation\Component\addTriggeredSignal	(	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 46 of file Triggerer.php.

References array.

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

Here is the caller graph for this function:

◆ 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 29 of file Triggerer.php.

References array.

Referenced by ILIAS\UI\Implementation\Component\Dropdown\Dropdown\appendOnClick(), ILIAS\UI\Implementation\Component\Button\Button\appendOnClick(), ILIAS\UI\Implementation\Component\Glyph\Glyph\appendOnClick(), ILIAS\UI\Implementation\Component\Dropdown\Dropdown\appendOnHover(), ILIAS\UI\Implementation\Component\Button\Button\appendOnHover(), ILIAS\UI\Implementation\Component\Modal\Modal\appendOnLoad(), and ILIAS\UI\Implementation\Component\Dropzone\File\File\withAdditionalDrop().

     {
         $clone = clone $this;
         if (!is_array($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 59 of file ComponentHelper.php.

Referenced by ComponentMock\_checkArg().

     {
         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 117 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 132 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 153 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 185 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.

References array.

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:

◆ 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 103 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 77 of file ComponentHelper.php.

Referenced by ILIAS\UI\Implementation\Component\Counter\Counter\__construct(), ComponentMock\_checkIntArg(), and ILIAS\UI\Implementation\Component\Dropzone\File\File\withMaxFiles().

     {
         $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 90 of file ComponentHelper.php.

     {
         $this->checkArg($which, is_string($value), $this->wrongTypeMessage("string", $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 78 of file Triggerer.php.

References array.

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 23 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 36 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 57 of file Triggerer.php.

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

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

Here is the call 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 211 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 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:

◆ 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(), ilOnScreenChatMenuGUI\getMainMenuHTML(), ilInternalLinkGUI\getUserSearchResult(), 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 65 of file Triggerer.php.

References array.

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

◆ wrongTypeMessage()

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

protected

Definition at line 219 of file ComponentHelper.php.

     {
         $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";
         }
     }

Variable Documentation

◆ ComponentHelper

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

Initial value:

{
    
    private $canonical_name = null

Provides common functionality for component implementations.

Definition at line 11 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.

◆ Triggerer

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

Initial value:

{
    
    protected $triggered_signals = array()

Definition at line 15 of file Triggerer.php.

Namespaces

Data Structures

Functions

Variables

Function Documentation

◆ addTriggeredSignal()

◆ appendTriggeredSignal()

◆ checkArg()

◆ checkArgInstanceOf()

◆ checkArgIsElement()

◆ checkArgList()

◆ checkArgListElements()

◆ checkBinder()

◆ checkFloatArg()

◆ checkIntArg()

◆ checkStringArg()

◆ flattenArray()

◆ getCanonicalName()

◆ getCanonicalNameByFullyQualifiedName()

◆ getOnLoadCode()

◆ getTriggeredSignals()

◆ toArray()

◆ withAdditionalOnLoadCode()

◆ withOnLoadCode()

◆ withResetTriggeredSignals()

◆ wrongTypeMessage()

Variable Documentation

◆ ComponentHelper

◆ JavaScriptBindable

◆ Triggerer