laravel-models-generator

KO | EN

gitlite — search

#php #python #nodejs #api #testing #javascript #golang #ruby #docker #mobile #form #package

laravel-models-generator

★ 56 Open GitHub ↗

Generate Laravel models from existing database

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Generate Laravel models from an existing database

[![Latest Version on Packagist](https://img.shields.io/packagist/v/giacomomasseron/laravel-models-generator.svg?style=flat-square)](https://packagist.org/packages/giacomomasseron/laravel-models-generator)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/giacomomasseron/laravel-models-generator/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/giacomomasseron/laravel-models-generator/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/giacomomasseron/laravel-models-generator/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/giacomomasseron/laravel-models-generator/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/giacomomasseron/laravel-models-generator.svg?style=flat-square)](https://packagist.org/packages/giacomomasseron/laravel-models-generator)

Compatible with Laravel 9/10/11/12/13.

Major features:  
- PHPStan level 9/10 compliant
- Laravel 11/12/13 style (using new models attributes)
- Polymorphic relationships
- Uuids / Ulids columns
- Enums casting
- URI casting
- JSON casting

## Drivers supported

- MariaDB
- MySQL
- SQLite
- PostgreSQL
- SQLServer

Coming soon ... all drivers supported by doctrine/dbal.

## Installation

You can install the package via composer:

```bash
composer require giacomomasseron/laravel-models-generator
```

## Usage / Generate models

For basic usage, you can generate models with the command:

```bash
php artisan laravel-models-generator:generate
```

## Factories

The package can generate factories for your models.  
The factories will be created in `database/factories` directory, and they use standard Laravel `fake` functions to fill fields.

You can generate model factories with the command:

```shell
php artisan laravel-models-generator:generate -f
```
or
```shell
php artisan laravel-models-generator:generate --factories
```

## Other usages

To generate models from a specific connection:

```shell
php artisan laravel-models-generator:generate -c=connection
```

To generate models from a specific schema:

```shell
php artisan laravel-models-generator:generate -s=schema
```

To generate a single table:

```shell
php artisan laravel-models-generator:generate -t=users
```

## Config

You can publish the config file with:

```bash
php artisan vendor:publish --tag="models-generator-config"
```

This is the contents of the published config file:

```php
return [
    'clean_models_directory_before_generation' => true,

'generate_views' => false,

/*
    |--------------------------------------------------------------------------
    | Strict types
    |--------------------------------------------------------------------------
    |
    | Add declare(strict_types=1); to the top of each generated model file
    |
    */
    'strict_types' => true,

/*
    |--------------------------------------------------------------------------
    | Models $table property
    |--------------------------------------------------------------------------
    |
    | Add $table model property
    |
    */
    'table' => true,

/*
    |--------------------------------------------------------------------------
    | Models $connection property
    |--------------------------------------------------------------------------
    |
    | Add $connection model property
    |
    */
    'connection' => true,

/*'phpdocs' => [
        'scopes' => true,
    ],*/

/*
    |--------------------------------------------------------------------------
    | Models $primaryKey property
    |--------------------------------------------------------------------------
    |
    | Add $primaryKey model property
    |
    */
    'primary_key' => true,

/*
    |--------------------------------------------------------------------------
    | Primary Key in Fillable
    |--------------------------------------------------------------------------
    |
    | Add primary key column field to fillable array
    |
    */
    'primary_key_in_fillable' => true,
    
    /*
    |--------------------------------------------------------------------------
    | Timestamps customized fields
    |--------------------------------------------------------------------------
    |
    | Change the default Laravel timestamps fields.
    | Ex. created_at => 'created_at',
    |     updated_at => 'updated_at'
    |
    */
    'timestamps' => [
        'fields' => [
            'created_at' => null,
            'updated_at' => null,
        ],
        'format' => null,
    ],

/*
    |--------------------------------------------------------------------------
    | Models path
    |--------------------------------------------------------------------------
    |
    | Where the models will be created
    |
    */
    'path' => app_path('Models'),

/*
    |--------------------------------------------------------------------------
    | Namespace
    |--------------------------------------------------------------------------
    |
    | The namespace of the generated models
    |
    */
    'namespace' => 'App\Models',

/*
    |--------------------------------------------------------------------------
    | Parent
    |--------------------------------------------------------------------------
    |
    | The parent class of the generated models
    |
    */
    'parent' => Illuminate\Database\Eloquent\Model::class,

/*
    |--------------------------------------------------------------------------
    | Base files
    |--------------------------------------------------------------------------
    |
    | If you want to generate a base file for each model, you can enable this.
    | The base file will be created within 'Base' directory inside the models' directory.
    | If you want your base files be abstract you can enable it.
    |
    */
    'base_files' => [
        'enabled' => false,
        'abstract' => true,
        'generate_children_classes' => true,
    ],

/*
    |--------------------------------------------------------------------------
    | Table prefix
    |--------------------------------------------------------------------------
    |
    | Remove table prefix value from laravel model name
    |
    */
    'table_prefix' => '',

/*
    |--------------------------------------------------------------------------
    | Add comments in PHPDocs
    |--------------------------------------------------------------------------
    |
    | Add comments to PHPDocs column property (Ex. @property int $id (comment))
    |
    */
    'add_comments_in_phpdocs' => true,
    
    /*
    |--------------------------------------------------------------------------
    | Relationships name case type
    |--------------------------------------------------------------------------
    |
    | Define the way relation name are created.
    | Possible values: "camel_case", "snake_case"
    |
    */
    'relationships_name_case_type' => RelationshipsNameCaseTypeEnum::CAMEL_CASE,

/*
    |--------------------------------------------------------------------------
    | Polymorphic relationships
    |--------------------------------------------------------------------------
    |
    | Define polymorphic relationships
    | 
    | [
    |       'table_name' => 'polymorphic_type',
    | 
    |       ex. for official laravel documentation
    |       'posts' => 'commentable',
    | ]
    |
    */
    'morphs' => [
    ],

/*
    |--------------------------------------------------------------------------
    | Interfaces
    |--------------------------------------------------------------------------
    |
    | Interface(s) implemented by all models
    |
    */
    'interfaces' => [
    ],

/*
    |--------------------------------------------------------------------------
    | Traits
    |--------------------------------------------------------------------------
    |
    | Trait(s) implemented by all models
    |
    */
    'traits' => [
    ],

/*
    |--------------------------------------------------------------------------
    | Table Traits
    |--------------------------------------------------------------------------
    |
    | Trait(s) implemented by specific models.
    | Ex.
    |   'table' => TraitClass::class|[TraitClass::class],
    |
    */
    'table_traits' => [
    ],

/*
    |--------------------------------------------------------------------------
    | Enums
    |--------------------------------------------------------------------------
    |
    | Enum(s) implemented by all models
    | Ex.
    |   'column' => EnumClass::class,
    |
    */
    'enums_casting' => [
    ],

/*
    |--------------------------------------------------------------------------
    | URI casting
    |--------------------------------------------------------------------------
    |
    | Columns that has to be cast as URI.
    | Ex.
    |   'table1' => [
    |       'column1',
    |       'column2',
    |   ],
    |   'table2' => [
    |       'column3',
    |       'column4',
    |   ],
    |
    */
    'uri_casting' => [
    ],

/*
    |--------------------------------------------------------------------------
    | JSON casting
    |--------------------------------------------------------------------------
    |
    | Columns that has to be cast as JSON.
    | Ex.
    |   'table1' => [
    |       'json_column1' => ['json_key1', 'json_key2'],
    |       'json_column2' => ['json_keyA', 'json_keyB'],
    |   ],
    |   'table2' => [
    |       'json_column3' => ['json_keyX', 'json_keyY'],
    |       'json_column4' => ['json_keyM', 'json_keyN'],
    |   ],
    |
    */
    'json_casting' => [
    ],

/*
    |--------------------------------------------------------------------------
    | Global scopes
    |--------------------------------------------------------------------------
    |
    | Global scope(s) applied to specific models.
    | Ex.
    |   'table1' => [
    |       GlobalScopeClass::class',
    |   ],
    |   'table2' => [
    |       GlobalScopeClass1::class,
    |       GlobalScopeClass2::class,
    |   ],
    |
    */
    'global_scopes' => [
    ],

/*
    |--------------------------------------------------------------------------
    | Uuids
    |--------------------------------------------------------------------------
    |
    | If you want to use UUIDs in your models, you can define them here.
    | Ex.
    |   'table' => ['column1', 'column2'],
    |
    */
    'uuids' => [
    ],

/*
    |--------------------------------------------------------------------------
    | Ulids
    |--------------------------------------------------------------------------
    |
    | If you want to use Ulids in your models, you can define them here.
    | Ex.
    |   ['table1', 'table2'],
    |
    */
    'ulids' => [
    ],

/*
    |--------------------------------------------------------------------------
    | Observers
    |--------------------------------------------------------------------------
    |
    | Observer(s) implemented by specific models.
    | Ex.
    |   'table' => ObserverClass::class,
    |
    */
    'observers' => [
    ],

/*
    |--------------------------------------------------------------------------
    | Query Builders (Laravel 12.19+)
    |--------------------------------------------------------------------------
    |
    | Query builder(s) implemented by specific models.
    | Ex.
    |   'table' => QueryBuilder::class,
    |
    */
    'query_builders' => [
    ],

/*
    |--------------------------------------------------------------------------
    | Excluded Tables
    |--------------------------------------------------------------------------
    |
    | These models will not be generated
    |
    */
    'except' => [
        'migrations',
        'failed_jobs',
        'password_resets',
        'personal_access_tokens',
        'password_reset_tokens',
    ],

/*
    |--------------------------------------------------------------------------
    | Excluded Columns
    |--------------------------------------------------------------------------
    |
    | These columns will not be added to $fillable array.
    |
    | You can use a string or any valid pattern for preg_match function.
    | Ex. '/your_pattern/'
    |     '/your_pattern/i' (case-insensitive)
    |     'column_not_to_generate'
    |
    */
    'exclude_columns' => [
    ],

/*
    |--------------------------------------------------------------------------
    | Excluded Factories
    |--------------------------------------------------------------------------
    |
    | These factories will not be generated.
    |
    */
    'exclude_factories' => [
        'users',
        'jobs',
        'job_batches',
        'failed_jobs',
    ],

/*
    |--------------------------------------------------------------------------
    | Excluded Relationships
    |--------------------------------------------------------------------------
    |
    | These relationships will not be added to Model class.
    | Ex.
    |   'table_of_starting_relationship' => [
    |       'table_of_relationship',
    |   ],
    |
    */
    'exclude_relationships' => [
    ],
];
```

## Polymorphic relationships

To add polymorphic relationships to your models, you can use `morphs` array in the config file.  
If you have tables like this:

```
posts
id - integer
name - string

users
id - integer
name - string

images
id - integer
url - string
imageable_id - integer
imageable_type - string
```
And config file like this:

```php
'morphs' => [
    'posts' => 'imageable'
],
```

This relationship will be created in the `Image` model:

```php
public function imageable(): MorphTo
{
    return $this->morphTo(__FUNCTION__, 'imageable_type', 'imageable_id');
}
```

This relationship will be created in the `Post` model:

```php
public function images(): MorphMany
{
    return $this->morphMany(Image::class, 'images');
}
```

## Interfaces

If you want your models implement interface(s), use `interfaces` value in config:

```php
'interfaces' => [
],
```

## Traits

If you want your models use trait(s), use `traits` value in config:

```php
'traits' => [
],
```

## Testing

```bash
composer test
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Giacomo Masseroni](https://github.com/giacomomasseron)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

laravel-models-generator

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README