irealworlds/laravel-attribute-requests

There is no license information available for the latest version (v0.0.2) of this package.

v0.0.2 2023-06-29 20:18 UTC

Requires

• illuminate/contracts: ^10
• illuminate/http: ^10
• illuminate/support: ^10
• illuminate/validation: ^10

Requires (Dev)

• mockery/mockery: ^1.6
• orchestra/testbench: ^8.5
• pestphp/pest: ^2.8
• pestphp/pest-plugin-faker: ^2.0

Unknown License

• Marin Calin

README

About

The Laravel Attribute Requests Package simplifies the process of handling and validating incoming requests by introducing the concept of Data Transfer Objects (DTOs). With this package, you can define request DTOs using attributes, making it easier to validate and process the input.

Instead of working directly with arrays and magic strings when consuming and validating requests, you can define dedicated DTO classes for each specific request, encapsulating all the required input fields and validation rules related to that request. This approach helps improve the maintainability, readability, and testability of your codebase, while also easing development by helping IDEs provide useful hints while you develop.

This way, you can leverage the power of PHP's type hinting to enforce the type of each attribute, preventing potential type-related errors. Moreover, you can apply validation expressively, using PHP attributes with Laravel's built-in and custom validation rules.

Installation

You can add this package through composer, using the require command:

composer require irealworlds/laravel-attribute-requests

If you want to modify the configuration file, you can first publish it using the vendor:publish command:

php artisan vendor:publish --tag=configuration --provider=AttributeRequestServiceProvider

Example Usage

Defining requests is as simple as creating a class and decorating its properties for validation. For example:

use Ireal\AttributeRequests\Http\Request;

class PostStoreRequest extends Request
{
    public string $title;
    public string|null $body;
}

And then consuming it:

public function store(PostStoreRequest $request)
{
    $post = Post::query()->create([
        'title' => $request->title, // IDE knows exactly what type of variable $request->title is here
        'body' => $request->body
    ]);
}

While the usage is similar to what you could do in Laravel by default, there are certain advantages to this approach. For example:

• Strong Typing: Leverage the power of PHP's type hinting to enforce the type of each attribute, preventing potential type-related errors.
• Automatic Validation: The package automatically validates incoming requests based on the defined DTO rules, reducing the need for manual validation code. More on validation
• Compatibility: The package is designed to work seamlessly with Laravel, leveraging its features and conventions.
• IDE hinting: Using this type of writing requests helps IDEs know what type of properties you are expecting, allowing them to help you when developing and enabling refactoring to be that much easier.

Documentation

You can read the full documentation on the package's wiki page.