class ModalDialog implements JsonSerializable

Modal Options

Constants

FORM_NO_AJAX

FORM_RELOAD

FORM_RELOAD_TABLE

FORM_RELOAD_XUI

Methods

static ModalDialog
create(string $title)

No description

static ModalDialog
fromLegacyOptionsArray(string $modalTitle, array $legacyOptions) deprecated

Create the ModalDialog from the legacy options array.

array|null
getCssClasses()

No description

bool|array|string|null
getFormParameters()

Get the form reload parameters.

string|null
getHeight()

No description

string|null
getId()

No description

string|null
getMaxHeight()

No description

string|null
getMaxWidth()

No description

string|null
getNoButtonLabel()

No description

string|null
getTitle()

No description

string|null
getTitleIconCssClass()

No description

string|null
getWidth()

No description

string|null
getXuiTarget()

No description

string|null
getYesButtonLabel()

No description

bool
isFullscreen()

No description

bool
isIframe()

No description

bool
isShowCloseConfirm()

No description

array
jsonSerialize()

No description

setCssClasses(array|null $cssClasses)

No description

setFormNoAjax(bool $noAjax = true)

No description

setFormReload(bool|null $formReload = true)

No description

setFormReloadTable(string|null $tableDomId)

No description

setFormReloadXui(string|null $xuiDomId)

No description

setHasForm(bool $hasForm = true)

No description

setHeight(string|int|null $height)

No description

setId(string|null $id)

No description

setIsFullscreen(bool $isFullscreen = true)

No description

setIsIframe(bool $isIframe)

No description

setIsShowCloseConfirm(bool $showCloseConfirm = true)

No description

setMaxHeight(string|int|null $maxHeight)

No description

setMaxWidth(string|int|null $maxWidth)

No description

setNoButtonLabel(string|null $noButtonLabel)

No description

setTitle(string|null $title)

No description

setTitleIconCssClass(string|null $titleIconCssClass)

No description

setWidth(string|int|null $width)

No description

setXuiTarget(string|null $xuiTarget)

No description

setYesButtonLabel(string|null $yesButtonLabel)

No description

array
toArray()

No description

Details

at line 36
static ModalDialog create(string $title)

No description

Parameters

string $title

Return Value

ModalDialog

at line 242
static ModalDialog fromLegacyOptionsArray(string $modalTitle, array $legacyOptions) deprecated

deprecated Create `ModalDialog` directly and use its setters instead. This is just a fallback for legacy code.

Create the ModalDialog from the legacy options array.

Parameters

string $modalTitle
array $legacyOptions

Return Value

ModalDialog

at line 165
array|null getCssClasses()

No description

Return Value

array|null

at line 219
bool|array|string|null getFormParameters()

Get the form reload parameters.

The parameters may be:

  • null: if no form is used
  • boolean true: if plain form is used with AJAX
  • the string 'noajax': if plain form is used without AJAX
  • an array with reload params to reload page or specific elements: ['reload' => true, 'reloadTable' => 'table_dom_id', 'reloadXUI' => 'xui_dom_id']

Return Value

bool|array|string|null

at line 84
string|null getHeight()

No description

Return Value

string|null

at line 102
string|null getId()

No description

Return Value

string|null

at line 93
string|null getMaxHeight()

No description

Return Value

string|null

at line 75
string|null getMaxWidth()

No description

Return Value

string|null

at line 156
string|null getNoButtonLabel()

No description

Return Value

string|null

at line 48
string|null getTitle()

No description

Return Value

string|null

at line 129
string|null getTitleIconCssClass()

No description

Return Value

string|null

at line 66
string|null getWidth()

No description

Return Value

string|null

at line 111
string|null getXuiTarget()

No description

Return Value

string|null

at line 147
string|null getYesButtonLabel()

No description

Return Value

string|null

at line 57
bool isFullscreen()

No description

Return Value

bool

at line 120
bool isIframe()

No description

Return Value

bool

at line 138
bool isShowCloseConfirm()

No description

Return Value

bool

at line 310
array jsonSerialize()

No description

Return Value

array

at line 160
ModalDialog setCssClasses(array|null $cssClasses)

No description

Parameters

array|null $cssClasses

Return Value

ModalDialog

at line 174
ModalDialog setFormNoAjax(bool $noAjax = true)

No description

Parameters

bool $noAjax

Return Value

ModalDialog

at line 179
ModalDialog setFormReload(bool|null $formReload = true)

No description

Parameters

bool|null $formReload

Return Value

ModalDialog

at line 183
ModalDialog setFormReloadTable(string|null $tableDomId)

No description

Parameters

string|null $tableDomId

Return Value

ModalDialog

at line 187
ModalDialog setFormReloadXui(string|null $xuiDomId)

No description

Parameters

string|null $xuiDomId

Return Value

ModalDialog

at line 169
ModalDialog setHasForm(bool $hasForm = true)

No description

Parameters

bool $hasForm

Return Value

ModalDialog

at line 79
ModalDialog setHeight(string|int|null $height)

No description

Parameters

string|int|null $height

Return Value

ModalDialog

at line 97
ModalDialog setId(string|null $id)

No description

Parameters

string|null $id

Return Value

ModalDialog

at line 52
ModalDialog setIsFullscreen(bool $isFullscreen = true)

No description

Parameters

bool $isFullscreen

Return Value

ModalDialog

at line 115
ModalDialog setIsIframe(bool $isIframe)

No description

Parameters

bool $isIframe

Return Value

ModalDialog

at line 133
ModalDialog setIsShowCloseConfirm(bool $showCloseConfirm = true)

No description

Parameters

bool $showCloseConfirm

Return Value

ModalDialog

at line 88
ModalDialog setMaxHeight(string|int|null $maxHeight)

No description

Parameters

string|int|null $maxHeight

Return Value

ModalDialog

at line 70
ModalDialog setMaxWidth(string|int|null $maxWidth)

No description

Parameters

string|int|null $maxWidth

Return Value

ModalDialog

at line 151
ModalDialog setNoButtonLabel(string|null $noButtonLabel)

No description

Parameters

string|null $noButtonLabel

Return Value

ModalDialog

at line 43
ModalDialog setTitle(string|null $title)

No description

Parameters

string|null $title

Return Value

ModalDialog

at line 124
ModalDialog setTitleIconCssClass(string|null $titleIconCssClass)

No description

Parameters

string|null $titleIconCssClass

Return Value

ModalDialog

at line 61
ModalDialog setWidth(string|int|null $width)

No description

Parameters

string|int|null $width

Return Value

ModalDialog

at line 106
ModalDialog setXuiTarget(string|null $xuiTarget)

No description

Parameters

string|null $xuiTarget

Return Value

ModalDialog

at line 142
ModalDialog setYesButtonLabel(string|null $yesButtonLabel)

No description

Parameters

string|null $yesButtonLabel

Return Value

ModalDialog

at line 285
array toArray()

No description

Return Value

array