Updated with the latest composer dependencies for Laravel 10, tested on SQlite and Postgres
Coming Soon: Better Postgres Support & CI/CD support for contributors.
Eloquent Model Generator generates Eloquent models using database schema as a source.
Improvements: Forked and changed namespace, updated Composer, added phpstan, added php-cs-fixer, updated to latest phpunit version,
Step 1. Add Eloquent Model Generator to your project:
composer require dreadfulcode/eloquent-model-generator dev-2x --dev
Step 2. Confirm that the Dreadfulcode\EloquentModelGenerator\Provider is in GeneratorServiceProvider:
'providers' => [
// ...
Dreadfulcode\EloquentModelGenerator\Provider\GeneratorServiceProvider::class,
];Step 3. Configure your database connection.
This project was test driven with SQLite3.
For Sqlite3 on Ubuntu 22.x, PHP 8.1:
sudo apt-get install php8.1-sqlite3
Use
php artisan dreadfulcode:generate:model User
to generate a model class. Generator will look for table named users and generate a model for it.
Use table-name option to specify another table name:
php artisan dreadfulcode:generate:model User --table-name=user
In this case generated model will contain protected $table = 'user' property.
Generated file will be saved into app/Models directory of your application and have App\Models namespace by default. If you want to change the destination and namespace, supply the output-path and namespace options respectively:
php artisan dreadfulcode:generate:model User --output-path=/full/path/to/output/directory --namespace=Your\\Custom\\Models\\Place
output-path can be absolute path or relative to project's app directory. Absolute path must start with /:
/var/www/html/app/Models- absolute pathCustom/Models- relative path, will be transformed to/var/www/html/app/Custom/Models(assuming your project app directory is/var/www/html/app)
By default, generated class will be extended from Illuminate\Database\Eloquent\Model. To change the base class specify base-class-name option:
php artisan dreadfulcode:generate:model User --base-class-name=Custom\\Base\\Model
If User.php file already exist, it will be renamed into User.php~ first and saved at the same directory. Unless no-backup option is specified:
php artisan dreadfulcode:generate:model User --no-backup
There are several useful options for defining several model's properties:
no-timestamps- addspublic $timestamps = false;property to the modeldate-format- specifiesdateFormatproperty of the modelconnection- specifies connection name property of the model
Instead of specifying 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:
<?php
return [
'namespace' => 'App',
'base_class_name' => \Illuminate\Database\Eloquent\Model::class,
'output_path' => null,
'no_timestamps' => null,
'date_format' => null,
'connection' => null,
'no_backup' => null,
'db_types' => null,
];If running a command leads to an error
[Doctrine\DBAL\DBALException]
Unknown database type <TYPE> requested, Doctrine\DBAL\Platforms\MySqlPlatform may not support it.
it means that you must register your type <TYPE> at your config/eloquent_model_generator.php:
return [
// ...
'db_types' => [
'<TYPE>' => 'string',
],
];
Table user:
CREATE TABLE `users` (
`id` int(10) unsigned NOT NULL AUTO_INCREMENT,
`username` varchar(50) NOT NULL,
`email` varchar(100) NOT NULL,
`role_id` int(10) unsigned NOT NULL,
PRIMARY KEY (`id`),
KEY `role_id` (`role_id`),
CONSTRAINT `user_ibfk_1` FOREIGN KEY (`role_id`) REFERENCES `roles` (`id`) ON DELETE CASCADE ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8Command:
php artisan dreadfulcode:generate:model User
Result:
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
/**
* @property int $id
* @property int $role_id
* @property mixed $username
* @property mixed $email
* @property Role $role
* @property Article[] $articles
* @property Comment[] $comments
*/
class User extends Model
{
/**
* @var array
*/
protected $fillable = ['role_id', 'username', 'email'];
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function role()
{
return $this->belongsTo('Role');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function articles()
{
return $this->hasMany('Article');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function comments()
{
return $this->hasMany('Comment');
}
}Command dreadfulcode:generate:models will generate models for all tables in the database. It accepts all options available for dreadfulcode:generate:model along with skip-table option.
Specify one or multiple table names to skip:
php artisan dreadfulcode:generate:models --skip-table=users --skip-table=rolesNote that table names must be specified without prefix if you have one configured.
You can hook into the process of model generation by adding your own instances of Dreadfulcode\EloquentModelGenerator\Processor\ProcessorInterface and tagging it with GeneratorServiceProvider::PROCESSOR_TAG.
Imagine you want to override Eloquent's perPage property value.
class PerPageProcessor implements ProcessorInterface
{
public function process(EloquentModel $model, Config $config): void
{
$propertyModel = new PropertyModel('perPage', 'protected', 20);
$dockBlockModel = new DocBlockModel('The number of models to return for pagination.', '', '@var int');
$propertyModel->setDocBlock($dockBlockModel);
$model->addProperty($propertyModel);
}
public function getPriority(): int
{
return 8;
}
}getPriority determines the order of when the processor is called relative to other processors.
In your service provider:
public function register()
{
$this->app->tag([InflectorRulesProcessor::class], [GeneratorServiceProvider::PROCESSOR_TAG]);
}After that, generated models will contain the following code:
/**
* The number of models to return for pagination.
*
* @var int
*/
protected $perPage = 20;