README

Rinvex Attributes 是一个强大、智能且集成的实体-属性-值模型（EAV）实现，用于 Laravel Eloquent，它可以通过轻松地将实体属性作为关系隐式管理来管理。它利用 Laravel Eloquent 的强大功能，实现平稳且无缝的集成。

致谢声明

这个包是基于 IsraelOrtuno 的优秀 EAV 包重写的分支，原始的荣誉归功于他。它已被广泛重写，与我们认为的其核心概念相同。这个分支的主要区别包括

利用 rinvex/laravel-cacheable 大幅提升性能
使用它序列化和反序列化实体及其关系
与 Laravel 集成，无需框架无关的复杂性
属性可以通过枢纽表附加到零个、一个或多个实体
属性可排序、可生成缩写、可翻译、可分组，最令人兴奋的是可缓存
实体属性以最自然的方式处理，就像每个可能的 Eloquent 方式中的普通属性一样
实体属性也以最自然的方式处理，就像每个可能的 Eloquent 方式中的普通关系一样

简介

基础知识

前言

EAV 定义来自维基百科

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

实体

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

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

属性

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

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

值

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

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

值根据其数据类型存储在不同的表中。字符串值将存储在默认名为 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 Collection。

创建新属性

就像任何正常的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并提供了一些额外的功能。此类允许我们从属性中添加和删除值。它基本上是让用户在没有担心创建Value模型实例的情况下玩集合类。一些代码将帮助在这里

// 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 特性在反序列化排队模型时不会使用全局范围，因此您将得到 "在模型 [App\Models\Company] 上调用未定义的关系 [eav]" 的异常。

更改日志

有关项目的完整历史记录，请参阅变更日志。

支持

以下支持渠道尽在您的指尖

贡献 & 协议

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

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

安全漏洞

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

关于 Rinvex

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

许可证

本软件在 MIT 许可证 (MIT) 下发布。

dmattern / laravel-attributes

维护者

详细信息