README

Laravel-Entity-Generator - This generator is used to create a standard class stack for a new entity.

Installation

Install package using dev mode

composer require ronasit/laravel-entity-generator --dev

Publish package's resources.

php artisan vendor:publish --provider="RonasIT\EntityGenerator\EntityGeneratorServiceProvider"

Usage

Entity generation

Call make:entity artisan command to run the generation command for the full stack of the entity classes:

php artisan make:entity Post

Entity name may contain the subfolder, in this case generated model and nova resource will be placed to the subfolder as well:

php artisan make:entity Forum/Blog/Post

Fields definition options

The make:entity provides an ability to set the entity's fields, which will be used in all created classes (e.g. Model, Create/Update requests, Test fixtures, etc.)

php artisan make:entity Post -s title -s text -t published_at

The following field types are available to use:

Fields modifiers

To set a special behavior for the field use the modifiers syntax. Modifiers may be passed using a : symbol in the field definition. Multiple modifiers can be combined with a comma.

php artisan make:entity Post -s title:required,unique -s text -t published_at:required

Each modifier has full and short syntax. The list of available modifiers defined in the table:

Reserved field names

The following field names are reserved and cannot be passed as input fields because they are managed automatically by Laravel and the generator:

Relations definitions options

Command also provides an ability to set relations, which will be added to the model

php artisan make:entity Post -A Comment -A Reaction

Relation may be placed in the subfolder, in this case - set the relative namespace from the model directory:

php artisan make:entity Post -A Blog/Comment -A Forum/Common/Reaction

The following options are available to set relations:

Single class generation mode options

Command allows to generate only single entity-related class

php artisan make:entity Post --only-tests

The following options are available:

• --only-model
• --only-repository
• --only-service
• --only-controller
• --only-requests
• --only-migration
• --only-factory
• --only-tests
• --only-seeder
• --only-resource
• --only-nova-tests

Mode combination options

Sometimes you need to generate the stack of classes to work with some entity only inside the application without the ability to manipulate it using API, or you need to create only API for already existed entity.

For this task, there are two mutually exclusive options:

1. --only-entity, generate stack of classes to work with entity only inside the app, it includes:

• migration
• model
• service
• repository

1. --only-api, generate stack of classes to implement API part to work with already existed entity:

• routes
• controller
• requests
• resources
• tests

Methods setting options

By default, the command generate all methods from the CRUD stack which includes:

• create
• update
• delete
• search
• get by id

But what if we need to create the interface only for updating and reading the entity? Just use the methods option for it:

php artisan make:entity Post --methods=RU

Feel free to use any combinations of actions in any order. Each action has its own character:

• C create
• U update
• D delete
• R read (search and get by id)

Special class-related options

• --nova-resource-name - Specifies the Nova resource name for the Nova tests generation. By default script will try to find the common resource class based on the entity name.

Release notes

1.3

Since 1.3 version you need to add to your config/entity-generator.php following data:

    'paths' => [
        ... // your old data
        'database_seeder' => 'database/seeds/DatabaseSeeder.php',
        'translations' => 'lang/en/validation.php'
    ],
    'stubs' => [
        ... // your old data
        'empty_factory' => 'entity-generator::empty_factory',
        'translation_not_found' => 'entity-generator::translation_not_found',
        'validation' => 'entity-generator::validation',
        'seeder' => 'entity-generator::seeder',
        'database_empty_seeder' => 'entity-generator::database_empty_seeder'
    ]