Attributes API

Complete API reference for attributes.

Validation Attributes

Required

#[Required]
public readonly string $name;

Email

#[Email]
public readonly string $email;

Min / Max

#[Min(3), Max(50)]
public readonly string $name;

Between

#[Between(18, 65)]
public readonly int $age;

In / NotIn

#[In(['active', 'inactive'])]
public readonly string $status;

Unique / Exists

#[Unique('users', 'email')]
public readonly string $email;

#[Exists('users', 'id')]
public readonly int $userId;

Conditional Attributes

WhenAuth / WhenGuest

#[WhenAuth]
public readonly ?string $privateData = null;

#[WhenGuest]
public readonly ?string $publicData = null;

WhenCan

#[WhenCan('edit')]
public readonly ?string $editUrl = null;

WhenRole

#[WhenRole('admin')]
public readonly ?string $adminNotes = null;

WhenValue

#[WhenValue('status', 'published')]
public readonly ?Carbon $publishedAt = null;

Cast Attribute

Cast

#[Cast(DateTimeCast::class)]
public readonly Carbon $createdAt;

#[Cast(IntCast::class)]
public readonly int $age;

Mapping Attributes

MapFrom

#[MapFrom('user.full_name')]
public readonly string $name;

MapTo

#[MapTo('user.full_name')]
public readonly string $name;

Visibility Attributes

Hidden

#[Hidden]
public readonly string $password;

Visible

#[Visible(['admin', 'owner'])]
public readonly string $secret;

Other Attributes

Lazy

#[Lazy]
public readonly ?array $posts = null;

Computed

#[Computed]
public function fullName(): string
{
    return "{$this->firstName} {$this->lastName}";
}

See Also

• Attributes Overview - Complete overview
• Validation Attributes - Validation guide
• Conditional Attributes - Conditional guide
• Casting Attributes - Casting guide