README

Rinvex Attributes 是一个强大、智能且集成的 Laravel Eloquent 实体-属性-值模型（EAV）实现，它通过强大的底层机制轻松地将实体属性作为关系进行管理。它利用 Laravel Eloquent 的强大功能，实现平滑无缝的集成。

致谢声明

此包是 IsraelOrtuno 的优秀 EAV 包的重写分支，原始版权归他所有。它经过了广泛的修改，核心概念与我们认为的非常好相同。这个分支的主要区别包括

通过使用 rinvex/laravel-cacheable 大幅提高性能
使用它序列化和反序列化实体及其关系
集成 Laravel 无框架开销复杂性
属性可以通过连接表附加到零个、一个或多个实体
属性可排序、可生成缩略名、可翻译、可分组，并且最令人兴奋的是可缓存
实体属性以更自然的方式处理，就像正常的属性一样，以 Laravel Eloquent 的所有可能方式
实体属性也以更自然的方式处理，就像正常的关系一样，以 Laravel 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/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 属性 考虑了强大的 Eloquent 惰性加载系统。当访问 Eloquent 模型中的实体属性时，它将与 Eloquent 一样在处理关系时即时加载。然而，我们可以使用 Rinvex 属性 并结合 Eloquent 惰性加载以获得更好的性能并避免 n+1 查询问题。

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

惰性 eager 加载

再次，就像任何常规的 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)下发布。

kjmtrue / laravel-attributes

维护者

详细信息