\MyCLabs\EnumEnum

__construct()

__construct(mixed  $value) 

Creates a new value of some type

Parameters

Throws

\UnexpectedValueException

if incompatible type is given.

getValue()

getValue() : mixed

Returns

getKey()

getKey() : mixed

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

Returns

__toString()

__toString() : string

Returns

equals()

equals(\MyCLabs\Enum\Enum  $enum = null) : boolean

Compares one Enum with another.

This method is final, for more information read https://github.com/myclabs/php-enum/issues/4

Parameters

Returns

True if Enums are equal, false if not equal

keys()

keys() : array

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

Returns

values()

values() : array<mixed,static>

Returns instances of the Enum class of all Enum constants

Returns

Constant name in key, Enum instance in value

toArray()

toArray() : array

Returns all possible values as an array

Returns

Constant name in key, constant value in value

isValid()

isValid(  $value) : boolean

Check if is valid enum value

Parameters

Returns

isValidKey()

isValidKey(  $key) : boolean

Check if is valid enum key

Parameters

Returns

search()

search(  $value) : mixed

Return key for value

Parameters

Returns

__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

Throws

\BadMethodCallException

Returns

jsonSerialize()

jsonSerialize() : mixed

Specify data which should be serialized to JSON. This method returns data that can be serialized by json_encode() natively.

Returns