README

A strongly typed Data Transfer Object without magic for PHP 8.0+ . Features support for PHP 8 union types and attributes.

Installation
Usage
Validation table

Installation

composer require bssphp/dto

For PHP 7.4 please use 1.x
For PHP 8.0 please use 2.x

Usage

use bssphp\dto\AbstractData;
use bssphp\dto\Attributes\Required;

class DummyData extends AbstractData
{
    #[Required]
    public string $name;

    public ?string $nickname;

    public string|int $height;

    public DateTime $birthday;

    public bool $subscribeNewsletter = false;
}

$data = new DummyData([
    'name' => 'Roman',
    'height' => 180,
]);

Require properties

When declaring required properties, the dto will validate all parameters against the declared properties. Take a look at the validation table for more details.

use bssphp\dto\AbstractData;
use bssphp\dto\Attributes\Required;

class DummyData extends AbstractData
{
    #[Required]
    public string $name;
}

$data = new DummyData([]);

bssphp\dto\Exceptions\InvalidDataException: The required property `name` is missing

Array methods

Simple array representation

To get an array representation of the dto, simply call the toArray instance method.

When transferring the dto properties to an array format, the package will respect and call any toArray methods of nested dto instances or otherwise fall back to any declared jsonSerialize method when implementing the JsonSerializable interface.

use bssphp\dto\AbstractData;

class DummyData extends AbstractData
{
    public string $firstName;

    public DummyData $childData;
    
    /** @var self[] */
    public array $children = [];
}

$data = new DummyData([
    'firstName' => 'Roman',
    'childData' => new DummyData([
        'firstName' => 'Tim',
     ]),
    'children' => [
        new DummyData([
            'firstName' => 'Tom'
        ]),
    ],
]);

$data->toArray();
// [
//    'firstName' => 'Roman',
//    'childData' => ['firstName' => 'Tim']
//    'children' => [
//        ['firstName' => 'Tom']
//    ] 
// ];

Convert keys

The toArrayConverted method allows the simple conversion of property keys to a given case.

use bssphp\dto\AbstractData;
use bssphp\dto\Cases;

class DummyData extends AbstractData
{
    public string $firstName;
}

$data = new DummyData([
    'firstName' => 'Roman',
]);

$data->toArrayConverted(Cases\CamelCase::class);  // ['firstName' => 'Roman'];
$data->toArrayConverted(Cases\KebabCase::class);  // ['first-name' => 'Roman'];
$data->toArrayConverted(Cases\PascalCase::class); // ['FirstName' => 'Roman'];
$data->toArrayConverted(Cases\SnakeCase::class);  // ['first_name' => 'Roman'];

Flexible dtos

When attaching the Flexible attribute you can provide more parameters than declared in the dto instance. All properties will also be included in the toArray methods. This would otherwise throw an InvalidDataException.

use bssphp\dto\AbstractData;
use bssphp\dto\Attributes\Flexible;

#[Flexible]
class DummyData extends AbstractData
{
    public string $name;
}

$data = new DummyData([
    'name' => 'Roman',
    'website' => 'ich.wtf',
]);

$data->toArray(); // ['name' => 'Roman', 'website' => 'ich.wtf];

Validation

* Attributes with default values cannot be required.

Testing

./vendor/bin/phpunit

Credits

Roman Zipp

This package has been inspired by Spaties Data-Transfer-Object released under the MIT License.

bssphp / dto

Maintainers

Details