Download the PHP package amirimatin/eloquent-model-generator without Composer

Eloquent Model Generator

Eloquent Model Generator is a tool based on Code Generator for generating Eloquent models.

Installation

Step 1. Add Eloquent Model Generator to your project:

Step 2. Register GeneratorServiceProvider:

If you are using Laravel version 5.5 or higher this step can be omitted since this project supports Package Discovery feature.

Step 3. Configure your database connection.

Usage

Use

to generate a model class. Generator will look for table with name users and generate a model for it.

table-name

Use table-name option to specify another table name:

In this case generated model will contain protected $table = 'user' property.

output-path

Generated file will be saved into app directory of your application and have App namespace by default. If you want to change the destination and namespace, supply the output-path and namespace options respectively:

output-path can be absolute path or relative to project's app directory. Absolute path must start with /:

• /var/www/html/app/Models - absolute path
• Models - relative path, will be transformed to /var/www/html/app/Models (assuming your project app directory is /var/www/html/app)

base-class-name

By default generated class will be extended from Illuminate\Database\Eloquent\Model. To change the base class specify base-class-name option:

backup

Save existing model before generating a new one

If User.php file already exist, it will be renamed into User.php~ first and saved at the same directory. After than a new User.php will be generated.

Other options

There are several useful options for defining several model's properties:

• no-timestamps - adds public $timestamps = false; property to the model
• date-format - specifies dateFormat property of the model
• connection - specifies connection name property of the model

Overriding default options globally

Instead of spcifying options each time when executing the command you can create a config file named eloquent_model_generator.php at project's config directory with your own default values. Generator already contains its own config file at Resources/config.php with following options:

You can override them by defining model_defaults array at eloquent_model_generator.php:

Registring custom database types

If running a command leads to an error

it means that you must register your type <ANY_TYPE> with Doctrine.

For instance, you are going to register enum type and want Doctrine to treat it as string (You can find all existing Doctrine's types here). Add next lines at your config/eloquent_model_generator.php:

Usage example

Table user:

Command:

Result: