tirjok/crud

CRUD generator package for laravel.

0.1.2 2017-01-29 09:38 UTC

This package is not auto-updated.

Last update: 2024-09-28 19:31:18 UTC


README

A CRUD generator for enterprise application.

Inspired by appzcoder/crud-generator

Requirements

Laravel >=5.1
PHP >= 5.5.9

Installation

  1. Run

    composer require tirjok/crud
    
  2. Add the service provider to config/app.php.

    'providers' => [
        ...
    
        Tirjok\CrudGenerator\CrudGeneratorServiceProvider::class,
    ],
  3. Install laravelcollective/html helper package.

    • 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="Tirjok\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 --namespace=Admin --route-group=admin

Options:

Other commands (optional):

For controller:

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

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

For service:

php artisan crud:service PostService --model-name=Post --namespace=admin

For repository:

php artisan crud:repository PostRepository --model-name=Post --filters=title#like --namespace=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="Tirjok\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.