Downloads
Stars
Version
This is a Laravel >=5.5 package to help easily create CRUD (Create, Read, Update, Delete) forms for eloquent models (as well as an index page). It aims to be used as a quick tool which does not interfere with the other parts of the application that it's used in.
The package provides:
The views are built using bootstrap (v3), but the styling can easily be overriden.
From the command line, run:
composer require achillesp/laravel-crud-forms
This package uses a config file which you can override by publishing it to your app's config dir.
php artisan vendor:publish --provider=Achillesp\CrudForms\CrudFormsServiceProvider --tag=config
To use the package, you need to use the trait Achillesp\CrudForms\CrudForms
in your model's controller and define your routes.
The trait provides all the required methods for a Resource Controller, as well as a restore method in case of soft-deleted models.
If for example you have a Post
model, you would define the routes:
Route::resource('/posts', 'PostController');
Then in your PostController
, you will need to use the trait and also define a constructor where you give the needed details of the model.
use App\Post;
use Achillesp\CrudForms\CrudForms;
class PostController extends Controller
{
use CrudForms;
public function __construct(Post $post)
{
$this->model = $post;
}
}
In the controller's constructor you can define the properties which are handled by the controller. The available properties that can be defined are as follows.
This is the model, which should be passed in the constructor through Dependency Injection.
This is an array of all the fields you need in the forms. Each field is declared as an array that has:
name
: This is the model's attribute name, as it is in the database.label
: This is the field's label in the forms.type
: The type of the form input field that will be used. Accepted types are:
relationship
: This is needed in case of a select, select_multiple, radio or checkbox_multiple buttons.
You can state here the name of the relationship as it is defined in the model.
In the example bellow, the Post
model has a belongsTo
relationship to category
and a belongsToMany
relationship to tags
.
For belongsTo
relationships you can use a select or a radio(group of radios) input.
For belongsToMany
relationships you can use a select_multiple or checkbox_multiple inputs.relFieldName
: This is optional. It is used only in case we have a relationship, to set the name of the attribute of the related model that is displayed (ie. in a select's options).
If not defined, the default attribute to be used is name
.$this->formFields = [
['name' => 'title', 'label' => 'Title', 'type' => 'text'],
['name' => 'slug', 'label' => 'Slug', 'type' => 'text'],
['name' => 'body', 'label' => 'Enter your content here', 'type' => 'textarea'],
['name' => 'publish_on', 'label' => 'Publish Date', 'type' => 'date'],
['name' => 'published', 'label' => 'Published', 'type' => 'checkbox'],
['name' => 'category_id', 'label' => 'Category', 'type' => 'select', 'relationship' => 'category'],
['name' => 'tags', 'label' => 'Tags', 'type' => 'select_multiple', 'relationship' => 'tags'],
];
indexFields
arrayThese are the model's attributes that are displayed in the index page.
$this->indexFields = ['title', 'category_id', 'published'];
If not defined, then the first of the formFields
is shown.
formTitle
(optional)You can optionally, define the name of the model as we want it to appear in the views. If not defined, the name of the model will be used.
bladeLayout
(optional)This is used to define the blade layout file that will be extended by the views for the crud forms and index page.
withTrashed
)Setting this to true, will also display deleted models and offer an option to restore them.
$this->withTrashed = true;
In order to be able to restore the models, you need to define an additional route:
Route::put('/posts/{post}/restore', ['as' => 'posts.restore', 'uses' => 'PostController@restore']);
validationRules
array (optional)These are the rules we want to use to validate data before saving the model.
$this->validationRules = [
'title' => 'required|max:255',
'slug' => 'required|max:100',
'body' => 'required',
'publish_on' => 'date',
'published' => 'boolean',
'category_id' => 'required|int',
];
validationMessages
array (optional)Use this to define custom messages for validation errors. For example:
$this->validationMessages = [
'body.required' => "You need to fill in the post content."
];
validationAttributes
array (optional)Use this to change the way an attribute's name should appear in validation error messages.
$this->validationAttributes = [
'title' => 'Post title'
];
The views are built with bootstrap v.3 and also have css classes to support some common JavaScript libraries.
It is also possible to publish the views, so you can change them anyway you need. To publish them, use the following artisan command:
php artisan vendor:publish --provider=Achillesp\CrudForms\CrudFormsServiceProvider --tag=views
The MIT License (MIT). Please see License File for more information.