class Option implements ItemInterface

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

string
__toString()

Prints the title of this option.

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

No description

string|null
getDescription()

No description

string
getIconBgColor()

Returns the Icon Background Color (HEX String)

string|null
getIconClass()

No description

string
getIconFgColor()

Returns the Icon Foreground Color (HEX String)

string
getIconShape()

Returns the Icon Shape

string|null
getImgURL()

No description

bool
getIsDisabled()

No description

bool
getIsSeparator()

No description

string
getKey()

No description

string
getTitle()

No description

array
jsonSerialize()

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

string
renderIconHtml()

No description

setDescription(string|null $description)

No description

setDisabled(bool $isDisabled = true)

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

setIconBgColor(string $color)

Sets an Icon Background Color (HEX String)

setIconClass(string|null $iconClass)

No description

setIconFgColor(string $color)

Sets an Icon Foreground Color (HEX String)

setIconShape(string $shape)

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

setImgURL(string|null $imgURL)

No description

setIsSeparator(bool $bool = true)

No description

setKey(int|string $key)

No description

setTitle(string $title)

No description

array
toArray()

No description

Details

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

at line 273
string __toString()

Prints the title of this option.

Return Value

string

at line 217
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 68
string|null getDescription()

No description

Return Value

string|null

at line 160
string getIconBgColor()

Returns the Icon Background Color (HEX String)

Return Value

string

at line 85
string|null getIconClass()

No description

Return Value

string|null

at line 142
string getIconFgColor()

Returns the Icon Foreground Color (HEX String)

Return Value

string

at line 178
string getIconShape()

Returns the Icon Shape

Return Value

string

at line 103
string|null getImgURL()

No description

Return Value

string|null

at line 203
bool getIsDisabled()

No description

Return Value

bool

at line 185
bool getIsSeparator()

No description

Return Value

bool

at line 34
string getKey()

No description

Return Value

string

at line 51
string getTitle()

No description

Return Value

string

at line 226
array jsonSerialize()

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

Return Value

array

at line 277
string renderIconHtml()

No description

Return Value

string

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

No description

Parameters

string|null $description

Return Value

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 151
Option setIconBgColor(string $color)

Sets an Icon Background Color (HEX String)

Parameters

string $color

Return Value

Option

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

No description

Parameters

string|null $iconClass

Return Value

Option

at line 133
Option setIconFgColor(string $color)

Sets an Icon Foreground Color (HEX String)

Parameters

string $color

Return Value

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

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

No description

Parameters

string|null $imgURL

Return Value

Option

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

No description

Parameters

bool $bool

Return Value

Option

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

No description

Parameters

int|string $key

Return Value

Option

at line 60
Option setTitle(string $title)

No description

Parameters

string $title

Return Value

Option

at line 230
array toArray()

No description

Return Value

array