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

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

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

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

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

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

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

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

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

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

	Entity

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

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

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

	Launcher

	Layout

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

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

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

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

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

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

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

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

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

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

	Progress

	Prompt

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

	Table

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

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

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

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

Detailed Description

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

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Definition at line 71 of file JavaScriptBindable.php.

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

                                                  : 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".');
         }
     }

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.

References Vendor\Package\$a.

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

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

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 getHelpTopics

Definition at line 55 of file HasHelpTopics.php.

                                    : array
     {
         return $this->help_topics;
     }

◆ getOnLoadCode()

ILIAS\UI\Implementation\Component\getOnLoadCode ( )

See also: getOnLoadCode

Definition at line 63 of file JavaScriptBindable.php.

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

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

Here is the caller graph for this function:

◆ getTriggeredSignals()

ILIAS\UI\Implementation\Component\getTriggeredSignals ( )

Returns: TriggeredSignal[]

Definition at line 84 of file Triggerer.php.

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

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

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[]

Definition at line 94 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(), ILIAS\UI\Implementation\Component\Button\Toggle\getActionOn(), and ILIAS\UI\Implementation\Component\Card\Card\getTitleAction().

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

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.

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

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

Here is the caller graph for this function:

◆ withAdditionalHelpTopics()

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

See also: ILIAS withAdditionalHelpTopics

Definition at line 44 of file HasHelpTopics.php.

References ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

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

Here is the call graph for this function:

◆ withAdditionalOnLoadCode()

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

See also: withAdditionalOnLoadCode

Definition at line 49 of file JavaScriptBindable.php.

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

Referenced by ilPersonalProfileGUI\addEmailChangeModal(), ilMyStaffGUI\addLinkWithActionData(), ilDclRecordListTableGUI\buildData(), ilObjForumGUI\doHistoryCheck(), ILIAS\OnScreenChat\Provider\OnScreenChatProvider\getAsyncItem(), ILIAS\Object\Properties\MultiObjectPropertiesManipulator\getAvailabilityPeriodButton(), ILIAS\Notes\Export\ExportHelperGUI\getCommentIncludeModalDialog(), ilQuestionBrowserTableGUI\getCommentsHtml(), ILIAS\Search\Provider\SearchMetaBarProvider\getMetaBarItems(), ilDclBaseRecordModel\getStandardFieldHTML(), ilNoteGUI\getTriggerShyButton(), ilObjDashboardSettingsGUI\getViewSectionSorting(), ILIAS\Test\Settings\MainSettings\SettingsMainGUI\populateConfirmationModal(), assClozeTestGUI\populateQuestionSpecificFormPart(), ILIAS\BookingManager\BookingProcess\ObjectSelectionListGUI\render(), ilBookBulkCreationGUI\renderConfirmation(), ilTermDefinitionBulkCreationGUI\renderConfirmation(), and assFormulaQuestionGUI\resetSavedPreviewSession().

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

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 withHelpTopics

Definition at line 33 of file HasHelpTopics.php.

References ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Referenced by ilFooterGroupsGUI\addButtons().

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

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 38 of file JavaScriptBindable.php.

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

Referenced by ilObjForumGUI\addActivationFormModal(), ILIAS\Test\Questions\Presentation\Printer\addPrintButtonToToolbar(), ilTestEvaluationGUI\addPrintButtonToToolbar(), ilTestEvaluationGUI\addPrintResultsButtonToToolbar(), ilGroupAddToGroupActionGUI\confirmAddUser(), ilGroupAddToGroupActionGUI\confirmCreateGroupAndAddUser(), ilMailFolderGUI\confirmDeleteMails(), ilTable2GUI\fillFooter(), ILIAS\Repository\Modal\ModalAdapterGUI\form(), ilObjStudyProgrammeAutoCategoriesGUI\getAsyncModalOutput(), ILIAS\MetaData\Vocabularies\Dispatch\Presentation\Presentation\VideoViewGUI\getDropdown(), ilExerciseManagementGUI\getEvaluationModal(), ilPersonalSkillsGUI\getLatestEntriesForSkillHTML(), ilObjLinkResourceGUI\getLinkToListModal(), ilPersonalSkillsGUI\getNonLatestEntriesForSkillHTML(), ILIAS\COPage\Editor\Server\UIWrapper\getRenderedModalFailureBox(), ilInternalLinkGUI\getUserSearchResult(), ilCalendarBlockGUI\getViewControl(), ilObjForumGUI\initHeaderAction(), ilExerciseSubmissionTableGUI\parseColumns(), ilForumNotificationTableGUI\populateWithModal(), ilNewsTimelineItemGUI\render(), ILIAS\UI\Implementation\Component\Input\Container\Filter\Renderer\renderApplyAndReset(), ilTaggingSlateContentGUI\renderResourcesForTag(), ILIAS\MetaData\Vocabularies\Dispatch\Presentation\Presentation\VideoViewGUI\renderSideColumn(), ilObjForumGUI\renderSplitButton(), ilExerciseManagementGUI\saveGradesObject(), ilHelpGUI\search(), ilGroupAddToGroupActionGUI\sendResponse(), ilGroupAddToGroupActionGUI\show(), ilMailFormGUI\showForm(), ilHelpGUI\showPage(), ilObjectCopyGUI\showTargetSelectionTree(), ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd(), 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 ( )

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 26 of file HasContentLanguage.php.

◆ HasHelpTopics

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

Initial value:

{
    
    protected array $help_topics = []

Definition at line 26 of file HasHelpTopics.php.

Referenced by HasHelpTopicsTest\setUp().

◆ JavaScriptBindable

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

Initial value:

{

private ?Closure $on_load_code_binder = null

Closure

Trait for components implementing JavaScriptBindable providing standard implementation.

Definition at line 32 of file JavaScriptBindable.php.

◆ Triggerer

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

Initial value:

{
    
    private array $triggered_signals = array()

Definition at line 36 of file Triggerer.php.

Namespaces

Data Structures

Functions

Variables

Detailed Description

Function Documentation

◆ appendTriggeredSignal()

◆ checkBinder()

◆ flattenArray()

◆ getContentLanguage()

◆ getHelpTopics()

◆ getOnLoadCode()

◆ getTriggeredSignals()

◆ getTriggeredSignalsFor()

◆ setTriggeredSignal()

◆ withAdditionalHelpTopics()

◆ withAdditionalOnLoadCode()

◆ withContentLanguage()

◆ withHelpTopics()

◆ withOnLoadCode()

◆ withResetTriggeredSignals()

◆ withTriggeredSignal()

Variable Documentation

◆ HasContentLanguage

◆ HasHelpTopics

◆ JavaScriptBindable

◆ Triggerer