Shopware 5.5.10：如何扩展第三方插件并新增后台复选框字段

我明白你遇到的困境——shopware_attribute.crud_service确实只适用于Shopware原生的属性表（那些带_attributes后缀的表，比如product_attributes），第三方插件的自定义表不在这个服务的处理范围内。要给第三方插件的表新增字段，我们得换用Doctrine迁移来修改数据库结构，再扩展实体定义来映射这个字段，最后在后台表单里添加对应的复选框。

下面是具体的步骤：

1. 创建Doctrine迁移文件新增字段 #

首先，你需要在自己的插件里创建一个迁移文件，直接用SQL语句给第三方插件的表新增布尔型字段（对应复选框）。

在你的插件目录src/Migration下新建一个迁移文件，命名格式为Migration{时间戳}AddCustomCheckboxField.php，比如：

<?php declare(strict_types=1);

namespace YourPluginNamespace\Migration;

use Doctrine\DBAL\Connection;
use Shopware\Core\Framework\Migration\MigrationStep;

class Migration1699999999AddCustomCheckboxField extends MigrationStep
{
    // 替换成当前的时间戳，确保唯一
    public function getCreationTimestamp(): int
    {
        return 1699999999;
    }

    public function update(Connection $connection): void
    {
        // 替换成第三方插件的实际表名，以及你想添加的字段名
        $connection->executeStatement('
            ALTER TABLE `third_party_plugin_table`
            ADD COLUMN `my_custom_checkbox` TINYINT(1) NOT NULL DEFAULT 0 AFTER `existing_column_name`;
        ');
    }

    public function updateDestructive(Connection $connection): void
    {
        // 如果后续需要删除字段，在这里写对应的SQL，当前不需要可以留空
    }
}

执行插件迁移后，这个字段就会被添加到第三方插件的表中。

2. 扩展第三方插件的实体定义 #

接下来，你需要告诉Shopware的DataAbstractionLayer（DAL）这个新增的字段，这样它才能在API和后台中被识别。

创建一个实体扩展类，继承EntityExtension：

<?php declare(strict_types=1);

namespace YourPluginNamespace\Extension;

use Shopware\Core\Framework\DataAbstractionLayer\EntityExtension;
use Shopware\Core\Framework\DataAbstractionLayer\Field\BoolField;
use Shopware\Core\Framework\DataAbstractionLayer\FieldCollection;
// 替换成第三方插件实体的实际命名空间
use ThirdPartyPluginNamespace\Core\Content\ThirdPartyEntity\ThirdPartyEntity;

class ThirdPartyEntityExtension extends EntityExtension
{
    public function extendFields(FieldCollection $collection): void
    {
        $collection->add(
            new BoolField('my_custom_checkbox', 'myCustomCheckbox')
        );
    }

    public function getDefinitionClass(): string
    {
        // 指定要扩展的第三方实体类
        return ThirdPartyEntity::class;
    }
}

然后在你的插件src/Resources/config/services.xml中注册这个扩展：

<service id="YourPluginNamespace\Extension\ThirdPartyEntityExtension">
    <tag name="shopware.entity.extension"/>
</service>

3. 在后台表单中添加复选框字段 #

最后一步是在后台的对应表单里显示这个复选框。如果第三方插件的后台页面是用Shopware的Admin组件构建的，你可以通过以下方式添加：

方式一：用事件订阅扩展表单 #

如果第三方插件触发了表单构建的事件，你可以订阅该事件并添加字段。或者，如果你知道表单组件的位置，可以用自定义组件来插入：

比如，在你的插件的Admin组件中添加：

<template>
    <sw-card>
        <sw-form-field
            type="checkbox"
            v-model="currentEntity.myCustomCheckbox"
            label="我的自定义复选框"
            helpText="勾选后启用某个功能"
        ></sw-form-field>
    </sw-card>
</template>

<script>
export default {
    inject: ['repositoryFactory'],
    props: {
        currentEntity: {
            type: Object,
            required: true
        }
    }
}
</script>

方式二：覆盖第三方插件的表单组件 #

如果需要直接修改第三方插件的原有表单，你可以用Shopware的组件覆盖机制，创建一个同名组件放在你的插件src/Resources/app/administration/src目录下，然后添加你的复选框字段。

关键注意事项 #

• 一定要确认第三方插件的表名和实体类的命名空间正确，否则操作会失败。
• 迁移文件的时间戳必须唯一，建议用当前的Unix时间戳。
• 操作数据库前最好备份数据，避免意外丢失。
• 如果第三方插件的实体没有使用Shopware的DAL，可能需要直接修改其代码，但这种情况比较少见，大部分Shopware插件都遵循DAL规范。

内容的提问来源于stack exchange，提问作者Moo I say