README

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

致谢通知

本包是基于IsraelOrtuno的出色EAV 包重写的分支，原始归功于他。经过广泛的重写，保留了核心概念，我们认为其本质上很好。这个分支的主要区别包括

利用 rinvex/cacheable 提高性能
使用它序列化和反序列化实体及其关系
无需框架无关的复杂开销即可集成 Laravel
属性可以通过连接表附加到零个、一个或多个实体
属性可以排序、生成缩略名、翻译、分组，并且最激动人心的是可以缓存
实体属性被更自然地当作普通属性处理，以 Eloquent 的任何可能方式
实体属性也被更自然地当作普通关系处理，以 Eloquent 的任何可能方式

简介

基础

前言

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/attributes
```
通过以下命令执行迁移
```
php artisan rinvex:migrate:attributes
```
完成！

使用

将 EAV 添加到 Eloquent 模型

Rinvex Attributes 是专门为 Eloquent 设计的，并且在任何其他 Laravel 相关方面都十分重视简洁性。要将 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) 发布。

zvestaphp / attributes

维护者

详细信息