README

Eloquent 模型生成器通过数据库模式作为源来生成 Eloquent 模型。

版本 2.0.0

版本 2.0.0 已发布。请查看此讨论获取更多详细信息及升级说明。

安装

步骤 1. 将 Eloquent 模型生成器添加到您的项目中

composer require krlove/eloquent-model-generator --dev

步骤 2. 注册 GeneratorServiceProvider

'providers' => [
    // ...
    Krlove\EloquentModelGenerator\Provider\GeneratorServiceProvider::class,
];

步骤 3. 配置您的数据库连接。

使用

php artisan krlove:generate:model User

生成一个模型类。生成器将查找名为 users 的表并为其生成一个模型。

表名

使用 table-name 选项来指定另一个表名

php artisan krlove:generate:model User --table-name=user

在这种情况下，生成的模型将包含 protected $table = 'user' 属性。

输出路径

生成的文件将被保存在您应用程序的 app/Models 目录中，并默认使用 App\Models 命名空间。如果您想更改目的地和命名空间，请分别提供 output-path 和 namespace 选项

php artisan krlove:generate:model User --output-path=/full/path/to/output/directory --namespace=Your\\Custom\\Models\\Place

output-path 可以是绝对路径，也可以是相对于项目 app 目录的相对路径。绝对路径必须以 / 开头

/var/www/html/app/Models - 绝对路径
Custom/Models - 相对路径，将转换为 /var/www/html/app/Custom/Models（假设您的项目 app 目录为 /var/www/html/app）

基础类名称

默认情况下，生成的类将扩展自 Illuminate\Database\Eloquent\Model。要更改基础类，请指定 base-class-name 选项

php artisan krlove:generate:model User --base-class-name=Custom\\Base\\Model

无备份

如果 User.php 文件已存在，它将被重命名为 User.php~ 并保存在同一目录中。除非指定了 no-backup 选项

php artisan krlove:generate:model User --no-backup

其他选项

有几个有用的选项可以用于定义多个模型属性

no-timestamps - 向模型添加 public $timestamps = false; 属性
date-format - 指定模型的 dateFormat 属性
connection - 指定模型的连接名称属性

覆盖默认选项

您可以在执行命令时指定选项，也可以在项目的 config 目录中创建一个名为 eloquent_model_generator.php 的配置文件，并设置自己的默认值

<?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,
];

注册自定义数据库类型

如果运行命令导致错误

[Doctrine\DBAL\DBALException]
Unknown database type <TYPE> requested, Doctrine\DBAL\Platforms\MySqlPlatform may not support it.

这意味着您必须在您的 config/eloquent_model_generator.php 中注册您的类型 <TYPE>

return [
    // ...
    'db_types' => [
        '<TYPE>' => 'string',
    ],
];

使用示例

表 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=utf8

命令

php artisan krlove:generate:model 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
{
    /**
     * @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');
    }
}

为所有表生成模型

命令 krlove:generate:models 将为数据库中的所有表生成模型。它接受所有可用于 krlove:generate:model 的选项，以及 skip-table 选项。

跳过表

指定一个或多个要跳过的表名

php artisan krlove:generate:models --skip-table=users --skip-table=roles

请注意，如果您配置了前缀，则表名必须指定不带前缀。

自定义

您可以通过添加自己的 Krlove\EloquentModelGenerator\Processor\ProcessorInterface 实例并使用 GeneratorServiceProvider::PROCESSOR_TAG 标记来挂钩模型生成过程。

假设您想覆盖 Eloquent 的 perPage 属性值。

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 确定了处理器相对于其他处理器被调用的顺序。

在您的服务提供商中

public function register()
{
    $this->app->tag([InflectorRulesProcessor::class], [GeneratorServiceProvider::PROCESSOR_TAG]);
}

之后，生成的模型将包含以下代码

/**
 * The number of models to return for pagination.
 * 
 * @var int
 */
protected $perPage = 20;

porwisz / eloquent-model-generator

维护者

详细信息