README

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

致谢声明

此包是基于 IsraelOrtuno 的出色 EAV 包重写的分支，原始版权归他所有。经过广泛的修改，保留了核心概念，我们认为它非常优秀。此分支的主要区别包括

利用 rinvex/cacheable 大幅提高性能
使用它序列化和反序列化实体及其关系
没有框架无关的复杂开销，集成到 Laravel
属性可以通过枢纽表附加到零个、一个或多个实体
属性可排序、可生成短网址、可翻译、可分组，并且最激动人心的可缓存
实体属性以更自然的方式处理，就像正常的属性一样，以所有可能的 Eloquent 方式
实体属性也以更自然的方式处理，就像正常的关系一样，以所有可能的 Eloquent 方式

简介

基础知识

序言

EAV 定义来自维基百科

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

实体

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

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

属性

属性充当我们想要添加到实体中的“列”。属性获得一个类似于 price、cities 或 colors 的短网址来标识，并将附加到实体上。它还将非常紧密地与数据类型实例协作，在写入或从数据库读取时将其值进行转换或格式化。

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

值

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

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

数据根据其数据类型存储在不同的表中。字符串值将存储在默认称为 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 制作，并非常重视简洁性。要在 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,
    // ...
    '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 并提供了一些额外功能。此类允许我们向属性添加和删除值。它基本上允许用户在无需担心创建 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 在处理关系时一样，及时加载。然而，我们可以使用 Eloquent 预加载来处理 Rinvex 属性，以获得更好的性能并避免 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) 发布的。

自净华 / eav

维护者

详情