README

Rinvex Attributes 是 Laravel Eloquent 的一种强大、智能且集成的实体-属性-值模型（EAV）实现，能够轻松地以关系的形式管理实体属性。它利用了 Laravel Eloquent 的强大功能，实现了平滑无缝的集成。

致谢声明

这个包是基于 IsraelOrtuno 的优秀 EAV 包重写的分支，原始的荣誉应归功于他。它已经被大量重写，但保留了核心概念，我们认为它从根本上来说是好的。这个分支的主要区别包括

利用 rinvex/laravel-cacheable 实现性能的大幅提升
使用它序列化和反序列化实体及其关系
没有框架无关的复杂性，无缝集成到 Laravel 中
属性可以通过连接表附加到零个、一个或多个实体
属性可排序、可缩写、可翻译、可分组，最令人兴奋的是可缓存
实体属性以类似于正常属性的方式处理，以所有可能的 Eloquent 方式
实体属性也以类似于正常关系的方式处理，以所有可能的 Eloquent 方式

简介

基础知识

前言

来自 Wikipedia 的 EAV 定义

实体-属性-值模型（EAV）是一种数据模型，以空间有效的方式编码实体，其中可以用来描述它们的属性（属性、参数）的数量可能很大，但实际上适用于特定实体的数量相对较小。

实体

实体代表了一个需要动态扩展其属性的实时模型。例如：如 Product、Customer 或 Company 这样的模型很可能就是实体。

在这种情况下，实体将由 Eloquent 模型表示。

属性

属性充当我们想要添加到实体中的“列”。属性将获得一个像 price、cities 或 colors 这样的缩写以供识别，并将附加到实体。它还将非常紧密地与数据类型实例协作，该实例在写入或从数据库读取时将转换或格式化其值。

此属性还将负责定义一些默认行为，例如数据验证或默认值。

值

这负责存储与特定属性和特定实体实例（行）相关的数据值。

在 Rinvex Attributes 实现中，一个值实例将代表与特定实体实例相关的属性内容。

根据其数据类型，值存储在不同的表中。字符串值将存储在默认名为 attribute_varchar_values 的表中，而整数值将使用 attribute_integer_values，以此类推。这两个表的列相同，除了 content 列的数据类型，它被调整为存储的数据类型。

性能损失

EAV 模型以其性能不足而闻名。与查询任何其他水平结构相比，它在查询数据方面的复杂性也很有名。这种范式在很多文章中被标记为反模式，并且关于是否应该使用它有很多争议。

由于我们将在不同的表中存储实体、属性和值，因此执行任何操作都需要进行多个查询。这意味着如果我们为实体注册了 4 个属性，则包至少将执行 5 个查询

select * from `companies`
select * from `attribute_varchar_values` where `attribute_id` = '1' and `attribute_varchar_values`.`entity_id` in ('1', '2', '3', '4', '5') and `eav_attribute_varchar_values`.`entity_type` = 'App\Models\Company'
select * from `attribute_varchar_values` where `attribute_id` = '2' and `attribute_varchar_values`.`entity_id` in ('1', '2', '3', '4', '5') and `eav_attribute_varchar_values`.`entity_type` = 'App\Models\Company'
select * from `attribute_varchar_values` where `attribute_id` = '3' and `attribute_varchar_values`.`entity_id` in ('1', '2', '3', '4', '5') and `eav_attribute_varchar_values`.`entity_type` = 'App\Models\Company'
select * from `attribute_varchar_values` where `attribute_id` = '4' and `attribute_varchar_values`.`entity_id` in ('1', '2', '3', '4', '5') and `eav_attribute_varchar_values`.`entity_type` = 'App\Models\Company'

但是，有好消息！ Rinvex Attributes 利用 Rinvex Cacheable 来透明地缓存模型结果，可能将这些查询减少到只有一个或甚至零个查询！是的，这是可能的，并且默认已经实现！！

获得的灵活性

然而，尽管存在性能问题，EAV 提供了非常高的灵活性。它允许我们拥有动态属性，可以在任何时候添加/删除属性而不会影响数据库结构。它还有助于处理主要存储 NULL 值的列。

考虑到您接受 EAV 带来的性能不足，该包的开发是以灵活性为前提的，这样至少您可以应对性能问题。性能可以通过在单个查询中加载所有与实体相关的值并允许一些 PHP 逻辑将它们组织到关系中来进行改进，但决定不这样做，以使数据库查询更加灵活。

