Laravel CRUD Tools: Provides components to build CRUD interfaces

Recommend this page to a friend!
  Info   View files Documentation   View files View files (13)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2020-10-07 (1 month ago) RSS 2.0 feedNot yet rated by the usersTotal: 94 All time: 9,494 This week: 235Up
Version License PHP version Categories
crud-tools 0.0.16MIT/X Consortium ...7.1PHP 5, Libraries
Description Author

This package provides components to build CRUD interfaces.

It provides trait to use in a controller class that comes with regular functions to implement CRUD operations like create new records, list records, edit records and delete records.

The package also comes with traits to implement CRUD action logging and storage access functions like validating record data and searching for records based on criteria.

Picture of Thiago Przyczynski
  Performance   Level  
Name: Thiago Przyczynski <contact>
Classes: 8 packages by
Country: Brazil Brazil
Age: 31
All time rank: 3653287 in Brazil Brazil
Week rank: 509 Up25 in Brazil Brazil Up
Innovation award
Innovation award
Nominee: 3x

 

Details

Laravel Crud Tools

Easy to use Laravel CRUD package with Controller, Model and Log system built in.

Table of contents

Installation

Install through composer using: `composer install thiagoprz\crud-tools`

Publish Crud Tools service provider (optional if you won't use CRUD Generators):

` php artisan vendor:publish --provider="Thiagoprz\CrudTools\CrudToolsServiceProvider"`

Usage

CRUD Controller:

A CRUD Controller can be achieve by just creating a standard controller class using ControllerCrud trait.

The next step is to create a folder inside `resources/views` with the desired namespace or on root folder if the controller won't be using a specific namespace (admin on the example).

<?php

namespace App\Http\Controllers\Admin;

use App\Models\User;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use Thiagoprz\CrudTools\Http\Controllers\ControllerCrud;

class UserController extends Controller
{
    use ControllerCrud;
    public $modelClass = User::class;
}

Views directory structure used by Controller CRUD based on the above example:

Folder: > views/admin/user

Files: > create.blade.php

> edit.blade.php

Available vars: $model (the model being updated)

> form.blade.php

Available vars: $model (the model being updated - only on edit action)

> index.blade.php

Available vars: $items (the pagination object containing a filtered collection of the model)

> show.blade.php

Available vars: $model (the model being displayed)

CRUD Model:

For models you just need to add the trait ModelCrud and after that create a static property declaring model's validations (based on the create, update and/or delete scenarios), default order, filtering rules, upload file rules, define resources, and with / countable relationships.

  • Validations:
    <?php
    ...
    use Thiagoprz\CrudTools\Models\ModelCrud;
    class User extends Authenticatable
    {
    use ModelCrud;
    
    /
     * Model validations
     *
     * @var array
     */
    static $validations = [
        'create' => [
            'name' => ['required', 'string', 'max:255'],
            'email' => ['required', 'string', 'email', 'max:255', 'unique:users'],
            'password' => ['required', 'string', 'min:8', 'confirmed'],
        ],
        'update' => [
            'name' => ['required', 'string', 'max:255'],
            'email' => ['required', 'string', 'email', 'max:255', 'unique:users'],
            'password' => ['required', 'string', 'min:8', 'confirmed'],
        ],
    ];
    ...
    }
    
  • Searchable fields:

You can create a $searchable property that will hold fields allowed to be searched on the static method search() - very useful with the ControllerCrud.

<?php
...
use Thiagoprz\CrudTools\Models\ModelCrud;
class User extends Authenticatable
{
    use ModelCrud;
    /
     * Fields that can be searched by (static)method search()
     *
     * @var array
     */
    static $searchable = [
        'id' => 'int',
        'name' => 'string',
        'created_at' => 'datetime',
    ];
    ...
}

Types available: int, string, date, datetime and decimal.

You can use input filters using "_from" and "_to" suffix on date, datetime and decimal fields:

<!-- Filtering created_at usig field "from" ( where created_at >= $created_at_from ) -->
<label>Period from: </label>
<input type="date" name="created_at_from">

<!-- Filtering created_at usig field "to" ( where created_at <= $created_at_to ) -->
<label>To:</label>
<input type="date" name="created_at_to">

  • Sortable fields:

You can defined the fields that will be used as default sorting of your model on the index action. Also, you can pass an "order" input used by the search method allowing the override the default order defined by this variable.

<?php
...
use Thiagoprz\CrudTools\Models\ModelCrud;
class Books extends Model
{
    use ModelCrud;
    /
     * Default order
     *
     * @var array
     */
    static $search_order = [
        'title' => 'ASC',
        'updated_at' => 'DESC',
        'created_at' => 'DESC',
    ];
    ...
}

  • Upload fields:

You can create a fileUploads method to define which and where your uploadable fields will store the files:

<?php
...
use Thiagoprz\CrudTools\Models\ModelCrud;
class User extends Authenticatable
{
    use ModelCrud;
    ...
    /
     * @param Campaign $model
     * @return array
     */
    public static function fileUploads(Campaign $model)
    {
        return [
            'FIELD_NAME' => [
                'path' => 'FOLDER', // Mandatory
                'name' => 'FILE_NAME', // (OPTIONAL)if not provided will be the file original name 
            ],
        ];
    }
    ...
}

CRUD Generators

Controller Generator:

You can create a standard Controller to work with a model by using the following command:


> NAMESPACE1: Controller's namespace
>
> NAMEController: is the name of the controller
>
> NAMESPACE2: Model's namespace
>
> Model: Name of the model

### Model Generator:
To easily create a model with all Crud Tools enabled use:

php artisan make:model-crud NAMESPACE/Model

> NAMESPACE: Model's namespace
> Model: Name of the model

- Available options
  - --fillable: comma separated fields for fillable attributes
  - --searchable: comma separated fields for searchable attributes (based on search() method)
  - --primaryKey: field or comma separated fields that are the table's primary key
  - --softDeletes: if passed enables SoftDeletes trait on class
  - --uploads: if passed adds fileUploads() method on class 

## Enable Logs
To enable automatic logs on your models you need to publish Spatie Activity Logger migrations:

``php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="migrations"``

Run migrations:

``php artisan migrate``

For more information you can read Spatie Activity Log Documentations.


## Support

### Supported By Jetbrains
This project is being developed with the help of Jetbrains through its project to support Open Source software.

Test Image 1

### Buy me a Coffee
ko-fi
buy-coffee

  Files folder image Files  
File Role Description
Files folder imagesrc (1 file, 5 directories)
Files folder imagesupport (1 file)
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file License.txt Doc. Documentation
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  src  
File Role Description
Files folder imageCommands (2 files)
Files folder imageconfig (1 file)
Files folder imageHttp (1 directory)
Files folder imageModels (2 files)
Files folder imagestubs (2 files)
  Plain text file CrudToolsServiceProvider.php Class Class source

  Files folder image Files  /  src  /  Commands  
File Role Description
  Plain text file MakeCrudController.php Class Class source
  Plain text file MakeCrudModel.php Class Class source

  Files folder image Files  /  src  /  config  
File Role Description
  Accessible without login Plain text file crud-tools.php Aux. Auxiliary script

  Files folder image Files  /  src  /  Http  
File Role Description
Files folder imageControllers (1 file)

  Files folder image Files  /  src  /  Http  /  Controllers  
File Role Description
  Plain text file ControllerCrud.php Class Class source

  Files folder image Files  /  src  /  Models  
File Role Description
  Plain text file Logable.php Class Class source
  Plain text file ModelCrud.php Class Class source

  Files folder image Files  /  src  /  stubs  
File Role Description
  Plain text file Controller.stub Class Class source
  Plain text file Model.stub Class Class source

  Files folder image Files  /  support  
File Role Description
  Accessible without login Plain text file jetbrains.svg Data Auxiliary data

 Version Control Unique User Downloads Download Rankings  
 100%
Total:94
This week:0
All time:9,494
This week:235Up

For more information send a message to info at phpclasses dot org.