README

通过自动别名和映射 Eloquent 模型为简短、统一的类名，将内部应用程序命名空间结构与数据库解耦。

默认情况下，Laravel 将使用完全限定类名来存储相关模型的类型。例如，在上面的例子中，一个 Comment 可能属于一个 Post 或 Video，默认的 commentable_type 分别为 App\Post 或 App\Video。然而，您可能希望将数据库与应用程序的内部结构解耦。在这种情况下，您可以定义一个关系 "形态映射" 来指示 Eloquent 使用每个模型的自定义名称而不是类名。

有关更多信息，请参阅 Laravel 文档中的自定义多态类型。

Laravel 自动形态映射 通过扫描所有 Eloquent 模型，自动将其别名化为 统一的单数表名 并将其注册为多态类型来改进这一点。不再需要成百上千次的手动 Relation::morphMap() 调用来注册模型形态类型，也不需要在添加、更改或删除模型时维护那个讨厌的形态映射列表。

需求

PHP 8 或更高版本
Laravel 8 或更高版本

如何安装

通过 Composer

composer require leandrodiogenes/laravel-auto-morph-map

如何使用

安装此包后，您即可立即使用！该包将扫描所有您的模型，并自动在运行时注册它们的形态类型。

除了为您扫描和别名化模型之外，此包不会更改任何原生 Laravel 功能。因此，请参阅 Laravel 文档了解如何使用自定义多态类型。

如果您想自定义一些行为，请继续阅读。

定义模型命名空间

Laravel 自动形态映射 使用您的 composer.json PSR-4 自动加载部分来了解要扫描的命名空间和路径。在任何新的 Laravel 项目中，默认的 App\\ 命名空间已经就位，因此对于大多数项目无需额外的设置。如果您注册了其他命名空间，如本地模块或（开发）包，它们也将被扫描。

{
    "autoload": {
        "psr-4": {
            "App\\": "app/",
            "MyModule\\": "modules/MyModule/",
            "MyPackage\\": "MyPackage/src/"
        }
    }
}

此外，它还会过滤掉特质、抽象类、辅助文件和其他不可用项，仅绑定有效的 Eloquent 模型。

覆盖现有别名

如果您愿意，您仍然可以在服务提供者的 boot 方法中覆盖已经别名的形态类型，就像您通常做的那样

use Illuminate\Database\Eloquent\Relations\Relation;

Relation::morphMap([
    'posts' => \App\Post::class,
    'videos' => \App\Video::class,
]);

这些将始终具有比已定义的更高的优先级。

在生产环境中缓存形态类型

为了缓存所有别名并加快生产环境中的应用程序速度，请将缓存命令添加到您的部署脚本中

php artisan morphmap:cache

这将扫描所有当前的模型，并将静态缓存文件写入到 bootstrap/cache 目录。在随后的框架启动时，它将读取缓存文件而不是在运行时进行扫描和别名化。

请注意，这会禁用运行时扫描，意味着新模型将不会被识别，现有模型的变化也不会反映出来（在开发期间不太方便）。

要清除缓存文件，请运行

php artisan morphmap:clear

配置

运行

php artisan vendor:publish

并选择

laravel-auto-morph-map (configuration)

以发布配置文件。

命名

确定模型形态基值时使用的命名方案。默认为单数表名（由Laravel自动确定或通过模型中的$table变量覆盖）。

您可以将其更改为使用单数表名、表名或类基本名。有关可能选项，请参阅\LeandroDiogenes\AutoMorphMap\Constants\NamingSchemes。

单数表名（默认）

Relation::morphMap([
    'collection_item' => 'App\CollectionItem',
]);

表名

Relation::morphMap([
    'collection_items' => 'App\CollectionItem',
]);

类基本名

Relation::morphMap([
    'CollectionItem' => 'App\CollectionItem',
]);

大小写

将模型名称（在通过命名方案转换后）转换为更统一的字符串。默认情况下，基于您的命名方案的模型名称会被转换为下划线命名法。

您可以将其更改为使用下划线、缩写、驼峰、大驼峰或无格式。有关可能选项，请参阅\LeandroDiogenes\AutoMorphMap\Constants\CaseTypes。

下划线命名法（默认）

Relation::morphMap([
    'collection_item' => 'App\CollectionItem',
]);

缩写命名法

Relation::morphMap([
    'collection-item' => 'App\CollectionItem',
]);

驼峰命名法

Relation::morphMap([
    'collectionItem' => 'App\CollectionItem',
]);

大驼峰命名法

Relation::morphMap([
    'CollectionItem' => 'App\CollectionItem',
]);

无（由您的命名方案和Laravel的类到表的转换方法确定）

Relation::morphMap([
    'collection_item' => 'App\CollectionItem',
]);

许可证

本软件包遵循MIT许可（MIT）。有关更多信息，请参阅LICENSE。

变更日志

有关最近更改的信息，请参阅CHANGELOG。

测试

composer install
composer test

贡献

有关详细信息，请参阅CONTRIBUTING和CODE OF CONDUCT。

安全

如果您发现任何安全相关的问题，请通过电子邮件hello@sebastiaanluca.com联系，而不是使用问题跟踪器。

致谢

关于

我叫Sebastiaan，是一名专注于构建自定义Laravel应用的自由后端开发者。查看我的作品集了解更多信息，我的博客提供最新技巧和窍门，我的其他软件包可以帮助您启动下一个项目。

您的项目需要一些指导吗？请通过电子邮件hello@sebastiaanluca.com联系我！

leandrodiogenes / laravel-auto-morph-map

维护者

详细信息