Shopware 6 中如何使用运行时属性扩展实体？

如何使用 Shopware 6 中的运行时属性扩展实体

什么是运行时属性？

运行时属性允许你动态地向实体添加字段，而无需修改数据库架构。这是一种强大的工具，可用于扩展实体，并根据需要添加额外的功能。

如何使用运行时属性？

使用运行时属性扩展实体包括几个步骤：

1. 创建实体扩展类

创建一个扩展类，继承自 EntityExtension 基类。此类将包含用于扩展实体的逻辑。

2. 扩展字段

在 extendFields() 方法中，使用 addField() 方法将新字段添加到实体。确保将 Runtime 标志添加到字段中，以指示这是一个运行时属性。

3. 获取定义类

在 getDefinitionClass() 方法中，返回要扩展的实体的定义类。

4. 注册扩展

使用 @Autoconfigure 注释将扩展注册到 Shopware 6 核心。

示例：添加自增参考编号

以下是一个示例，演示如何向 order_delivery 表添加一个自增参考编号：

#[Autoconfigure(tags: ['shopware.entity.extension'])]
class OrderDeliveryReferenceExtension extends EntityExtension
{
    public function extendFields(FieldCollection $collection): void
    {
        $collection->add(
            (new IntField('reference_number', 'referenceNumber'))
                ->addFlags(new ApiAware(), new Runtime()),
        );
    }

    public function getDefinitionClass(): string
    {
        return OrderDeliveryDefinition::class;
    }
}

读取运行时属性

要读取运行时属性，可以使用以下方法：

$referenceNumber = $this->delivery->getExtension('order_delivery_reference_extension')->get('referenceNumber');

常见问题解答

1. 运行时属性与数据库字段有什么区别？

运行时属性不会持久存储在数据库中，而数据库字段会持久存储。

2. 我可以使用运行时属性扩展哪些类型的实体？

你可以扩展任何 Shopware 6 实体，包括核心实体和自定义实体。

3. 可以在多个实体中使用相同的运行时属性吗？

可以，只要你使用不同的扩展类。

4. 是否有关于使用运行时属性的最佳实践？

是的，建议将运行时属性用于需要在不修改数据库架构的情况下添加临时或辅助字段的情况。

5. 是否可以在实体管理器中访问运行时属性？

是的，可以使用 getProperty() 方法从实体管理器中访问运行时属性。