https://github.com/rahimi-ali/php-dto
DTOs for PHP
https://github.com/rahimi-ali/php-dto
backend foundation php
Last synced: 8 months ago
JSON representation
DTOs for PHP
- Host: GitHub
- URL: https://github.com/rahimi-ali/php-dto
- Owner: rahimi-ali
- License: mit
- Created: 2023-02-13T21:05:16.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-31T04:31:42.000Z (over 2 years ago)
- Last Synced: 2025-10-11T14:08:24.288Z (8 months ago)
- Topics: backend, foundation, php
- Language: PHP
- Homepage:
- Size: 71.3 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP-DTO
## DTOs for PHP!
DTOs can be used to transform Incoming Psr7 server requests, json and random arrays to typed classes with validation built in.
Does not use reflection and handles everything with good old classes and methods!
### Install
```sh
composer require rahimi-ali/php-dto
```
### Types
- `int(bool $strict = false): IntType`
- `float(bool $strict = false): FloatType`
- `string(bool $strict = false): StringType`
- `bool(bool $strict = false): BoolType`
- `datetime(string $format = DateTimeInterface::ATOM, string|null $timezone = null, bool $immutable = true): DateTimeType`
- `embedded(string $class): EmbeddedType`
- `dynamicEmbedded(string|Closure $discriminator, array $types = []): DynamicEmbeddedType`
- `collection(TypeInterface $type): CollectionType`
### Rules
- `int(bool $strict = false): IntRule` Automatically added when declaring a field with IntType
- `float(bool $strict = false): FloatRule` Automatically added when declaring a field with FloatType
- `string(bool $strict = false): StringRule` Automatically added when declaring a field with StringType
- `bool(bool $strict = false): BoolRule` Automatically added when declaring a field with BoolType
- `array(): ArrayRule` Should be an array with sequential int keys
- `object(): ObjectRule` Should be an object or an array with string keys or non-sequential int keys
- `min(int $min, bool $strict = false): MinRule`
- `max(int $max, bool $strict = false): MaxRule`
- `minLength(int $length, bool $strict = false): MinLengthRule`
- `maxLength(int $length, bool $strict = false): MaxLengthRule`
- `in(array $values, bool $strict = false): InRule`
- `notIn(array $values, bool $strict = false): NotInRule`
- `equals(mixed $value, bool $strict = false): EqualsRule`
- `notEqual(mixed $value, bool $strict = false): NotEqual`
### Example
```php
class AddressDto extends Dto
{
private string $city;
private string $street;
private int $number;
public static function fields(array $data): array
{
return [
'city' => new Field('city', Type::string(true), rules: [Rule::in(['London', 'Paris', 'New York'])]),
'street' => new Field('street', Type::string(true), rules: [Rule::min(5)]),
'number' => new Field('number', Type::int(true), rules: [Rule::min(1), Rule::max(100)]),
];
}
public function getCity(): string
{
return $this->city;
}
public function getStreet(): string
{
return $this->street;
}
public function getNumber(): int
{
return $this->number;
}
}
class UserDto extends Dto
{
private string $name;
private int $age;
private AddressDto $address;
public static function fields(array $data): array
{
return [
'name' => new Field('name', Type::string(true), rules: [Rule::min(5)]),
'age' => new Field('age', Type::int(true), rules: [Rule::min(18)]),
'address' => new Field('address', Type::embedded(AddressDto::class)),
];
}
public function getName(): string
{
return $this->name;
}
public function getAge(): int
{
return $this->age;
}
public function getAddress(): AddressDto
{
return $this->address;
}
}
```
### Notes
- Because reflection and magic methods were not used private and readonly properties
cannot be used because the parent class cannot access them by default. If you really want private and readonly
properties, override the `setProperty` method in you DTO:
```php
protected function setProperty(string $property, mixed $value): void
{
$this->{$property} = $value;
}
```
### Standards
- Code Coverage: 100%
- PHPStan Level: 9
- Infection MSI: 94%
### License
MIT