Class

TRex\Serialization\ObjectToArrayCaster

class ObjectToArrayCaster extends Object implements ICaster

ObjectToArrayCaster converts object to array.

Constants

RECURSION_VALUE

Value of casted recursion.

Methods

__construct(mixed $data = null)

Constructor.

from Object
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 cast(object $object)

Converts.

setExplicitRecursion(boolean $isExplicitRecursion)

Sets the visibility of recursive value.

boolean isExplicitRecursion()

Indicates whether recursive value are visible.

setFilter(int $filter)

Sets the filter.

int getFilter()

Gets the filter.

setFullName(boolean $isFullName)

Sets the returned keys type.

boolean isFullName()

Indicates whether the returned keys will contain the class name before the property name.

setRecursive(boolean $isRecursive)

Sets whether the recursion is active.

boolean isRecursive()

Indicates whether the recursion is active.

Details

in Object at line 42
public __construct(mixed $data = null)

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 $data

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 75
public array cast(object $object)

Converts.

Parameters

object $object

Return Value

array

at line 86
public setExplicitRecursion(boolean $isExplicitRecursion)

Sets the visibility of recursive value.

Parameters

boolean $isExplicitRecursion

at line 96
public boolean isExplicitRecursion()

Indicates whether recursive value are visible.

Return Value

boolean

at line 106
public setFilter(int $filter)

Sets the filter.

Parameters

int $filter

at line 116
public int getFilter()

Gets the filter.

Return Value

int

at line 126
public setFullName(boolean $isFullName)

Sets the returned keys type.

Parameters

boolean $isFullName

at line 136
public boolean isFullName()

Indicates whether the returned keys will contain the class name before the property name.

Return Value

boolean

at line 146
public setRecursive(boolean $isRecursive)

Sets whether the recursion is active.

Parameters

boolean $isRecursive

at line 156
public boolean isRecursive()

Indicates whether the recursion is active.

Return Value

boolean