class ReflectionArray extends AbstractReflectionValue

The array value reflector

Traits

Basic implementation of the \Reflector::export() method
This trait defines magic getters and setters for read-only object's properties

Methods

static  string|null
export( mixed $argument, bool $return = false)

Creation of a new instance of the mother class on-the-fly

void
setReadOnlyProperties( array $data)

Defines the read-only properties names and accessors.

mixed
__get( string $name)

Magic getter for read-only properties.

void
__set( string $name, mixed $value)

Magic setter to avoid setting read-only properties.

void
__unset( string $name)

Magic un-setter to avoid un-setting read-only properties.

__construct( mixed $value, int $flag = ValueType::MODE_STRICT)

No description

string
__toString()

Representation of the object

mixed
getValue()

Returns the current value

string
getValueType()

Returns the type of the value

array
getArray()

Returns the full array itself

array
getKeys()

Returns the keys of the array

array
getValues()

Returns the values of the array

int
getLength()

Returns the length of the array

bool
hasKey( string|int $index)

Test if a key exists in the array

mixed
getItem( string|int $index)

Get a specific item of the array

Details

in ReflectorTrait at line 54
static string|null export( mixed $argument, bool $return = false)

Creation of a new instance of the mother class on-the-fly

Keep in mind that this method only consider the FIRST argument passed to transmit to the constructor. If your mother class requires more than one argument, you will have to over-write this method (or to not use the trait).

Parameters

mixed $argument
bool $return

Return Value

string|null

Exceptions

ErrorException if the mother class does not implement the \Reflector interface
ErrorException if the mother class constructor is not callable

void setReadOnlyProperties( array $data)

Defines the read-only properties names and accessors.

Each key => value pair of the $data array must be constructed like:

  • key is the name of the property (MUST be defined with protected access in the child class)
  • value is an accessor for that property: the name of the access method if it exists or true for the default $obj->$key accessor.

Parameters

array $data This is the table of read-only properties

Return Value

void

Exceptions

InvalidArgumentException if the $data array is malformed

mixed __get( string $name)

Magic getter for read-only properties.

This will trigger a notice if the property can not be accessed.

Parameters

string $name

Return Value

mixed

void __set( string $name, mixed $value)

Magic setter to avoid setting read-only properties.

Parameters

string $name
mixed $value

Return Value

void

Exceptions

ReflectionException if trying to set a read-only property

void __unset( string $name)

Magic un-setter to avoid un-setting read-only properties.

Parameters

string $name

Return Value

void

Exceptions

ReflectionException if trying to unset a read-only property

at line 54
__construct( mixed $value, int $flag = ValueType::MODE_STRICT)

Parameters

mixed $value
int $flag A flag used by the ValueType::getType() method

Exceptions

ReflectionException if the parameter is not an array

at line 138
string __toString()

Representation of the object

If an exception is caught, its message is returned instead of the original result (but it is not thrown ahead).

Return Value

string

mixed getValue()

Returns the current value

Return Value

mixed

string getValueType()

Returns the type of the value

Return Value

string

at line 72
array getArray()

Returns the full array itself

Return Value

array

at line 82
array getKeys()

Returns the keys of the array

Return Value

array

at line 92
array getValues()

Returns the values of the array

Return Value

array

at line 102
int getLength()

Returns the length of the array

Return Value

int

at line 113
bool hasKey( string|int $index)

Test if a key exists in the array

Parameters

string|int $index

Return Value

bool

at line 124
mixed getItem( string|int $index)

Get a specific item of the array

Parameters

string|int $index

Return Value

mixed