Download the PHP package wkasunsampath/laravel-autocrud without Composer

Laravel Autocrud - Automate CRUD operations in Laravel applications.

When Laravel apps are developed, developers have to write CRUD operations for several models. Some of them are just regular CRUD operations without any special logic. This package is to automate these CRUD operations. Therefore, developers can save most of their development time.

To create a fully working CRUD for User model, just run below command,

All you have to do is that. :) Now your Laravel app have below routes registered. To see routes, run php artisan route:list.

Seems interesting? :D Ok!, let's continue.

Installation

You can install the package via composer: (Currently supports only for Laravel 8, 9 & 10)

You can publish assets and config with:

All done. Now you can see there is a autocrud.php file in config folder. Also, there is a new folder called Autocruds in \App\Http folder.

Usage

Let's assume that there is a model called Office at \App\Models\Company\Office.php. To create a fully working CRUD for that model, just run,

All done. Your CRUD is working now. Not sure? Ok!, just run php artisan route:list.

NOTE: It is recommanded to maintain the same structure inside Autocruds folder as inside models folder.

Let's go deeper.

Docs

• Autocrud Classes
• Configuration
• Folder Structure
• Index Route
• View Route
• Create Route
• Update Route
• Delete Route
• Best Practices

Autocrud Classes

Autocrud classes are the files generated when runs php artisan autocrud:create {class_name}. Normally, these files are stored in \App\Http\Autocruds folder.

Autocruds classes extend the BaseCrud class. Most important setting of this class is protected string $model. You can bind the model which you need to create CRUD here. It is recommanded to use the model name as the Autocrud class name.

You can set protected bool $isApi to false if particular CRUD is related to a Laravel Web App. Also, If protected bool $isApi is set to true, all CRUD routes will be prefixed with "api/".

Inside public function commonMiddlewares(), you can define middlewares which are applied to all CRUD routes.

All autocrud classes must be registered in Autocruds.php file inside App\Http\Autocruds folder. However, this process is done automatically when you run autocrud:create command.

Configuration

Autocrud config file contains some useful configuration options for your app. Normally, this file is getting published when you run php artisan autocrud:install command.

Folder Structure

It is recommended to follow below convention when using autocrud library.

As you may have noticed, creating five different files for CRUD in views folder is little bit abnormal and most of the time it is not neccessary. (This will applicable only in web apps.) When you are creating autocrud classes for a web app, there will be functions to override this behaviour.

There is an easy way to create Model, Controller, Policy, Request, Resources, Migrations & Observers with the Autocrud class by passing some options to the artisan command.

1. --m: Model
2. --mg: Migration
3. --c: Controller
4. --p: Policy
5. --req: Form Request
6. --r: Resource
7. --o: Observer
8. --s: Seeder

This command will create files according to the above folder structure.

Index Route

There are several useful methods related to index route which you can override inside the autocrud class.

1. public function indexMiddlewares(): array: You can add index route specific middlewares here.

2. public function afterIndexPage(): string: View to redirect after index operation in web apps, (Not available in APIs.)

3. public function makeIndexRoute(): bool: If this is set to false, index route will not be available for that particular model.

4. public function indexMethod(): string: Method for that specific index route. Default is "GET".

5. public function indexEagerLoad(): array: If you need to eager load any relationship data with index, add those relationships here.

6. public function beforeIndex(Builder $query): Builder: If you need to modify index query, you may do it here. (Don't include ->get())

7. public function afterIndex(Collection $data): JsonResponse | ResourceCollection | View: Modify fetched index data before send back to the user.

View Route

There are several useful methods related to view route which you can override inside the autocrud class.

1. public function viewMiddlewares(): array: You can add view route specific middlewares here.

2. public function afterViewPage(): string: View to redirect after view operation in web apps, (Not available in APIs.)

3. public function makeViewRoute(): bool: If this is set to false, view route will not be available for that particular model.

4. public function viewMethod(): string: Method for that specific view route. Default is “GET”.

5. public function viewEagerLoad(): array: If you need to eager load any relationship data with view, add those relationships here.

6. public function beforeView(Builder $query): Builder: If you need to modify view query, you may do it here. (Don’t include ->get())

7. public function afterView(Model $model): JsonResponse | JsonResource | View: Modify fetched view data before send back to the user.

Create Route

There are several useful methods related to create route which you can override inside the autocrud class.

NOTE: Form data variable names must be equal to the DB column names.

1. public function createMiddlewares(): array: You can add create route specific middlewares here.

2. public function afterCreatePage(): string: View to redirect after create operation in web apps, (Not available in APIs.)

3. public function makeCreateRoute(): bool: If this is set to false, create route will not be available for that particular model.

4. public function createMethod(): string: Method for that specific create route. Default is “POST”.

5. public function createRequest(): string|null: Here you can set the name of form request class. Normally, autocrud will get the form request class automatically when you are following the convention in folder structure section. Otherwise you can specifically give that class here. You can skip form request validation by returning null.

6. public function beforeCreate(array $data): array: You can change data before save in the DB here.

7. public function afterCreate(Model $model): JsonResponse | JsonResource | View: Modify created data before send back to the user.

Update Route

There are several useful methods related to update route which you can override inside the autocrud class.

NOTE: Form data variable names must be equal to the DB column names.

1. public function updateMiddlewares(): array: You can add update route specific middlewares here.

2. public function afterUpdatePage(): string: View to redirect after update operation in web apps, (Not available in APIs.)

3. public function makeUpdateRoute(): bool: If this is set to false, update route will not be available for that particular model.

4. public function updateMethod(): string: Method for that specific update route. Default is “PUT”.

5. public function updateRequest(): string|null: Here you can set the name of form request class. Normally, autocrud will get the form request class automatically when you are following the convention in folder structure section. Otherwise you can specifically give that class here. You can skip form request validation by returning null.

6. public function beforeUpdate(array $data): array: You can change data before save in the DB here.

7. public function afterUpdate(Model $model): JsonResponse | JsonResource | View: Modify created data before send back to the user.

Delete Route

There are several useful methods related to delete route which you can override inside the autocrud class.

1. public function deleteMiddlewares(): array: You can add delete route specific middlewares here.

2. php public function afterDeletePage(): string: View to redirect after delete operation in web apps, (Not available in APIs.)

3. public function makeDeleteRoute(): bool: If this is set to false, delete route will not be available for that particular model.

4. public function deleteMethod(): string: Method for that specific create route. Default is “DELETE”.

5. public function beforeDelete(Model $model): void: Do stuff before delete the model.

6. public function afterDelete(): JsonResponse | View: Do stuff before sending response to user.

Best Practices

1. Follow the forlder structure as much as possible. So, you have not to override any function.
2. It is not needed to create Form Request classes, Response classes and Policies for each. Autocrud will use them if they are available. Otherwise it will proceed according to normal Laravel way. But, it is recommanded to user Requests, Responses and Policies as much as possible to avoid security risks.
3. To auto discover the Requests, Responses and Policies by the Autocrud, they should have followed the forlder structure conventions.
4. For create & update requests, incoming form data variable names must be equal to the corresponding DB column name. Otherwise, it will not be identified by the Autocrud.
5. This package is not a total replacement for routes. Still you will have to use typical Laravel routes and controllers when you are performing some complex actions. This package is just a helper package to speed up your development by automating normal CRUD operations.

Changelog

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

License

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