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 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 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 特性在反序列化排队模型时没有全局范围，因此您将收到 "Call to undefined relationship [eav] on model [App\Models\Company]" 异常。

变更日志

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

支持

以下支持渠道随时可供您使用

贡献 & 协议

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

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

安全漏洞

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

关于 Rinvex

Rinvex 是一家成立于2016年6月的埃及亚历山大市，专门为中小企业提供集成企业解决方案的软件解决方案初创公司。我们相信我们的动力是“价值”，“触达”和“影响”，这是我们与其他公司区别开来的地方，并通过软件的力量释放我们哲学的无限可能性。我们喜欢称之为“生命之速的创新”。这就是我们为推动人类进步做出贡献的方式。

许可证

本软件在 MIT 许可证 (MIT) 下发布。

dnsoft / rinvex-laravel-attributes

维护者

详细信息