Download the PHP package jamielsharief/data-transfer-object without Composer
On this page you can find all versions of the php package jamielsharief/data-transfer-object. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jamielsharief/data-transfer-object
More information about jamielsharief/data-transfer-object
Files in jamielsharief/data-transfer-object
Package data-transfer-object
Short Description Data Transfer Object (DTO)
License MIT
Informations about the package data-transfer-object
Data Transfer Object (DTO)
Create
To create a DataTransferObject
create the class and use public properties.
Then to set the data
You can also mass set the properties using an array when constructing the argument. Note this only sets, does not convert or extract, see fromArray
Build
When you use the DataTransferObject
constructor, it simply sets the values that you are providing, however when you need to convert data and cast types, you can use the fromArray
method.
The fromArray
extracts relevant data and it:
- casts built in types bool, int, string, float etc
- will create a
DataTransferObject
,DateTime
or any other object that has a__set_state
magic method.
It will only extract fields defined in the DataTransferObject
and will only throw an error, if after extracting data, a property on the DataTransferObject
was not initialized.
For example, related DataTransferObjects
such as belongsTo
and hasMany
will be marshalled. For hasMany
to work create an array and set the DocBlock definition like below:
To use the fromArray
method
Converting to an Array
To convert the DataTransferObject
and any nested objects to an array if the object has an toArray
method or does not have a __toString
method.
Serialization / Deserialization
The default serialization method is JSON, for a different method, e.g. XML you can override the serialize
and deserialize
methods. Only public properties will be used in the serialization and therefore deserialization process.
To string
To convert a DataTransferObject
to a string.
From string
To convert a string to a DataTransferObject
Initialize Hook
When the DataTransferObject
is constructed it will call initialize
method if it is available, this is a hook incase
you need to override the constructor.
Exception Handling
If you try to set or get a property that does not exist, a RuntimeException
will be thrown.