ReflectionEnumUnitCase

Since: 8.1

class ReflectionEnumUnitCase extends ReflectionClassConstant (View source)

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 ReflectionEnumUnitCase object

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

No description

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

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)

No description

from  ReflectionClassConstant
bool
isEnumCase()

Checks if class constant is an Enum case

from  ReflectionClassConstant
bool
isFinal()

No description

from  ReflectionClassConstant
bool
hasType()

No description

from  ReflectionClassConstant
ReflectionType|null
getType()

No description

from  ReflectionClassConstant
bool
isDeprecated()

No description

from  ReflectionClassConstant
ReflectionEnum
getEnum()

No description

Details

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

Instantiates a ReflectionEnumUnitCase 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 85
static string|null export(string|object $class, string $name, bool $return = false)

Since: 7.1

No description

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 95
ReflectionClass getDeclaringClass()

Since: 7.1

Gets declaring class

Return Value

ReflectionClass

in ReflectionClassConstant at line 106
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 118
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 129
string getName()

Since: 7.1

Get name of the constant

Return Value

string

Returns the constant's name.

at line 27
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 151
bool isPrivate()

Since: 7.1

Checks if class constant is private

Return Value

bool

in ReflectionClassConstant at line 162
bool isProtected()

Since: 7.1

Checks if class constant is protected

Return Value

bool

in ReflectionClassConstant at line 173
bool isPublic()

Since: 7.1

Checks if class constant is public

Return Value

bool

in ReflectionClassConstant at line 184
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 196
array getAttributes(string|null $name = null, int $flags = 0)

Since: 8.0

No description

Parameters

string|null $name

Name of an attribute class
int $flags

Сriteria by which the attribute is searched.

Return Value

array

in ReflectionClassConstant at line 223
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 230
bool isFinal()

Since: 8.1

No description

Return Value

bool

in ReflectionClassConstant at line 235
bool hasType()

Since: 8.3

No description

Return Value

bool

in ReflectionClassConstant at line 240
ReflectionType|null getType()

Since: 8.3

No description

Return Value

ReflectionType|null

in ReflectionClassConstant at line 245
bool isDeprecated()

Since: 8.4

No description

Return Value

bool

at line 33
ReflectionEnum getEnum()

No description

Return Value

ReflectionEnum