tinymeng/laravel-generation-model

tinymeng Components for Laravel Framework code generation.

v1.0.0 2022-03-04 09:44 UTC

Requires

• php: ^7.3|^8.0
• doctrine/dbal: >=2.5
• illuminate/console: >=5.1
• illuminate/contracts: >=5.1
• illuminate/database: >=5.1
• illuminate/filesystem: >=5.1
• illuminate/support: >=5.1

Requires (Dev)

• fzaninotto/faker: ~1.4
• mockery/mockery: >=1.4
• phpunit/phpunit: ^9

MIT

• tinymeng

• laravel
• tinymeng

README

tinymeng Laravel Model Generator aims to speed up the development process of Laravel applications by providing some convenient code-generation capabilities. The tool inspects your database structure, including column names and foreign keys, in order to automatically generate Models that have correctly typed properties, along with any relationships to other Models.

How does it work?

This package expects that you are using laravel-generation-model 5.1 or above. You will need to import the tinymeng/laravel-generation-model package via composer:

Configuration

It is recommended that this package should only be used on a local environment for security reasons. You should install it via composer using the --dev option like this:

composer require tinymeng/laravel-generation-model --dev

Add the models.php configuration file to your config directory and clear the config cache:

php artisan vendor:publish --tag=tinymeng-models

# Let's refresh our config cache just in case
php artisan config:clear

Models

Usage

Assuming you have already configured your database, you are now all set to go.

• Let's scaffold some of your models from your default connection.

php artisan code:models

• You can scaffold a specific table like this:

php artisan code:models --table=users

• You can also specify the connection:

php artisan code:models --connection=mysql

• If you are using a MySQL database, you can specify which schema you want to scaffold:

php artisan code:models --schema=shop

Customizing Model Scaffolding

To change the scaffolding behaviour you can make config/models.php configuration file fit your database needs. Check it out ;-)

Tips

1. Keeping model changes

You may want to generate your models as often as you change your database. In order not to lose your own model changes, you should set base_files to true in your config/models.php.

When you enable this feature your models will inherit their base configurations from base models. You should avoid adding code to your base models, since you will lose all changes when they are generated again.

Note: You will end up with two models for the same table and you may think it is a horrible idea to have two classes for the same thing. However, it is up to you to decide whether this approach gives value to your project :-)

Support

For the time being, this package supports MySQL, PostgreSQL and SQLite databases. Support for other databases are encouraged to be added through pull requests.