nutgram / hydrator
Hydrator for PHP 8.0+
Installs: 67 660
Dependents: 8
Suggesters: 0
Security: 0
Stars: 10
Watchers: 2
Forks: 1
Open Issues: 0
Requires
- php: ^8.1
- psr/container: ^1.1 || ^2.0
Requires (Dev)
- illuminate/container: ^10.0
- phpunit/phpunit: ~9.5.0
README
Fork of the original project https://github.com/sunrise-php/hydrator.
Installation
composer require nutgram/hydrator
How to use?
use SergiX44\Hydrator\Hydrator; $hydrator = new Hydrator(); // create and hydrate an object with an array $data = [/* the class props here */]; $object = $hydrator->hydrate(SomeDto::class, $data); // hydrate an object with an array $data = [/* the class props here */]; $hydrator->hydrate($object, $data); // creates and hydrate an object with JSON $json = '{...}'; $object = $hydrator->hydrateWithJson(SomeDto::class, $json); // hydrate an object with JSON $json = '{...}'; $hydrator->hydrateWithJson($object, $json); // pass JSON decoding flags $options = JSON_OBJECT_AS_ARRAY|JSON_BIGINT_AS_STRING; $hydrator->hydrateWithJson($object, $json, $options);
Allowed property types
Required
If a property has no a default value, then the property is required.
public string $value;
Optional
If a property has a default value, then the property is optional.
public string $value = 'foo';
Null
If a property is nullable, then the property can accept null.
public ?string $value;
If the property should be optional, then it must has a default value.
public ?string $value = null;
Boolean
Accepts the following values: true, false, 1, 0, "1", "0", "yes", "no", "on" and "no".
public bool $value;
['value' => true]; ['value' => 'yes'];
Integer
Accepts only integers (also as a string).
public int $value;
['value' => 42]; ['value' => '42'];
Number<int|float>
Accepts only numbers (also as a string).
public float $value;
['value' => 42.0]; ['value' => '42.0'];
String
Accepts only strings.
public string $value;
['value' => 'foo'];
Array<array-key, mixed>
Accepts only arrays.
public array $value;
['value' => [1, 2, 'foo']];
Array<array-key, class>
Accept a list of objects.
final class SomeDto { public readonly string $value; }
use SergiX44\Hydrator\Annotation\ArrayType; #[ArrayType(SomeDto::class)] public array $value;
[ 'value' => [ [ 'value' => 'foo', ], [ 'value' => 'bar', ], ], ],
Object
Accepts only objects.
public object $value;
['value' => new stdClass];
DateTime/DateTimeImmutable
Integers (also as a string) will be handled as a timestamp, otherwise accepts only valid date-time strings.
public DateTimeImmutable $value;
// 2010-01-01 ['value' => 1262304000]; // 2010-01-01 ['value' => '1262304000']; // normal date ['value' => '2010-01-01'];
DateInterval
Accepts only valid date-interval strings based on ISO 8601.
public DateInterval $value;
['value' => 'P1Y']
Enum
Accepts only values that exist in an enum.
enum SomeEnum: int { case foo = 0; case bar = 1; }
public SomeEnum $value;
['value' => 0] ['value' => '1']
Association
Accepts a valid structure for an association
final class SomeDto { public string $value; }
public SomeDto $value;
[ 'value' => [ 'value' => 'foo', ], ]
Property alias
If you need to get a non-normalized key, use aliases.
For example, the Google Recaptcha API returns the following response:
{ "success": false, "error-codes": [] }
To correctly map the response, use the following model:
use SergiX44\Hydrator\Annotation\Alias; final class RecaptchaVerificationResult { public bool $success; #[Alias('error-codes')] public array $errorCodes = []; }
Examples
final class Product { public string $name; public Category $category; #[ArrayType(Tag::class)] public array $tags; public Status $status; } final class Category { public string $name; } final class Tag { public string $name; } enum Status: int { case ENABLED = 1; case DISABLED = 0; }
$product = $hydrator->hydrate(Product::class, [ 'name' => 'Stool', 'category' => [ 'name' => 'Furniture', ], 'tags' => [ [ 'name' => 'Wood', ], [ 'name' => 'Lacquered', ], ], 'status' => 0, ]);
Test run
composer test