README

感谢原始仓库 rinvex/laravel-attributes

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

致谢声明

此包是基于 IsraelOrtuno 的优秀 EAV 包重写的分支，原始版权归他所有。它已被广泛重写，与我们认为的基本概念相同。此分支的主要不同之处包括

利用 rinvex/laravel-cacheable 极大地提升了性能
使用它序列化和反序列化实体及其关系
与 Laravel 集成，没有框架无关的复杂开销
属性可以通过中继表附加到零个、一个或多个实体
属性可排序、可生成短链接、可翻译、可分组，并且最令人兴奋的是可缓存
实体属性被自然地处理，就像正常的属性一样，以 Eloquent 所有可能的方式
实体属性也被自然地处理，就像正常的关系一样，以 Eloquent 所有可能的方式

介绍

基础

前言

来自维基百科的 EAV 定义

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

实体

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

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

属性

该属性作为我们希望添加到实体的“列”。一个属性会得到一个如price、cities或colors的slug以便被识别，并将附加到实体上。它还将与数据类型实例非常紧密地配合，在写入或从数据库读取时转换或格式化其值。

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

值

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

在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 Collection。

创建新属性

就像任何正常的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 属性 允许您注册多值属性。为了使集合操作更简单，我们引入了一种新的集合类型，它扩展了 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 属性 尽力以 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 特性在反序列化排队模型时没有全局作用域，因此您会得到“在模型 [App\Models\Company] 上调用未定义的关系 [eav]”异常。

变更日志

请参阅变更日志了解项目的完整历史。

支持

以下支持渠道尽在您的指尖

贡献 & 协议

感谢您考虑为这个项目做出贡献！贡献指南可以在 CONTRIBUTING.md 中找到。

欢迎提交错误报告、功能请求和拉取请求。

安全漏洞

如果您在此项目中发现安全漏洞，请发送电子邮件至 help@rinvex.com。所有安全漏洞都将得到及时处理。

关于 Rinvex

Rinvex 是一家专注于中小企业集成企业解决方案的软件解决方案初创公司，自 2016 年 6 月在埃及亚历山大成立以来。我们相信，我们的动力——价值、触达和影响是我们与众不同的地方，通过软件的力量释放我们哲学的无尽可能性。我们喜欢称之为“生活速度的创新”。这就是我们如何为推进人类文明做出我们的一份贡献。

许可证

此软件根据 MIT 许可证 (MIT) 发布。

godscodes / laravel-attributes

维护者

详细信息