README

Rinvex Attributes 是一个强大、智能且集成的实体-属性-值模型（EAV）实现，适用于 Laravel Eloquent，它能够轻松地以关系的形式隐式管理实体属性。它利用 Laravel Eloquent 的力量，实现流畅和无缝的集成。

致谢声明

此包是IsraelOrtuno的出色EAV 包的重新编写分支，原始信用归功于他。它已被广泛重写，与核心概念相同，我们认为它基本上很好。此分支的主要区别包括

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

介绍

基础

前言

EAV 定义来自 Wikipedia

实体-属性-值模型（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/attributes
```
执行以下命令来执行迁移
```
php artisan rinvex:migrate:attributes
```
完成了！

使用

将 EAV 添加到 Eloquent 模型

Rinvex Attributes 特别为 Eloquent 设计，并非常重视简洁性。要将 EAV 功能添加到您的 Eloquent 模型，只需使用如下 \Rinvex\Attributes\Traits\Attributable 特性

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

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

注册自己的类型

app('rinvex.attributes.types')->push(\Path\To\Your\Type::class);

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

注册您的实体

app('rinvex.attributes.entities')->push(\Path\To\Your\Entity::class);

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

创建新的属性

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

app('rinvex.attributes.attribute')->create([
    'slug' => 'size',
    'name' => 'Product Size',
    'type' => 'Rinvex\Attributes\Models\Type\Varchar',
    '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('Rinvex\Attributes\Models\Type\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 属性 考虑到强大的 Eloquent 预加载系统。当访问 Eloquent 模型中的实体属性时，它将像 Eloquent 处理关系时那样及时加载。然而，我们可以使用 Rinvex 属性，通过 Eloquent 预加载来提高性能并避免 n+1 查询问题。

Rinvex 属性 为加载所有已注册属性保留了一个特殊的关系名称。这个关系被称为 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) 发布。

laravel5compitable / attributes

维护者

详细信息