InformationStatus extends Enumeration
This class holds the severities of the SystemInformation toolbar menu
Table of Contents
Constants
- __default = self::STATUS_INFO
- STATUS_ERROR = 'danger'
- STATUS_INFO = 'info'
- STATUS_NOTICE = ''
- STATUS_OK = 'success'
- STATUS_WARNING = 'warning'
Properties
- $enumConstants : array<string|int, mixed>
- $statusIntegerMap : array<string|int, int>
- $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<string|int, mixed>
- 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)
- isGreaterThan() : bool
- Check if the given status is greater than this status instance
- 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::STATUS_INFO
STATUS_ERROR
public
string
STATUS_ERROR
= 'danger'
STATUS_INFO
public
string
STATUS_INFO
= 'info'
STATUS_NOTICE
public
string
STATUS_NOTICE
= ''
STATUS_OK
public
string
STATUS_OK
= 'success'
STATUS_WARNING
public
string
STATUS_WARNING
= 'warning'
Properties
$enumConstants
protected
static array<string|int, mixed>
$enumConstants
$statusIntegerMap
protected
static array<string|int, int>
$statusIntegerMap
= [self::STATUS_NOTICE => -2, self::STATUS_INFO => -1, self::STATUS_OK => 0, self::STATUS_WARNING => 1, self::STATUS_ERROR => 2]
$value
protected
mixed
$value
Methods
__construct()
public
__construct([mixed $value = null ]) : mixed
Parameters
- $value : mixed = null
Tags
__toString()
Core types must implement the __toString function in order to be serialized to the database;
public
__toString() : string
Return values
stringcast()
Cast value to enumeration type
public
static cast(mixed $value) : static
Parameters
- $value : mixed
-
Value that has to be casted
Return values
staticequals()
Compare if the value of the current object value equals the given value
public
equals(mixed $value) : bool
Parameters
- $value : mixed
-
default
Return values
boolgetConstants()
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<string|int, mixed>
Parameters
- $include_default : bool = false
Return values
array<string|int, mixed>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
stringgetName()
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
stringisGreaterThan()
Check if the given status is greater than this status instance
public
isGreaterThan(InformationStatus $status) : bool
Parameters
- $status : InformationStatus
Return values
boolisValid()
Check if the value on this enum is a valid value for the enum
protected
isValid(mixed $value) : bool
Parameters
- $value : mixed
Return values
boolloadValues()
protected
static loadValues() : mixed
param string $class
Tags
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