如以下说明，此包将实体值加载得就像它们是自定义的 Eloquent 关系一样。这就是我们为什么可以像常规 Eloquent 关系一样轻松查询它们的原因。

将值作为关系加载将允许我们仅加载可能需要用于特定情况的值，而让其他值未加载。它还允许我们使用强大的 Eloquent 查询关系工具，这样我们就可以根据直接应用于值内容的条件轻松过滤从数据库中检索的实体。

安装

通过 composer 安装此包

composer require rinvex/laravel-attributes

发布资源（迁移和配置文件）
```
php artisan rinvex:publish:attributes
```
使用以下命令执行迁移
```
php artisan rinvex:migrate:attributes
```
完成！

用法

将 EAV 添加到 Eloquent 模型

Rinvex Attributes 专门为 Eloquent 设计，并非常重视简洁性，就像其他任何 Laravel 相关方面一样。要向 Eloquent 模型添加 EAV 功能，只需像这样使用 \Rinvex\Attributes\Traits\Attributable 特性

class Company extends Model
{
    use \Rinvex\Attributes\Traits\Attributable;
}

就是这样，我们只需在我们的 Eloquent 模型中包含该特性！

核心类型

\Rinvex\Attributes\Models\Type\Text::class
\Rinvex\Attributes\Models\Type\Boolean::class
\Rinvex\Attributes\Models\Type\Integer::class
\Rinvex\Attributes\Models\Type\Varchar::class
\Rinvex\Attributes\Models\Type\Datetime::class

注册你的类型

Rinvex Attributes 默认不注册任何类型，因为这被认为是实现细节，因此您需要自己注册上面列出的核心类型，或扩展它们并仅注册自定义类型。

use Rinvex\Attributes\Models\Attribute;

Attribute::typeMap([
    'varchar' => Rinvex\Attributes\Models\Type\Varchar::class,
    // ...
    'custom' => \Path\To\Your\Type::class,
]);

注意：虽然您可以从应用程序的任何位置注册自定义类型，但建议在服务提供者的 boot 方法中这样做。

注册你的实体

// Push your entity fully qualified namespace
app('rinvex.attributes.entities')->push(\Path\To\Your\Entity::class);

// Or push the morph class alias if any
app('rinvex.attributes.entities')->push('entity');

您可以在应用程序的任何位置调用 'rinvex.attributes.entities' 服务，在请求生命周期中的任何时间（建议在服务提供者的 boot 方法中）。它是一个单例对象，包含一个纯 Laravel 集合。

创建新属性

就像任何正常的 Eloquent 模型一样，您可以创建属性如下

app('rinvex.attributes.attribute')->create([
    'slug' => 'size',
    'type' => 'varchar',
    'name' => 'Product Size',
    'entities' => ['App\Models\Company', 'App\Models\Product'],
]);

管理属性实体

当您需要获取附加到特定属性上的实体时，您可以这样做

$attribute = app('rinvex.attributes.attribute')->find(1);

// Get attribute entities collection
$attribute->entities

// Get attribute entities query builder
$attribute->entities();

// Delete attached attribute entities
$attribute->entities()->delete();

// Attach attribute entities
$attribute->entities()->createMany([
    [...],
    [...],
    [...],
]);

// Alternative way of attaching attribute entities
$attribute->fill([
    'entities' => ['App\Models\Company', 'App\Models\Product'],
])->save();

// Get all attribute values of type varchar
$values = $attribute->values('varchar')->get();

分配值

您可以将新创建的自定义属性视为正常的属性，是的！所有属性都是平等的！！ 😄

您需要证明吗？好吧，请看以下示例，其中我们假设 price 是我们刚刚创建并链接到我们的 \App\Models\Product 模型的自定义属性

// Single value assignment
$product = \App\Models\Product::find(1);
$product->price = 123;
$product->save();

// Mass assignment
$product = \App\Models\Product::find(1);
$product->fill(['price' => 123])->save();

是的，就是这样。简单！您可以像处理正常属性一样处理自定义属性，没有区别。关于 eloquent 的所有好东西都适用于这里，无论是更新单个字段、批量分配、创建还是更新，它只需工作！

