README

Validate against an object's constructor

Your validation rules often belong in your domain model. Use the InstantiateRule to bring those rules into your Laravel validation.

class FormRequest 
{
    public function rules()
    {
        return [
            'email' => ['required', new InstantiateRule(EmailAddress::class)]
        ];
    }
}

Installation

You can install the package via composer:

composer require morrislaptop/laravel-instantiate-rule

Usage

As a simple rule

class FormRequest 
{
    public function rules()
    {
        return [
            'email' => ['required', new InstantiateRule(EmailAddress::class)]
        ];
    }
}

For complex objects, it's assumed array keys match the constructor object or are in the order of the constructor.

class Address
{
    public function __construct(
        private string $line1, 
        private string $postcode, 
        private string $country) {
    }
}

$this->jsonPost('/users', ['address' => [
    'line1' => '123 Fake St',
    'postcode' => '90210',
    'country' => 'Australia',
]]);

class FormRequest 
{
    public function rules()
    {
        return [
            'address' => ['required', new InstantiateRule(Address::class)]
        ];
    }
}

Or you can specify a custom static contructor if you like...

class FormRequest 
{
    public function rules()
    {
        return [
            'address' => ['required', new InstantiateRule(Address::class, 'createForValidation')]
        ];
    }
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

morrislaptop / laravel-instantiate-rule

Maintainers

Details