ILIAS  trunk Revision v11.0_alpha-1831-g8615d53dadb
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ILIAS\UI\Component\MainControls\Footer Interface Reference
+ Inheritance diagram for ILIAS\UI\Component\MainControls\Footer:
+ Collaboration diagram for ILIAS\UI\Component\MainControls\Footer:

Public Member Functions

 withAdditionalLinkGroup (string $title, array $actions)
 Get a Footer like this but add an additional, named group of links or shy-buttons to the link-group section. More...
 
 withAdditionalLink (Link|Shy ... $actions)
 Get a Footer like this but add an additional link or shy-button to the links section. More...
 
 withAdditionalIcon (Icon $icon, URI|Signal|null $action=null)
 Get a Footer like this but add an additional Icon to the icons section. More...
 
 withAdditionalText (string ... $texts)
 Get a Footer like this but add additional text information to the meta section. More...
 
 withPermanentURL (URI $url)
 Get a Footer like this but with a permanent URL to the current page, which can be copied by the users. More...
 
 withAdditionalModal (Modal\RoundTrip $modal)
 
- Public Member Functions inherited from ILIAS\UI\Component\Component
 getCanonicalName ()
 Get the canonical name of the component. More...
 
 reduceWith (\Closure $fn)
 The scheme starts at the leaves of the structure and applies the function to each leave and moves up the tree recursively. More...
 

Detailed Description

Definition at line 31 of file Footer.php.

Member Function Documentation

◆ withAdditionalIcon()

ILIAS\UI\Component\MainControls\Footer::withAdditionalIcon ( Icon  $icon,
URI|Signal|null  $action = null 
)

Get a Footer like this but add an additional Icon to the icons section.

The Icon may also trigger an action or signal to trigger a dialog.

◆ withAdditionalLink()

ILIAS\UI\Component\MainControls\Footer::withAdditionalLink ( Link|Shy ...  $actions)

Get a Footer like this but add an additional link or shy-button to the links section.

Parameters
Link|Shy...$actions only use Shy buttons if they trigger signal(s).

Referenced by ILIAS\GlobalScreen\Scope\Footer\Collector\Renderer\FooterRendererFactory\addToFooter().

+ Here is the caller graph for this function:

◆ withAdditionalLinkGroup()

ILIAS\UI\Component\MainControls\Footer::withAdditionalLinkGroup ( string  $title,
array  $actions 
)

Get a Footer like this but add an additional, named group of links or shy-buttons to the link-group section.

Parameters
array<Link|Shy>$actions only use Shy buttons if they trigger signal(s).

Referenced by ILIAS\GlobalScreen\Scope\Footer\Collector\Renderer\FooterRendererFactory\addToFooter().

+ Here is the caller graph for this function:

◆ withAdditionalModal()

ILIAS\UI\Component\MainControls\Footer::withAdditionalModal ( Modal\RoundTrip  $modal)
Deprecated:
injecting modals into the footer will be removed in the future.

Get a Footer like this but add an additional modal wich will be rendered to the page. Please be aware that you must add the Triggerer for the modal to the footer as well and connect the modal to the triggerer. Do not use this to add Modals not related to the Footer.

Referenced by ILIAS\GlobalScreen\Scope\Footer\Collector\Renderer\FooterRendererFactory\addToFooter().

+ Here is the caller graph for this function:

◆ withAdditionalText()

ILIAS\UI\Component\MainControls\Footer::withAdditionalText ( string ...  $texts)

Get a Footer like this but add additional text information to the meta section.

Referenced by ILIAS\GlobalScreen\Scope\Footer\Collector\Renderer\FooterRendererFactory\addToFooter().

+ Here is the caller graph for this function:

◆ withPermanentURL()

ILIAS\UI\Component\MainControls\Footer::withPermanentURL ( URI  $url)

Get a Footer like this but with a permanent URL to the current page, which can be copied by the users.

Referenced by ILIAS\GlobalScreen\Scope\Footer\Collector\Renderer\FooterRendererFactory\addToFooter().

+ Here is the caller graph for this function:

The documentation for this interface was generated from the following file: