MyCLabs\Enum\Enum Class Reference

Inheritance diagram for MyCLabs\Enum\Enum:

Public Member Functions
	__construct ($value)
	__toString ()
	equals ($variable=null)
	getKey ()
	getValue ()
	jsonSerialize ()

Static Public Member Functions
static	__callStatic ($name, $arguments)
static	isValid ($value)
static	isValidKey ($key)
static	keys ()
static	search ($value)
static	toArray ()
static	values ()

Protected Attributes
	$value

Static Protected Attributes
static	$cache = []

Detailed Description

Base Enum class

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

Author

Matthieu Napoli matth.nosp@m.ieu@.nosp@m.mnapo.nosp@m.li.f.nosp@m.r

Daniel Costa danie.nosp@m.lcos.nosp@m.ta@gm.nosp@m.ail..nosp@m.com

Mirosław Filip mirfi.nosp@m.lip@.nosp@m.gmail.nosp@m..com

@psalm-template T @psalm-immutable

Definition at line 21 of file Enum.php.

Constructor & Destructor Documentation

__construct()

MyCLabs\Enum\Enum::__construct

(

$value

)

Creates a new value of some type

@psalm-pure

Parameters

mixed

$value

@psalm-param static<T>|T $value

Exceptions

Definition at line 52 of file Enum.php.

References MyCLabs\Enum\Enum\$value, and MyCLabs\Enum\Enum\isValid().

Member Function Documentation

__callStatic()

static MyCLabs\Enum\Enum::__callStatic (   $name,   $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

Returns

static @psalm-pure

Exceptions

Definition at line 220 of file Enum.php.

__toString()

MyCLabs\Enum\Enum::__toString

(

)

@psalm-pure @psalm-suppress InvalidCast

Returns

string

Definition at line 94 of file Enum.php.

References MyCLabs\Enum\Enum\$value.

equals()

MyCLabs\Enum\Enum::equals (   $variable = null )

final

Determines if Enum should be considered equal with the variable passed as a parameter. Returns false if an argument is an object of different class or not an object.

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

@psalm-pure @psalm-param mixed $variable

Returns

bool

Definition at line 109 of file Enum.php.

References MyCLabs\Enum\Enum\getValue().

getKey()

MyCLabs\Enum\Enum::getKey

(

)

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

@psalm-pure

Returns

mixed

Definition at line 84 of file Enum.php.

getValue()

MyCLabs\Enum\Enum::getValue

(

)

@psalm-pure

Returns

mixed @psalm-return T

Definition at line 73 of file Enum.php.

References MyCLabs\Enum\Enum\$value.

Referenced by MyCLabs\Enum\Enum\equals(), and MyCLabs\Enum\Enum\jsonSerialize().

isValid()

static MyCLabs\Enum\Enum::isValid (   $value )

static

Check if is valid enum value

Parameters

$value

@psalm-param mixed $value @psalm-pure

Returns

bool

Definition at line 176 of file Enum.php.

References MyCLabs\Enum\Enum\$value.

Referenced by MyCLabs\Enum\Enum\__construct().

isValidKey()

static MyCLabs\Enum\Enum::isValidKey (   $key )

static

Check if is valid enum key

Parameters

$key	@psalm-param string $key @psalm-pure

Returns

bool

Definition at line 189 of file Enum.php.

jsonSerialize()

MyCLabs\Enum\Enum::jsonSerialize

(

)

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

Returns

mixed -pure

Definition at line 238 of file Enum.php.

References MyCLabs\Enum\Enum\getValue().

keys()

static MyCLabs\Enum\Enum::keys ( )

static

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

@psalm-pure @psalm-return list<string>

Returns

array

Definition at line 123 of file Enum.php.

search()

static MyCLabs\Enum\Enum::search (   $value )

static

Return key for value

Parameters

$value

@psalm-param mixed $value @psalm-pure

Returns

mixed

Definition at line 205 of file Enum.php.

References MyCLabs\Enum\Enum\$value.

toArray()

static MyCLabs\Enum\Enum::toArray ( )

static

Returns all possible values as an array

@psalm-pure @psalm-suppress ImpureStaticProperty

@psalm-return array<string, mixed>

Returns

array Constant name in key, constant value in value

Definition at line 156 of file Enum.php.

values()

static MyCLabs\Enum\Enum::values ( )

static

Returns instances of the Enum class of all Enum constants

@psalm-pure @psalm-return array<string, static>

Returns

static[] Constant name in key, Enum instance in value

Definition at line 135 of file Enum.php.

References MyCLabs\Enum\Enum\$value.

Field Documentation

$cache

MyCLabs\Enum\Enum::$cache = []

staticprotected

Definition at line 41 of file Enum.php.

$value

mixed MyCLabs\Enum\Enum::$value

protected

Enum value

@psalm-var T

Definition at line 32 of file Enum.php.

Referenced by MyCLabs\Enum\Enum\__construct(), MyCLabs\Enum\Enum\__toString(), MyCLabs\Enum\Enum\getValue(), MyCLabs\Enum\Enum\isValid(), MyCLabs\Enum\Enum\search(), and MyCLabs\Enum\Enum\values().

---

The documentation for this class was generated from the following file:

• Enum.php