ILIAS\UI\Component\Modal\Modal Interface Reference

This describes commonalities between the different modals. More...

Inheritance diagram for ILIAS\UI\Component\Modal\Modal:

Collaboration diagram for ILIAS\UI\Component\Modal\Modal:

Public Member Functions
	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

This describes commonalities between the different modals.

Definition at line 34 of file Modal.php.

Member Function Documentation

getAsyncRenderUrl()

ILIAS\UI\Component\Modal\Modal::getAsyncRenderUrl

(

)

Get the url returning the rendered modal, if the modals content should be rendered via ajax.

Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\File, and ILIAS\UI\Implementation\Component\Modal\Modal.

getCloseSignal()

ILIAS\UI\Component\Modal\Modal::getCloseSignal

(

)

Get the signal to close this modal in the frontend.

Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\File, and ILIAS\UI\Implementation\Component\Modal\Modal.

getCloseWithKeyboard()

ILIAS\UI\Component\Modal\Modal::getCloseWithKeyboard

(

)

Returns if this modal can be closed with the keyboard (ESC key)

Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\File, and ILIAS\UI\Implementation\Component\Modal\Modal.

getShowSignal()

ILIAS\UI\Component\Modal\Modal::getShowSignal

(

)

Get the signal to show this modal in the frontend.

Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\File, and ILIAS\UI\Implementation\Component\Modal\Modal.

Referenced by ilCmiXapiStatementsTableGUI\getActionsList().

Here is the caller graph for this function:

withAsyncRenderUrl()

ILIAS\UI\Component\Modal\Modal::withAsyncRenderUrl

(

string

$url

)

Get a modal like this who's content is rendered via ajax by the given $url before the modal is shown.

Means: After the show signal has been triggered but before the modal is displayed to the user, an ajax request is sent to this url. The request MUST return the rendered output of a modal.

Returns

static

Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\File, and ILIAS\UI\Implementation\Component\Modal\Modal.

withCloseWithKeyboard()

ILIAS\UI\Component\Modal\Modal::withCloseWithKeyboard

(

bool

$state

)

Get a modal like this which can or cannot be closed by keyboard (ESC), depending on the given $state.

Returns

static

Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\File, and ILIAS\UI\Implementation\Component\Modal\Modal.

---

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

• components/ILIAS/UI/src/Component/Modal/Modal.php