IconState

final class \TYPO3\CMS\Core\Type\Icon\IconState

Extends
Enumeration

A class providing constants for icon states

Table of Contents

Constants

__default  : mixed = self::STATE_DEFAULT
STATE_DEFAULT  : string = 'default'
STATE_DISABLED  : string = 'disabled'

Properties

$enumConstants  : array
$value  : mixed

Methods

__construct()  : mixed
__toString()  : string
Core types must implement the __toString function in order to be serialized to the database;
cast()  : static
Cast value to enumeration type
equals()  : bool
Compare if the value of the current object value equals the given value
getConstants()  : array
Get the valid values for this enum Defaults to constants you define in your subclass override to provide custom functionality
getHumanReadableName()  : string
Returns the name of the constant, first char upper, underscores as spaces
getName()  : string
Returns the constants name as is, without manipulation (usually all upper case)
isValid()  : bool
Check if the value on this enum is a valid value for the enum
loadValues()  : mixed
setValue()  : mixed
Set the Enumeration value to the associated enumeration value by a loose comparison.

Constants

__default

public mixed __default = self::STATE_DEFAULT

STATE_DEFAULT

public string STATE_DEFAULT = 'default'

the default state identifier

STATE_DISABLED

public string STATE_DISABLED = 'disabled'

the disabled state identifier

Properties

$enumConstants

protected static array $enumConstants

Methods

__toString()

Core types must implement the __toString function in order to be serialized to the database;

public __toString() : string

Return values

string

cast()

Cast value to enumeration type

public static cast(mixed $value) : static

Parameters

$value : mixed

Value that has to be casted

Return values

static

equals()

Compare if the value of the current object value equals the given value

public equals(mixed $value) : bool

Parameters

$value : mixed

default

Return values

bool

getConstants()

Get the valid values for this enum Defaults to constants you define in your subclass override to provide custom functionality

public static getConstants([bool $include_default = false ]) : array

Parameters

$include_default : bool = false

Return values

array

getHumanReadableName()

Returns the name of the constant, first char upper, underscores as spaces

public static getHumanReadableName(string|int $value) : string

Parameters

$value : string|int

Return values

string

getName()

Returns the constants name as is, without manipulation (usually all upper case)

public static getName(string|int $value) : string

Parameters

$value : string|int

Return values

string

isValid()

Check if the value on this enum is a valid value for the enum

protected isValid(mixed $value) : bool

Parameters

$value : mixed

Return values

bool

setValue()

Set the Enumeration value to the associated enumeration value by a loose comparison.

protected setValue(mixed $value) : mixed

The value, that is used as the enumeration value, will be of the same type like defined in the enumeration

Parameters

$value : mixed

Tags

throws
InvalidEnumerationValueException
On this page