如何在Prestashop后台“品牌”页面添加自定义字段

本文将指导您如何在Prestashop后台的“品牌”页面添加自定义字段。 通过使用 `hookActionManufacturerFormBuilderModifier` 钩子，您可以扩展品牌（实际上是制造商）的表单，并添加自定义字段，例如文本框、下拉列表等。本文将详细介绍如何使用此钩子，以及如何处理表单的创建和更新逻辑。

Prestashop的后台管理界面提供了强大的扩展性，允许开发者自定义各种页面和功能。 其中，向“品牌”页面添加自定义字段的需求较为常见，例如添加品牌描述、品牌LOGO等。 值得注意的是，Prestashop中的“品牌”实际上对应的是“制造商”（Manufacturer），因此我们需要使用与“制造商”相关的钩子来进行操作。

使用 hookActionManufacturerFormBuilderModifier 钩子

hookActionManufacturerFormBuilderModifier 钩子允许您修改制造商表单的构建过程。 通过此钩子，您可以添加、修改或删除表单中的字段。

以下是一个简单的示例，演示如何使用此钩子添加一个自定义文本字段：

name = 'mymodule';
        $this->tab = 'administration';
        $this->version = '1.0.0';
        $this->author = 'Your Name';
        $this->need_instance = 0;
        $this->ps_versions_compliancy = ['min' => '1.7', 'max' => _PS_VERSION_];

        parent::__construct();

        $this->displayName = $this->l('My Module');
        $this->description = $this->l('Adds a custom field to the manufacturer form.');

        $this->confirmUninstall = $this->l('Are you sure you want to uninstall?');
    }

    public function install()
    {
        return parent::install() &&
            $this->registerHook('actionManufacturerFormBuilderModifier') &&
            $this->registerHook('actionAfterCreateManufacturerFormHandler') &&
            $this->registerHook('actionAfterUpdateManufacturerFormHandler');
    }

    public function uninstall()
    {
        return parent::uninstall();
    }

    public function hookActionManufacturerFormBuilderModifier(array $params)
    {
        /** @var \Symfony\Component\Form\FormBuilderInterface $formBuilder */
        $formBuilder = $params['form_builder'];

        $formBuilder->add('my_custom_field', \Symfony\Component\Form\Extension\Core\Type\TextType::class, [
            'label' => $this->l('My Custom Field'),
            'required' => false,
            'help' => $this->l('Enter your custom field value here.'),
        ]);
    }

    public function hookActionAfterCreateManufacturerFormHandler(array $params)
    {
        $this->processCustomField($params['form'], $params['id']);
    }

    public function hookActionAfterUpdateManufacturerFormHandler(array $params)
    {
        $this->processCustomField($params['form'], $params['id']);
    }

    private function processCustomField($form, $manufacturerId)
    {
        $customFieldValue = $form->getData()['my_custom_field'];

        // Save the custom field value to the database.
        // You'll need to create a database table or use an existing one to store this data.
        // Example:
        Db::getInstance()->execute('
            INSERT INTO `'._DB_PREFIX_.'manufacturer_custom_data` (`id_manufacturer`, `custom_field`)
            VALUES ('.(int)$manufacturerId.', "'.pSQL($customFieldValue).'")
            ON DUPLICATE KEY UPDATE `custom_field` = "'.pSQL($customFieldValue).'"
        ');
    }

    public function renderWidget($hookName = null, array $configuration = [])
    {
        // This module doesn't render any widgets.
        return '';
    }

    public function getWidgetVariables($hookName = null, array $configuration = [])
    {
        // This module doesn't provide any widget variables.
        return [];
    }
}

代码解释：

1. hookActionManufacturerFormBuilderModifier 函数:
   • 获取表单构建器 $formBuilder。
   • 使用 $formBuilder->add() 方法添加一个名为 my_custom_field 的文本字段。
   • 设置字段的标签、是否必填以及帮助文本。
2. hookActionAfterCreateManufacturerFormHandler 和 hookActionAfterUpdateManufacturerFormHandler 函数:
   • 这两个钩子分别在创建和更新制造商时触发。
   • 调用 processCustomField 方法来处理自定义字段的值。
3. processCustomField 函数:
   • 从表单数据中获取 my_custom_field 的值。
   • 将该值保存到数据库中。 注意： 你需要创建一个数据库表来存储自定义字段的数据。 示例代码展示了如何使用 Db::getInstance()->execute() 方法来执行SQL查询。

注意事项

• 数据库存储: 您需要创建一个数据库表来存储自定义字段的数据。 表结构应包含制造商ID (id_manufacturer) 和自定义字段的值。
• 数据验证: 在将数据保存到数据库之前，请务必进行数据验证，以确保数据的有效性和安全性。
• 表单类型: 根据您的需求选择合适的表单类型。 Prestashop提供了多种表单类型，例如文本框、下拉列表、复选框等。
• 模块安装: 确保您的模块已正确安装并启用。

总结

通过使用 hookActionManufacturerFormBuilderModifier 钩子，您可以轻松地向Prestashop后台的“品牌”页面添加自定义字段。 记住，"品牌" 实际上是 "制造商"，所以请使用与 "制造商" 相关的钩子。 此外，请务必创建数据库表来存储自定义字段的数据，并进行适当的数据验证。