1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. XF
  7. \
  8. UI
  9. \
  10. Link
  11. \
  12. MenuListItem

MenuListItem

class MenuListItem extends Option

Constants

ICON_SHAPE_CIRCLE

ICON_SHAPE_ROUNDED_BOX

Methods

__construct($key, string $title, string|null $description = null, string|null $iconClass = null, string|null $imgURL = null)

No description

from  Option
string
__toString()

Prints the title of this option.

from  Option
static Option
create($key, string $title, string|null $description = null, string|null $iconClass = null, string|null $imgURL = null)

No description

static MenuListItem
createEmpty()

No description

static MenuListItem
createFromLink(array $linkArray)

No description

string|null
getConfirmDialog()

No description

string|null
getDescription()

No description

from  Option
string|null
getExecJS()

No description

string
getIconBgColor()

Returns the Icon Background Color (HEX String)

from  Option
string|null
getIconClass()

No description

from  Option
string
getIconFgColor()

Returns the Icon Foreground Color (HEX String)

from  Option
string
getIconShape()

Returns the Icon Shape

from  Option
string|null
getImgURL()

No description

from  Option
bool
getIsDisabled()

No description

from  Option
bool
getIsSeparator()

No description

from  Option
string
getKey()

No description

from  Option
ModalDialog
getModalDialog()

No description

string
getTitle()

No description

from  Option
string|null
getUrl()

No description

array
jsonSerialize()

Transforms the array structure of this option into a JSON string.

from  Option
string
renderIconHtml()

No description

from  Option
MenuListItem
setConfirmDialog(string $confirmMessage = null)

No description

Option
setDescription(string|null $description)

No description

from  Option
Option
setDisabled(bool $isDisabled = true)

Mark this entry as disalbed (can not be selected by user)

from  Option
MenuListItem
setExecJS(string|null $javascriptExecString)

No description

Option
setIconBgColor(string $color)

Sets an Icon Background Color (HEX String)

from  Option
Option
setIconClass(string|null $iconClass)

No description

from  Option
Option
setIconFgColor(string $color)

Sets an Icon Foreground Color (HEX String)

from  Option
Option
setIconShape(string $shape)

Sets an Icon Shape (self::ICON_SHAPE_CIRCLE, self::ICON_SHAPE_ROUNDED_BOX)

from  Option
Option
setImgURL(string|null $imgURL)

No description

from  Option
Option
setIsSeparator(bool $bool = true)

No description

from  Option
Option
setKey(int|string $key)

No description

from  Option
MenuListItem
setModalDialog(ModalDialog $modalDialog)

Set the ModalDialog for this list item.

Option
setTitle(string $title)

No description

from  Option
MenuListItem
setUrl(string|null $url)

No description

MenuListItem
setUrlFromOptions(Options $linkOptions)

No description

array
toArray()

No description

Details

in Option at line 209
protected __construct($key, string $title, string|null $description = null, string|null $iconClass = null, string|null $imgURL = null)

No description

Parameters

$key
string $title
string|null $description
string|null $iconClass
string|null $imgURL

in Option at line 273
string __toString()

Prints the title of this option.

Return Value

string

at line 21
static Option create($key, string $title, string|null $description = null, string|null $iconClass = null, string|null $imgURL = null)

No description

Parameters

$key
string $title
string|null $description
string|null $iconClass
string|null $imgURL

Return Value

Option

at line 26
static MenuListItem createEmpty()

No description

Return Value

MenuListItem

No description

Parameters

array $linkArray

Return Value

MenuListItem

at line 113
string|null getConfirmDialog()

No description

Return Value

string|null

in Option at line 68
string|null getDescription()

No description

Return Value

string|null

at line 104
string|null getExecJS()

No description

Return Value

string|null

in Option at line 160
string getIconBgColor()

Returns the Icon Background Color (HEX String)

Return Value

string

in Option at line 85
string|null getIconClass()

No description

Return Value

string|null

in Option at line 142
string getIconFgColor()

Returns the Icon Foreground Color (HEX String)

Return Value

string

in Option at line 178
string getIconShape()

Returns the Icon Shape

Return Value

string

in Option at line 103
string|null getImgURL()

No description

Return Value

string|null

in Option at line 203
bool getIsDisabled()

No description

Return Value

bool

in Option at line 185
bool getIsSeparator()

No description

Return Value

bool

in Option at line 34
string getKey()

No description

Return Value

string

at line 128
ModalDialog getModalDialog()

No description

Return Value

ModalDialog

in Option at line 51
string getTitle()

No description

Return Value

string

at line 95
string|null getUrl()

No description

Return Value

string|null

in Option at line 226
array jsonSerialize()

Transforms the array structure of this option into a JSON string.

Return Value

array

in Option at line 277
string renderIconHtml()

No description

Return Value

string

at line 108
MenuListItem setConfirmDialog(string $confirmMessage = null)

No description

Parameters

string $confirmMessage

Return Value

MenuListItem

in Option at line 77
Option setDescription(string|null $description)

No description

Parameters

string|null $description

Return Value

Option

in Option at line 195
Option setDisabled(bool $isDisabled = true)

Mark this entry as disalbed (can not be selected by user)

Parameters

bool $isDisabled

Return Value

Option

at line 99
MenuListItem setExecJS(string|null $javascriptExecString)

No description

Parameters

string|null $javascriptExecString

Return Value

MenuListItem

in Option at line 151
Option setIconBgColor(string $color)

Sets an Icon Background Color (HEX String)

Parameters

string $color

Return Value

Option

in Option at line 94
Option setIconClass(string|null $iconClass)

No description

Parameters

string|null $iconClass

Return Value

Option

in Option at line 133
Option setIconFgColor(string $color)

Sets an Icon Foreground Color (HEX String)

Parameters

string $color

Return Value

Option

in Option at line 169
Option setIconShape(string $shape)

Sets an Icon Shape (self::ICON_SHAPE_CIRCLE, self::ICON_SHAPE_ROUNDED_BOX)

Parameters

string $shape

Return Value

Option

in Option at line 113
Option setImgURL(string|null $imgURL)

No description

Parameters

string|null $imgURL

Return Value

Option

in Option at line 123
Option setIsSeparator(bool $bool = true)

No description

Parameters

bool $bool

Return Value

Option

in Option at line 43
Option setKey(int|string $key)

No description

Parameters

int|string $key

Return Value

Option

at line 122
MenuListItem setModalDialog(ModalDialog $modalDialog)

Set the ModalDialog for this list item.

Parameters

ModalDialog $modalDialog

Return Value

MenuListItem

in Option at line 60
Option setTitle(string $title)

No description

Parameters

string $title

Return Value

Option

at line 90
MenuListItem setUrl(string|null $url)

No description

Parameters

string|null $url

Return Value

MenuListItem

at line 84
MenuListItem setUrlFromOptions(Options $linkOptions)

No description

Parameters

Options $linkOptions

Return Value

MenuListItem

at line 132
array toArray()

No description

Return Value

array