.. Laravel Crud Tools documentation master file, created by sphinx-quickstart on Tue Sep 7 14:02:01 2021. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Laravel Crud Tools ============================================== .. toctree:: :maxdepth: 2 :caption: Contents: Easy to use Laravel CRUD package with Controller, Model and Log system built in. Table of contents ----------------- - `Installation <#installation>`__ - `Usage <#usage>`__ - `CRUD Controller <#crud-controller>`__ - `CRUD Model <#crud-model>`__ - `CRUD Generators <#crud-generators>`__ - `Controller Generator <#controller-generator>`__ - `Model Generator <#model-generator>`__ - `Enabling Logs <#enabling-logs>`__ - `Support <#support>`__ Installation ------------ Install through composer using: ``composer install thiagoprz\crud-tools`` If you don't have package auto discovery enabled add CrudToolsServiceProvider to your ``config/app.php``: :: ... 'providers' => [ ... \Thiagoprz\CrudTools\CrudToolsServiceProvider::class, ], ... Publish Crud Tools service provider to allow stubs customization: ``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). :: 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: :: [ '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. :: 'int', 'name' => 'string', 'created_at' => 'datetime', ]; ... } - Range searchable fields: Types available: int, string, date, datetime and decimal. You can use input filters using "*from" and "*\ to" suffix on date, datetime and decimal fields: :: +------------+--------------------------------------------------------------------------------------------------+-------------------------+ | Type | Description | Suffixes: *from *\ to | +============+==================================================================================================+=========================+ | int | Integer fields, can be used to search a range of records by using "*from" and "*\ to" suffixes | Yes | +------------+--------------------------------------------------------------------------------------------------+-------------------------+ | decimal | Float, Double, Real or any decimal type of field. "*from" and "*\ to" suffixes allowed | Yes | +------------+--------------------------------------------------------------------------------------------------+-------------------------+ | string | Any string field to be search using "WHERE field LIKE '%SEARCH%'" | No | +------------+--------------------------------------------------------------------------------------------------+-------------------------+ | string | Any string field to be search using "WHERE field = 'SEARCH'" | No | +------------+--------------------------------------------------------------------------------------------------+-------------------------+ | datetime | Datetime and Timestamp fields | Yes | +------------+--------------------------------------------------------------------------------------------------+-------------------------+ | date | Date fields | Yes | +------------+--------------------------------------------------------------------------------------------------+-------------------------+ - Custom searchable field methods: In addition to use standard search based on type of fields you can add your on custom methods to customize search of specific fields. Create a method called "**searchField**\ " where Field is the name of the field with only first letter upper case. Example: :: where('title', 'LIKE', "$title%"); } } - Sortable fields: You can define 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. :: '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: :: [ '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: ``php artisan make:crud-controller NAMESPACE1/NAMEController NAMESPACE2/Model`` 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:crud-model 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 - **--logable**: adds Logable trait on model Enabling 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 ------- Issues ~~~~~~ Please feel free to indicate any issues on this packages, it will help a lot. I will address it as soon as possible. Supported By Jetbrains ~~~~~~~~~~~~~~~~~~~~~~ This project is being developed with the help of `Jetbrains `__ through its project to support Open Source software. .. figure:: ../../support/jetbrains.svg :alt: Supported by Jetbrains Buy me a Coffee ~~~~~~~~~~~~~~~ |ko-fi| |buy-coffee| .. |ko-fi| image:: https://www.ko-fi.com/img/githubbutton_sm.svg :target: https://ko-fi.com/S6S4273NJ .. |buy-coffee| image:: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-1.svg :height: 36 :target: https://www.buymeacoffee.com/thiagoprz Indices and tables ================== * :ref:`search` * :ref:`genindex`