HydrateAs
Specifies the class to use when hydrating a property, overriding the declared type hint.
This attribute is useful when the property's declared type is too generic (object, array, mixed, or a union like Interface|Other)
and a specific class should be instantiated during hydration.
Used by the Reflection::hydrate() method to enforce the correct target class when creating nested objects or arrays of objects.
-
example
-
Hydrate a property typed as object
class UserDTO
{
public string $name;
}
class Wrapper
{
#[HydrateAs(UserDTO::class)]
public object $payload;
}
$data = ['payload' => ['name' => 'Alice']];
$wrapper = (new Reflection())->hydrate($data, Wrapper::class);
echo $wrapper->payload->name; // "Alice"
-
example
-
Hydrate a nullable property with union types
class Address
{
public string $city;
}
class User
{
#[HydrateAs(Address::class)]
public Address|null $address;
}
$data = ['address' => ['city' => 'Paris']];
$user = (new Reflection())->hydrate($data, User::class);
echo $user->address->city; // "Paris"
-
example
-
ydrate an array of objects
class Tag
{
public string $label;
}
class Post
{
#[HydrateAs(Tag::class)]
public array $tags;
}
$data = ['tags' => [['label' => 'PHP'], ['label' => 'Reflections']]];
$post = (new Reflection())->hydrate($data, Post::class);
echo $post->tags[1]->label; // "Reflections"
Hydrate a mixed property
class Meta {
public string $type;
}
class Envelope
{
#[HydrateAs(Meta::class)]
public mixed $meta;
}
-
author
-
-
since
-
1.0.0
-
#[Attribute]
-
\Attribute::TARGET_PROPERTY
Table of Contents
Properties
-
$class
: string
Methods
-
__construct()
: mixed
$class
public
string
$class
__construct()
public
__construct(string $class) : mixed
Parameters
-
$class
: string
-
