Action extends Enumeration

FinalYes

List of possible scheduler actions. Additional field providers use this.

Set by SchedulerModuleController.

Table of Contents

Constants

__default  = self::LIST
ADD  = 'add'
EDIT  = 'edit'
LIST  = 'list'

Properties

$enumConstants  : array<string|int, mixed>
$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)
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::LIST

Properties

$enumConstants

protected static array<string|int, mixed> $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<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
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

Search results