`Rinvex\Attributes\Support\ValueCollection`

Rinvex Attributes 允许您注册多值属性。为了使与集合的交互更容易，我们包括了一个新的集合类型，该类型仅扩展 Illuminate\Database\Eloquent\Collection 并提供一些额外功能。此类让我们可以向属性中添加和删除值。它基本上允许用户在没有担心创建值模型实例的情况下与集合类进行交互。以下是一段代码将有所帮助

// This is how it works
$entity->cities->add('Alexandria');

// And this is what you would have to do without this collection:
$value = new Varchar(['content' => 'Alexandria', 'attribute_id' => 1, 'entity_type' => 'App\Models\Company', 'entity_id' => 1]);
$entity->cities->push($value);

// You could also pass an array
$entity->cities->add(['Alexandria', 'Cairo']);

集合可能会得到改进并添加更多功能，但目前为止已经足够了。基于值的模型替换了 Eloquent 方法 newCollection，以便在处理多值属性时返回此类集合。

查询模型

Rinvex Attributes 尽力以 Eloquent 通常的方式执行所有操作。当加载模型时，它内部为每个实体属性创建一个常规关系。这意味着我们可以像在查询 Eloquent 关系时那样根据注册的属性值进行查询过滤。

// Cities is an entity attribute
$companies = Company::whereHas('Cities', function (\Illuminate\Database\Eloquent\Builder $builder) {
    $builder->where('content', 'Alexandria');
})->get();

或者简单地使用内置查询作用域，如下所示

$companies = Company::hasAttribute('Cities', 'Alexandria')->get();

当然，您可以将实体属性作为常规的Eloquent属性或原始关系来检索。

$company = Company::find(1);

// Get entity attributes
$company->cities;

// Get entity raw relation
$company->cities();

预加载

Rinvex Attributes 考虑了强大的Eloquent预加载系统。当访问Eloquent模型中的实体属性时，它将与Eloquent处理关系时一样，适时加载。然而，我们可以使用Eloquent预加载来更好地与 Rinvex Attributes 合作，以提升性能并避免n+1查询问题。

Rinvex Attributes 为加载所有注册的属性保留了一个特殊的关系名称。这个关系称为 eav。当使用 eav 来加载值时，它将加载与我们要处理的实体相关的所有属性，就像您显式地在 $with 模型属性中包含所有关系一样。

懒加载

同样，正如任何常规的Eloquent关系，我们可以决定何时加载我们的属性。就像您通常加载关系一样进行操作。

$company->load('eav');
$company->load('cities', 'colors');

使用 $with 自动加载

Eloquent自带一个 $with，它接受一个数组，包含应该进行预加载的关系。我们也可以使用它。

namespace App\Models;

use Rinvex\Attributes\Traits\Attributable;

class Company extends Model
{
    use Attributable;

    // Eager loading all the registered attributes
    protected $with = ['eav'];

    // Or just load a few of them
    protected $with = ['cities', 'colors'];
}

注意：如果您的模型预加载 eav 关系，并且它已被排队用于发送通知，这可能会引起一些问题，因为 eav 关系是通过全局作用域评估的，而用于排队通知的 SerializesAndRestoresModelIdentifiers 特性在反序列化排队模型时没有全局作用域，所以您将得到 "Call to undefined relationship [eav] on model [App\Models\Company]" 异常。

变更日志

请参阅变更日志以查看项目的完整历史记录。

支持

以下支持渠道随时可供您使用

贡献与协议

感谢您考虑为这个项目做出贡献！贡献指南可在 CONTRIBUTING.md 中找到。

欢迎提交错误报告、功能请求和拉取请求。

安全漏洞

如果您在此项目中发现安全漏洞，请发送电子邮件至 help@rinvex.com。所有安全漏洞都将得到及时处理。

关于 Rinvex

Rinvex 是一家软件解决方案初创公司，专注于为中小企业提供集成企业解决方案，自2016年6月成立以来位于埃及亚历山大。我们相信，我们的动力——价值、影响力和影响力是我们与众不同的地方，通过软件的力量释放我们哲学的无限可能性。我们喜欢称之为“生活速度的创新”。这就是我们如何为推进人类文明做出我们的贡献。

许可证

本软件根据 MIT 许可证 (MIT) 发布。

suppercup / laravel-attributes

维护者

详细信息