ReflectionEnumBackedCase

Since: 8.1

class ReflectionEnumBackedCase extends ReflectionEnumUnitCase (View source)

The ReflectionEnumBackedCase class reports information about an Enum backed case, which has a scalar equivalent.

Constants

IS_PUBLIC Since: 8.0

Indicates that the constant is public.
IS_PROTECTED Since: 8.0

Indicates that the constant is protected.
IS_PRIVATE Since: 8.0

Indicates that the constant is private.
IS_FINAL Since: 8.1

Properties

string $name from  ReflectionClassConstant
class-string $class from  ReflectionClassConstant
bool Since: 8.1
$isFinal from  ReflectionClassConstant

Methods

__construct(class-string|object $class, string $constant)

Instantiates a ReflectionEnumBackedCase object

static string|null
export(string|object $class, string $name, bool $return = false)

Export

from  ReflectionClassConstant
ReflectionClass
getDeclaringClass()

Gets declaring class

from  ReflectionClassConstant
string|false
getDocComment()

Gets doc comments

from  ReflectionClassConstant
int
getModifiers()

Gets the class constant modifiers

from  ReflectionClassConstant
string
getName()

Get name of the constant

from  ReflectionClassConstant
mixed
getValue()

Gets the enum case object described by this reflection object

from  ReflectionEnumUnitCase
bool
isPrivate()

Checks if class constant is private

from  ReflectionClassConstant
bool
isProtected()

Checks if class constant is protected

from  ReflectionClassConstant
bool
isPublic()

Checks if class constant is public

from  ReflectionClassConstant
string
__toString()

Returns the string representation of the ReflectionClassConstant object.

from  ReflectionClassConstant
array
getAttributes(string|null $name = null, int $flags = 0)

Gets Attributes

from  ReflectionClassConstant
bool
isEnumCase()

Checks if class constant is an Enum case

from  ReflectionClassConstant
bool
isFinal()

Checks if class constant is final

from  ReflectionClassConstant
bool
hasType()

Checks if class constant has a type

from  ReflectionClassConstant
ReflectionType|null
getType()

Gets a class constant's type

from  ReflectionClassConstant
bool
isDeprecated()

Checks if deprecated

from  ReflectionClassConstant
ReflectionEnum
getEnum()

Gets the reflection of the enum of this case

from  ReflectionEnumUnitCase
int|string
getBackingValue()

Gets the scalar value backing this Enum case

Details

at line 19
__construct(class-string|object $class, string $constant)

Instantiates a ReflectionEnumBackedCase object

Parameters

class-string|object $class

Either a string containing the name of the class to reflect, or an object.
string $constant

The name of the class constant.

in ReflectionClassConstant at line 90
static string|null export(string|object $class, string $name, bool $return = false)

Since: 7.1

Export

Exports a reflection.

Parameters

string|object $class

The reflection to export.
string $name

The class constant name.
bool $return

Setting to {\true} will return the export, as opposed to emitting it. Setting to {\false} (the default) will do the opposite.

Return Value

string|null

in ReflectionClassConstant at line 100
ReflectionClass getDeclaringClass()

Since: 7.1

Gets declaring class

Return Value

ReflectionClass

A ReflectionClass object.

in ReflectionClassConstant at line 111
string|false getDocComment()

Since: 7.1

Gets doc comments

Return Value

string|false

The doc comment if it exists, otherwise {\false}

in ReflectionClassConstant at line 123
int getModifiers()

Since: 7.1

Gets the class constant modifiers

Return Value

int

A numeric representation of the modifiers. The actual meanings of these modifiers are described in the predefined constants.

in ReflectionClassConstant at line 134
string getName()

Since: 7.1

Get name of the constant

Return Value

string

Returns the constant's name.

in ReflectionEnumUnitCase at line 29
mixed getValue()

Gets the enum case object described by this reflection object

Returns the enum case object described by this reflection object.

Return Value

mixed

The value of the class constant.

in ReflectionClassConstant at line 156
bool isPrivate()

Since: 7.1

Checks if class constant is private

Return Value

bool

true if the class constant is private, otherwise false

in ReflectionClassConstant at line 167
bool isProtected()

Since: 7.1

Checks if class constant is protected

Return Value

bool

true if the class constant is protected, otherwise false

in ReflectionClassConstant at line 178
bool isPublic()

Since: 7.1

Checks if class constant is public

Return Value

bool

true if the class constant is public, otherwise false

in ReflectionClassConstant at line 189
string __toString()

Since: 7.1

Returns the string representation of the ReflectionClassConstant object.

Return Value

string

Returns string representation of the object that implements this interface (and/or "__toString" magic method).

in ReflectionClassConstant at line 206
array getAttributes(string|null $name = null, int $flags = 0)

Since: 8.0

Gets Attributes

Returns all attributes declared on this class constant as an array of ReflectionAttribute.

Parameters

string|null $name

Name of an attribute class
int $flags

Сriteria by which the attribute is searched.

Return Value

array

Array of attributes, as a ReflectionAttribute object.

in ReflectionClassConstant at line 233
bool isEnumCase()

Checks if class constant is an Enum case

Checks if the class constant is an Enum case.

Return Value

bool

true if the class constant is an Enum case; false otherwise.

in ReflectionClassConstant at line 245
bool isFinal()

Since: 8.1

Checks if class constant is final

Checks if the class constant is final.

Return Value

bool

true if the class constant is final, otherwise false

in ReflectionClassConstant at line 255
bool hasType()

Since: 8.3

Checks if class constant has a type

Checks if the class constant has a type associated with it.

Return Value

bool

in ReflectionClassConstant at line 265
ReflectionType|null getType()

Since: 8.3

Gets a class constant's type

Gets the associated type of a class constant.

Return Value

ReflectionType|null

in ReflectionClassConstant at line 275
bool isDeprecated()

Since: 8.4

Checks if deprecated

Checks whether the class constant is deprecated.

Return Value

bool

in ReflectionEnumUnitCase at line 37
ReflectionEnum getEnum()

Gets the reflection of the enum of this case

Return Value

ReflectionEnum

A ReflectionEnum instance describing the Enum this case belongs to.

at line 26
int|string getBackingValue()

Gets the scalar value backing this Enum case

Return Value

int|string

The scalar equivalent of this enum case.