codeg8/crud-generator

Laravel 5 CRUD Generator

dev-master 2017-05-23 10:16 UTC

README

Requirements

Laravel >=5.1
PHP >= 5.5.9

Installation

Open your terminal(CLI), go to the root directory of your Laravel project, then follow the following procedure.

  1. Run

    composer require codeg8/crud-generator --dev
    
  2. Since the package is only use in local developmnet, add the provider in app/Providers/AppServiceProvider.php.

    
    public function register()
    {
        if ($this->app->environment() == 'local') {
            $this->app->register('Codeg8\CrudGenerator\CrudGeneratorServiceProvider');
        }
    }
  3. Install laravelcollective/html helper package if you haven't installed it already.

    • Run
    composer require laravelcollective/html
    
    • Add service provider & aliases to config/app.php.
    'providers' => [
        ...
    
        Collective\Html\HtmlServiceProvider::class,
    ],
    
    'aliases' => [
        ...
    
        'Form' => Collective\Html\FormFacade::class,
        'HTML' => Collective\Html\HtmlFacade::class,
    ],
  4. Run composer dump-autoload

  5. Publish vendor files of this package.

    php artisan vendor:publish --provider="Codeg8\CrudGenerator\CrudGeneratorServiceProvider"
    

Note: You should have configured database for this operation.

Commands

Crud command:

php artisan crud:generate Posts --fields="title#string; content#text; category#select#options=technology,tips,health" --view-path=admin --controller-namespace=Admin --route-group=admin

Crud fields from a JSON file:

{
    "fields": [
        {
            "name": "title",
            "type": "string"
        },
        {
            "name": "content",
            "type": "text"
        },
        {
            "name": "category",
            "type": "select",
            "options": ["technology", "tips", "health"]
        },
        {
            "name": "user_id",
            "type": "integer#unsigned"
        }
    ],
    "foreign_keys": [
        {
            "column": "user_id",
            "references": "id",
            "on": "users",
            "onDelete": "cascade"
        }
    ],
    "relationships": [
        {
            "name": "user",
            "type": "belongsTo",
            "class": "App\\User"
        }
    ],
    "validations": [
        {
            "field": "title",
            "rules": "required|max:10"
        }
    ]
}
php artisan crud:generate Posts --fields_from_file="/path/to/fields.json" --view-path=admin --controller-namespace=Admin --route-group=admin

Options:

Option Description
--fields Fields name for the form & migration. e.g. --fields="title#string; content#text; category#select#options=technology,tips,health; user_id#integer#unsigned"
--fields_from_file Fields from a JSON file. e.g. --fields_from_file="/path/to/fields.json"
--route Include Crud route to routes.php? yes or no
--pk The name of the primary key
--view-path The name of the view path
--controller-namespace The namespace of the controller - sub directories will be created
--model-namespace The namespace that the model will be placed in - directories will be created
--route-group Prefix of the route group
--pagination The amount of models per page for index pages
--indexes The fields to add an index to. append "#unique" to a field name to add a unique index. Create composite fields by separating fieldnames with a pipe (``` --indexes="title,field1
--foreign-keys Any foreign keys for the table. e.g. --foreign-keys="user_id#id#users#cascade" where user_id is the column name, id is the name of the field on the foreign table, users is the name of the foreign table, and cascade is the operation 'ON DELETE' together with 'ON UPDATE'
--validations Validation rules for the form "col_name#rules_set" e.g. ``` "title#min:10
--relationships The relationships for the model. e.g. --relationships="comments#hasMany#App\Comment" in the format
--localize Allow to localize. e.g. localize=yes
--locales Locales language type. e.g. locals=en

Other commands (optional):

For controller:

php artisan crud:controller PostsController --crud-name=posts --model-name=Post --view-path="directory" --route-group=admin

Controller's Options:

Option Description
--crud-name The name of the crud. e.g. --crud-name="post"
--model-name The name of the model. e.g. --model-name="Post"
--model-namespace The namespace of the model. e.g. --model-namespace="Custom\Namespace\Post"
--controller-namespace The namespace of the controller. e.g. --controller-namespace="Http\Controllers\Client"
--view-path The name of the view path
--fields Fields name for the form & migration. e.g. --fields="title#string; content#text; category#select#options=technology,tips,health; user_id#integer#unsigned"
--validations Validation rules for the form "col_name#rules_set" e.g. ``` "title#min:10
--route-group Prefix of the route group
--pagination The amount of models per page for index pages
--force Overwrite already existing controller.

For model:

php artisan crud:model Post --fillable="['title', 'body']"

For migration:

php artisan crud:migration posts --schema="title#string; body#text"

For view:

php artisan crud:view posts --fields="title#string; body#text" --view-path="directory" --route-group=admin

By default, the generator will attempt to append the crud route to your Route file. If you don't want the route added, you can use this option --route=no.

After creating all resources, run migrate command. If necessary, include the route for your crud as well.

php artisan migrate

If you chose not to add the crud route in automatically (see above), you will need to include the route manually.

Route::resource('posts', 'PostsController');

Supported Field Types

These fields are supported for migration and view's form:

Form Field Types:

  • text
  • textarea
  • password
  • email
  • number
  • date
  • datetime
  • time
  • radio
  • select
  • file

Migration Field Types:

  • string
  • char
  • varchar
  • date
  • datetime
  • time
  • timestamp
  • text
  • mediumtext
  • longtext
  • json
  • jsonb
  • binary
  • integer
  • bigint
  • mediumint
  • tinyint
  • smallint
  • boolean
  • decimal
  • double
  • float
  • enum

Custom Generator's Stub Template

You can customize the generator's stub files/templates to achieve your need.

  1. Make sure you've published package's assets.

    php artisan vendor:publish --provider="Codeg8\CrudGenerator\CrudGeneratorServiceProvider"
    
  2. Turn on custom_template support on config/crudgenerator.php

    'custom_template' => true,
    
  3. From the directory resources/crud-generator/ you can modify or customize the stub files.

  4. On config/crudgenerator.php you can add new stubs and choose which values are passed