PHP Class MyCLabs\Enum\Enum

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

Protected Properties

Property	Type	Description
$cache	array	Store existing constants in a static cache per object.
$value	mixed	Enum value

Method	Description
__callStatic ( string $name, array $arguments ) : static	Returns a value when called statically like so: MyEnum::SOME_VALUE() given SOME_VALUE is a class constant
__construct ( mixed $value )	Creates a new value of some type
__toString ( ) : string
equals ( Enum $enum ) : boolean	Compares one Enum with another.
getKey ( ) : mixed	Returns the enum key (i.e. the constant name).
getValue ( ) : mixed
isValid ( $value ) : boolean	Check if is valid enum value
isValidKey ( $key ) : boolean	Check if is valid enum key
keys ( ) : array	Returns the names (keys) of all constants in the Enum class
search ( $value ) : mixed	Return key for value
toArray ( ) : array	Returns all possible values as an array
values ( ) : static[]	Returns instances of the Enum class of all Enum constants

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

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

Creates a new value of some type

public __construct ( mixed $value )
$value	mixed

public __toString ( ) : string
return	string

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

final public equals ( Enum $enum ) : boolean
$enum	Enum
return	boolean	True if Enums are equal, false if not equal

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

public getKey ( ) : mixed
return	mixed

public getValue ( ) : mixed
return	mixed

Check if is valid enum value

public static isValid ( $value ) : boolean
$value
return	boolean

Check if is valid enum key

public static isValidKey ( $key ) : boolean
$key
return	boolean

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

public static keys ( ) : array
return	array

Return key for value

public static search ( $value ) : mixed
$value
return	mixed

Returns all possible values as an array

public static toArray ( ) : array
return	array	Constant name in key, constant value in value

Returns instances of the Enum class of all Enum constants

public static values ( ) : static[]
return	static[]	Constant name in key, Enum instance in value

Store existing constants in a static cache per object.

protected static array $cache
return	array

Enum value

protected mixed $value
return	mixed