ILIAS  trunk Revision v11.0_alpha-1769-g99a433fe2dc
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ILIAS\UI\Component\Modal\Interruptive Interface Reference
+ Inheritance diagram for ILIAS\UI\Component\Modal\Interruptive:
+ Collaboration diagram for ILIAS\UI\Component\Modal\Interruptive:

Public Member Functions

 getMessage ()
 Get the message of this modal, displayed below the modals title. More...
 
 getTitle ()
 Get the title of this modal. More...
 
 withFormAction (string $form_action)
 Get a modal like this submitting the form to the given form action. More...
 
 withAffectedItems (array $items)
 Get a modal like this listing the given items in the content section below the message. More...
 
 getActionButtonLabel ()
 Get the custom label of the action button in the footer. More...
 
 withActionButtonLabel (string $action_label)
 Get a modal like this with the action button labeled according to the parameter. More...
 
 getCancelButtonLabel ()
 Get the custom label of the cancel button in the footer. More...
 
 withCancelButtonLabel (string $cancel_label)
 Get a modal like this with the cancel button labeled according to the parameter. More...
 
 getAffectedItems ()
 Return the affected items listed in the content by this modal. More...
 
 getFormAction ()
 Get the form action where the action button is sending the IDs of the affected items. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Modal\Modal
 getAsyncRenderUrl ()
 Get the url returning the rendered modal, if the modals content should be rendered via ajax. More...
 
 withAsyncRenderUrl (string $url)
 Get a modal like this who's content is rendered via ajax by the given $url before the modal is shown. More...
 
 withCloseWithKeyboard (bool $state)
 Get a modal like this which can or cannot be closed by keyboard (ESC), depending on the given $state. More...
 
 getCloseWithKeyboard ()
 Returns if this modal can be closed with the keyboard (ESC key) More...
 
 getShowSignal ()
 Get the signal to show this modal in the frontend. More...
 
 getCloseSignal ()
 Get the signal to close this modal in the frontend. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Component
 getCanonicalName ()
 Get the canonical name of the component. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\JavaScriptBindable
 withOnLoadCode (Closure $binder)
 
 withAdditionalOnLoadCode (Closure $binder)
 Add some onload-code to the component instead of replacing the existing one. More...
 
 getOnLoadCode ()
 Get the currently bound on load code. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Triggerable
 withResetSignals ()
 Get a component like this but reset (regenerate) its signals. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Onloadable
 withOnLoad (Signal $signal)
 Trigger a signal of another component on load. More...
 
 appendOnLoad (Signal $signal)
 Get a component like this, triggering a signal of another component on load. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Triggerer
 withResetTriggeredSignals ()
 Get a component like this but reset any triggered signals of other components. More...
 
 getTriggeredSignals ()
 Get all triggered signals of this component. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Closable
 withOnClose (Signal $signal)
 Get a component like this, triggering a signal of another component on close. More...
 
 appendOnClose (Signal $signal)
 Get a component like this, triggering a signal of another component on close. More...
 

Detailed Description

Definition at line 30 of file Interruptive.php.

Member Function Documentation

◆ getActionButtonLabel()

ILIAS\UI\Component\Modal\Interruptive::getActionButtonLabel ( )

Get the custom label of the action button in the footer.

Implemented in ILIAS\UI\Implementation\Component\Modal\Interruptive.

◆ getAffectedItems()

ILIAS\UI\Component\Modal\Interruptive::getAffectedItems ( )

Return the affected items listed in the content by this modal.

Returns
InterruptiveItem[]

Implemented in ILIAS\UI\Implementation\Component\Modal\Interruptive.

◆ getCancelButtonLabel()

ILIAS\UI\Component\Modal\Interruptive::getCancelButtonLabel ( )

Get the custom label of the cancel button in the footer.

Implemented in ILIAS\UI\Implementation\Component\Modal\Interruptive.

◆ getFormAction()

ILIAS\UI\Component\Modal\Interruptive::getFormAction ( )

Get the form action where the action button is sending the IDs of the affected items.

Implemented in ILIAS\UI\Implementation\Component\Modal\Interruptive.

◆ getMessage()

ILIAS\UI\Component\Modal\Interruptive::getMessage ( )

Get the message of this modal, displayed below the modals title.

Implemented in ILIAS\UI\Implementation\Component\Modal\Interruptive.

◆ getTitle()

ILIAS\UI\Component\Modal\Interruptive::getTitle ( )

Get the title of this modal.

Implemented in ILIAS\UI\Implementation\Component\Modal\Interruptive.

◆ withActionButtonLabel()

ILIAS\UI\Component\Modal\Interruptive::withActionButtonLabel ( string  $action_label)

Get a modal like this with the action button labeled according to the parameter.

Implemented in ILIAS\UI\Implementation\Component\Modal\Interruptive.

◆ withAffectedItems()

ILIAS\UI\Component\Modal\Interruptive::withAffectedItems ( array  $items)

Get a modal like this listing the given items in the content section below the message.

The IDs of the interruptive items are sent via POST to the form action of this modal.

Parameters
InterruptiveItem[]$items

Implemented in ILIAS\UI\Implementation\Component\Modal\Interruptive.

◆ withCancelButtonLabel()

ILIAS\UI\Component\Modal\Interruptive::withCancelButtonLabel ( string  $cancel_label)

Get a modal like this with the cancel button labeled according to the parameter.

The label will be translated.

Implemented in ILIAS\UI\Implementation\Component\Modal\Interruptive.

◆ withFormAction()

ILIAS\UI\Component\Modal\Interruptive::withFormAction ( string  $form_action)

Get a modal like this submitting the form to the given form action.

Implemented in ILIAS\UI\Implementation\Component\Modal\Interruptive.


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