amirimatin / eloquent-model-generator
Eloquent 模型生成器
Requires
- doctrine/dbal: ^2.5
- illuminate/database: ^5.0 || ^6.0
- illuminate/support: ^5.0 || ^6.0
- krlove/code-generator: ^1.0
README
Eloquent 模型生成器是一个基于 Code Generator 的工具,用于生成 Eloquent 模型。
安装
步骤 1. 将 Eloquent 模型生成器添加到您的项目中
composer require krlove/eloquent-model-generator --dev
步骤 2. 注册 GeneratorServiceProvider
'providers' => [ // ... Krlove\EloquentModelGenerator\Provider\GeneratorServiceProvider::class, ];
如果您使用的是 Laravel 版本 5.5 或更高版本,则可以省略此步骤,因为该项目支持 包发现 功能。
步骤 3. 配置您的数据库连接。
用法
使用
php artisan krlove:generate:model User
来生成一个模型类。生成器将查找名为 users
的表并为其生成一个模型。
表名
使用 table-name
选项来指定另一个表名
php artisan krlove:generate:model User --table-name=user
在这种情况下,生成的模型将包含 protected $table = 'user'
属性。
输出路径
生成的文件将保存在您的应用程序的 app
目录中,并默认使用 App
命名空间。如果您想更改目的地和命名空间,请分别提供 output-path
和 namespace
选项
php artisan krlove:generate:model User --output-path=/full/path/to/output/directory --namespace=Some\\Other\\NSpace
output-path
可以是绝对路径或相对于项目的 app
目录的相对路径。绝对路径必须以 /
开头
/var/www/html/app/Models
- 绝对路径Models
- 相对路径,将转换为/var/www/html/app/Models
(假设您的项目应用程序目录是/var/www/html/app
)
基类名称
默认情况下,生成的类将扩展自 Illuminate\Database\Eloquent\Model
。要更改基类,请指定 base-class-name
选项
php artisan krlove:generate:model User --base-class-name=Some\\Other\\Base\\Model
备份
在生成新模型之前保存现有模型
php artisan krlove:generate:model User --backup
如果 User.php
文件已存在,它将被重命名为 User.php~
并保存在同一目录中。然后,将生成新的 User.php
。
其他选项
有一些有用的选项可以定义模型的多个属性
no-timestamps
- 向模型添加public $timestamps = false;
属性date-format
- 指定模型的dateFormat
属性connection
- 指定模型的连接名称属性
全局覆盖默认选项
您不必每次执行命令时都指定选项,可以在项目的 config
目录中创建一个名为 eloquent_model_generator.php
的配置文件,并设置您自己的默认值。生成器已在 Resources/config.php
中包含了自己的配置文件,具有以下选项
<?php return [ 'namespace' => 'App', 'base_class_name' => \Illuminate\Database\Eloquent\Model::class, 'output_path' => null, 'no_timestamps' => null, 'date_format' => null, 'connection' => null, 'backup' => null, ];
您可以通过在 eloquent_model_generator.php
中定义 model_defaults
数组来覆盖它们
<?php return [ 'model_defaults' => [ 'namespace' => 'Some\\Other\\Namespace', 'base_class_name' => 'Some\\Other\\ClassName', 'output_path' => '/full/path/to/output/directory', 'no_timestamps' => true, 'date_format' => 'U', 'connection' => 'other-connection', 'backup' => true, ], ];
注册自定义数据库类型
如果执行命令导致错误
[Doctrine\DBAL\DBALException]
Unknown database type <ANY_TYPE> requested, Doctrine\DBAL\Platforms\MySqlPlatform may not support it.
则表示您必须使用 Doctrine 注册您的类型 <ANY_TYPE>
。
例如,您打算注册 enum
类型,并希望 Doctrine 将其视为 string
(您可以在 此处 找到所有现有的 Doctrine 类型)。在您的 config/eloquent_model_generator.php
中添加以下行
return [
// ...
'db_types' => [
'enum' => 'string',
],
];
用法示例
表 user
CREATE TABLE `user` ( `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 `role` (`id`) ON DELETE CASCADE ON UPDATE CASCADE ) ENGINE=InnoDB DEFAULT CHARSET=utf8
命令
php artisan krlove:generate:model User --table-name=user
结果
<?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 { /** * The table associated with the model. * * @var string */ protected $table = 'user'; /** * @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'); } }