JsConfirmation extends Enumeration
A class providing constants for bitwise operations on javascript confirmation popups
Table of Contents
Constants
- __default = self::ALL
- ALL = 255
- COPY_MOVE_PASTE = 0b10
- DELETE = 0b100
- FE_EDIT = 0b1000
- OTHER = 0b10000000
- TYPE_CHANGE = 0b1
Properties
- $allowedValues : int
- Bitmask of allowed values beside 255
- $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)
- matches() : bool
- Returns TRUE if a given value matches the internal value
- 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
int
__default
= self::ALL
ALL
public
int
ALL
= 255
COPY_MOVE_PASTE
public
int
COPY_MOVE_PASTE
= 0b10
DELETE
public
int
DELETE
= 0b100
FE_EDIT
public
int
FE_EDIT
= 0b1000
OTHER
public
int
OTHER
= 0b10000000
TYPE_CHANGE
public
int
TYPE_CHANGE
= 0b1
Properties
$allowedValues
Bitmask of allowed values beside 255
protected
static int
$allowedValues
= self::TYPE_CHANGE | self::COPY_MOVE_PASTE | self::DELETE | self::FE_EDIT | self::OTHER
$enumConstants
protected
static array<string|int, mixed>
$enumConstants
$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
stringmatches()
Returns TRUE if a given value matches the internal value
public
matches(JsConfirmation $value) : bool
Parameters
- $value : JsConfirmation
-
Value to check
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