README

This package is a bit inspired by https://github.com/spatie/laravel-route-attributes and some codes are even copied.

Why this package

Laravel application tends to have too much controllers which does not do much. Same all five request, index, create, show, edit and destroy. For each controller, we would have five functions, five requests to validate those requests too. This seems redundant. For anything to add, I would have to add atleast one route, one controller and one request.

Rather than that, we could simply have one route that would accept anything, which would call a file that would authorize, validate and process a request.

So, this package was invented.

No more controllers(If you need one, let me know why). No more adding routes, just dive through requests.

One route to rule them all.

Installation

You can install the package via composer:

composer require summonshr/requests

Usage

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Summonshr\Requests\Contracts\UniversalRequestInterface;

class CreateApplication extends FormRequest implements UniversalRequestInterface
{
    // To call on specific method
    const REQUEST_METHOD = 'GET';

    // To call on specific action
    const ACTION = 'create_application';

    /**
     * Determine if the user is authorized to make this request.
     */
    public function authorize(): bool
    {
        return true;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array<string, \Illuminate\Contracts\Validation\ValidationRule|array|string>
     */
    public function rules(): array
    {
        return [
            //
        ];
    }

    public function process()
    {
        // Process your requests here
    }
}

When making request, send a parameter 'action' in each request on universal route.

{
    "action": "create_application",
    // Rest of the parameters
}

Package is smart enough to find out method and action on its own too.

    'store' => 'POST',
    'create' => 'POST',
    'edit' => 'PUT',
    'destroy' => 'DELETE',
    'show' => 'GET',

Any request class starting with store, create, edit, destroy, show will automatically have POST, POST, PUT, DELETE, SHOW by default. You can change those by publishing config files too.

Action is resolved as kebab case of the request class names if not specified in ACTION constant.

For example, CreateUserRequest would have action 'create-user-request' as action by default.

If you have nested folder inside Requests such as User/Create.php, then action would be 'user-create' and so on.

A default handler has been registered like this which can be changed through config files.

 Route::any('/resource', function (UniversalRequestInterface $request) {
    return $request->process();
});

Or simply register one route yourself with UniversalRequestInterface as the parameter. It will resolve automatically.

When not to use: When you have your own philosophy about how a laravel application structure should be.

I will be building around this a lot.

The application will automatically call the Request specified as per in Requests directory.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email summonshr@gmail.com instead of using the issue tracker.

summonshr / requests

Maintainers

Details