Class

TRex\Core\Enum

abstract class Enum extends Object implements IEnum

Enum represents a value in a possible list.

This ensures having a value among the constants of your class and prevents any other value.

Methods

__construct(mixed $value)

Constructor.

mixed __get(string $propertyName)

See PHP doc.

from Object
mixed __set(string $propertyName, mixed $value)

See PHP doc.

from Object
mixed __call(string $methodName, array $args)

See PHP doc.

from Object
boolean isDynamic()

Indicates whether the current object has dynamic properties access.

from Object
setDynamic(boolean $isDynamic)

Sets dynamic properties access.

from Object
addMethod(string $name, Closure $method)

Adds a dynamic method to the object.

from Object
array toArray()

Converts an object to an array.

from Object
Json toJson(int $options = JSON_PRETTY_PRINT)

Converts an object to a Json object.

from Object
string __toString()

See PHP doc.

from Object
array getConstList()

Returns the list of the possible values.

mixed getValue()

Returns the current value.

bool is(mixed $expectedValue)

Indicates whether the current value is $expectedValue.

Details

at line 26
public __construct(mixed $value)

Constructor.

$data is initial data to set in the object. Keys are property names, and values are initial property values. $data could be a JSON string, an array or an array castable object.

Parameters

mixed $value

in Object at line 58
public mixed __get(string $propertyName)

See PHP doc.

Parameters

string $propertyName

Return Value

mixed

Exceptions

RuntimeException

in Object at line 78
public mixed __set(string $propertyName, mixed $value)

See PHP doc.

Parameters

string $propertyName
mixed $value

Return Value

mixed

Exceptions

RuntimeException

in Object at line 101
public mixed __call(string $methodName, array $args)

See PHP doc.

Call dynamically a method added with self::addMethod(). After having added a method, it is possible to call it like a declared method $object->newMethod($arg)

Parameters

string $methodName
array $args

Return Value

mixed

Exceptions

RuntimeException

in Object at line 116
public boolean isDynamic()

Indicates whether the current object has dynamic properties access.

Return Value

boolean

in Object at line 126
public setDynamic(boolean $isDynamic)

Sets dynamic properties access.

Parameters

boolean $isDynamic

in Object at line 137
public addMethod(string $name, Closure $method)

Adds a dynamic method to the object.

Parameters

string $name
Closure $method

in Object at line 147
public array toArray()

Converts an object to an array.

The exported array contains all property values of the class and its parents, which are not transient.

Return Value

array

in Object at line 157
public Json toJson(int $options = JSON_PRETTY_PRINT)

Converts an object to a Json object.

The exported data contains all property values ofn the class and its parents, who are not transient.

Parameters

int $options

Return Value

Json

in Object at line 170
public string __toString()

See PHP doc.

Return Value

string

at line 39
public array getConstList()

Returns the list of the possible values.

Return Value

array

at line 50
public mixed getValue()

Returns the current value.

Return Value

mixed

at line 61
public bool is(mixed $expectedValue)

Indicates whether the current value is $expectedValue.

Parameters

mixed $expectedValue

Return Value

bool