README

⚠️ 此包已被废弃，不再维护。未建议替代包。 ⚠️

Rinvex Attributes 是一个强大、智能且集成的 Laravel Eloquent 实体-属性-值模型 (EAV) 实现，它能够轻松地将实体属性作为关系进行管理。它利用了 Laravel Eloquent 的强大功能，实现了平滑和无缝的集成。

致谢声明

此包是基于 IsraelOrtuno 的优秀 EAV 包重写的分支，原始信用归他所有。经过广泛重写，核心概念与原始版本相同，我们认为它本质上很好。此分支的主要不同之处包括

利用 rinvex/laravel-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/laravel-attributes

发布资源（迁移和配置文件）
```
php artisan rinvex:publish: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模型中即可！

核心类型

\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(\Rinvex\Attributes\Models\Type\Varchar::class)->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) 发布。

rinvex / laravel-attributes

维护者

详细信息