juanchosl/datatransfer

A small, lightweight utility to read values and properties from distinct sources using the same methodology

1.0.6 2024-06-19 22:59 UTC

Requires

• php: ^7.1 || ^8.0
• juanchosl/exceptions: ^1.0

Requires (Dev)

• phpstan/phpstan: 1.9.1
• phpunit/phpunit: 9.5.25

MIT

• Juan Sánchez Lecegui

• json
• array
• object
• entity
• values

README

Description

A small, lightweight utility to read values and properties from distinct sources using the same methodology

Install

composer require juanchosl/datatransfer

How use it

Load composer autoload and use it

Data Transfer Objects

Using the provided Factory

$dto = JuanchoSL\DataTransfer\Factories\DataTransferFactory::create($element);

The $element parameter can be:

• array indexed or associtive
• object
• json encoded object or array
• SimpleXMLElement object
• XML string
• primitive value

Using a specific repository

Alternative you can use the distincts repositories

$dto = new JuanchoSL\DataTransfer\Repositories\{SOURCE_READER}($element)

The $element parameter needs to be the required type for the selected repo Is more efective use a magic factory in order to avoid know the type of the original data, and you can change it with no need to adapt your existing code.

The resultant $dto variable is a recursive data transfer object, iterable, countable, clonable and json serializable

Use data

$dto = DataTransferFactory::create(['key' => 'value']);
echo $dto->has('key'); //true
echo $dto->get('key'); //value
echo $dto->key; //value
echo $dto->has('other_key'); //false
$dto->other_key = 'other_value';// alias for $dto->set('other_key','other_value')
echo $dto->has('other_key'); //true
echo $dto->other_key; //other_value

TODO

When we need to use a CSV contents to transform to a DTO, we need to use the CsvDataTransfer, today is not possible detect it as distinct of string or array

Data Converters

You can convert any DataTransferObject to a standar format, as array, json, xml, stdClass

Using the provided Factory

$json = JuanchoSL\DataTransfer\Factories\DataConverterFactory::asJson($dto);

Using a specific converter

Alternative you can use the distincts converters

$result = new JuanchoSL\DataTransfer\Converters\{SOURCE_CONVERTER}($dto)

The available converters are:

• ArrayConverter
• CsvConverter
• JsonConverter
• ObjectConverter
• XmlConverter
• XmlObjectConverter