API Documentation
\

\Enum

Base Enum class

Create an enum by implementing this class and adding class constants.

class Action extends Enum
{
    const VIEW = 'view';
    const EDIT = 'edit';
}

$action = Action::VIEW();
$action = new Action(Action::VIEW);

Summary

Methods
Properties
Constants
__construct()
getValue()
getKey()
__toString()
equals()
keys()
values()
toArray()
isValid()
isValidKey()
search()
__callStatic()
No public properties found
No constants found
No protected methods found
$value
$cache
N/A
No private methods found
No private properties found
N/A

Properties

$value

$value : mixed

Enum value

Type

mixed

$cache

$cache : array

Store existing constants in a static cache per object.

Type

array

Methods

__construct()

__construct(mixed  $value)

Creates a new value of some type

Parameters

mixed $value

Throws

\UnexpectedValueException

if incompatible type is given.

getValue()

getValue() : mixed

Returns

mixed

getKey()

getKey() : mixed

Returns the enum key (i.e. the constant name).

Returns

mixed

__toString()

__toString() : string

Returns

string

equals()

equals(\Enum  $enum) : boolean

Compares one Enum with another.

This method is final

Parameters

\Enum $enum

Returns

boolean —

True if Enums are equal, false if not equal

keys()

keys() : array

Returns the names (keys) of all constants in the Enum class

Returns

array

values()

values() : array<mixed,static>

Returns instances of the Enum class of all Enum constants

Returns

array<mixed,static> —

Constant name in key, Enum instance in value

toArray()

toArray() : array

Returns all possible values as an array

Returns

array —

Constant name in key, constant value in value

isValid()

isValid(  $value) : boolean

Check if is valid enum value

Parameters

$value

Returns

boolean

isValidKey()

isValidKey(  $key) : boolean

Check if is valid enum key

Parameters

$key

Returns

boolean

search()

search(  $value) : mixed

Return key for value

Parameters

$value

Returns

mixed

__callStatic()

__callStatic(string  $name, array  $arguments) : static

Returns a value when called statically like so: MyEnum::SOME_VALUE() given SOME_VALUE is a class constant

Parameters

string $name
array $arguments

Throws

\BadMethodCallException

Returns

static