README

Validated DTO for Laravel

Data Transfer Objects with validation for Laravel applications

Installation

You can install the package via composer:

composer require wendelladriel/laravel-validated-dto

You can publish the config file with:

php artisan vendor:publish --tag="validated-dto"

Usage

Create a DTO by extending ValidatedDTO, declaring typed properties, and defining the validation rules for incoming data:

use Illuminate\Validation\Rules\Password;
use WendellAdriel\ValidatedDTO\Casting\BooleanCast;
use WendellAdriel\ValidatedDTO\Casting\StringCast;
use WendellAdriel\ValidatedDTO\ValidatedDTO;

final class UserDTO extends ValidatedDTO
{
    public string $name;

    public string $email;

    public string $password;

    public bool $active;

    protected function rules(): array
    {
        return [
            'name' => ['required', 'string'],
            'email' => ['required', 'email'],
            'password' => ['required', Password::min(8)],
            'active' => ['sometimes', 'boolean'],
        ];
    }

    protected function defaults(): array
    {
        return [
            'active' => true,
        ];
    }

    protected function casts(): array
    {
        return [
            'name' => new StringCast(),
            'email' => new StringCast(),
            'password' => new StringCast(),
            'active' => new BooleanCast(),
        ];
    }
}

Create an instance from an array, request, JSON string, Eloquent model, or artisan command:

$dto = UserDTO::fromArray([
    'name' => 'John Doe',
    'email' => 'john.doe@example.com',
    'password' => 's3CreT!@1a2B',
]);

$dto->name; // John Doe
$dto->toArray();

You can also inject a DTO into a controller action and let the service container resolve it from the current request:

use Illuminate\Http\JsonResponse;

final class StoreUserController
{
    public function __invoke(UserDTO $dto): JsonResponse
    {
        return response()->json($dto->toArray());
    }
}

Access the full documentation here.

Changelog

Please see the changelog for more information on what has changed recently.

Contributing

Thank you for considering contributing to Validated DTO for Laravel! You can read the contribution guide here.

Security Vulnerabilities

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

Credits

License

Validated DTO for Laravel is open-sourced software licensed under the MIT license.

wendelladriel / laravel-validated-dto

Maintainers

Package info

Fund package maintenance!

Statistics

Security