本文旨在指导开发者如何在 PrestaShop 后台的品牌（制造商）页面添加自定义字段。通过 `hookActionManufacturerFormBuilderModifier` 钩子，您可以轻松扩展品牌信息，实现更灵活的数据管理。本文将详细介绍具体步骤，并提供示例代码，帮助您快速掌握该技巧。
PrestaShop 后台管理界面提供了强大的自定义能力。如果您需要在品牌页面添加自定义字段，例如添加一个额外的文本输入框或下拉选择框，可以通过钩子来实现。然而，需要注意的是，PrestaShop 中“品牌”实际上对应的是“制造商”，因此需要使用与制造商相关的钩子。
使用 hookActionManufacturerFormBuilderModifier 钩子
hookActionManufacturerFormBuilderModifier 钩子允许您修改制造商表单的构建过程，从而添加自定义字段。该钩子会在构建制造商表单时被触发，您可以在此钩子中添加新的表单字段。
示例代码
以下是一个简单的示例，展示如何在品牌页面添加一个名为 custom_field 的文本输入框：
<?php
use PrestaShop\PrestaShop\Core\ConstraintValidator\Constraints\CleanHtml;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Validator\Constraints\NotBlank;
class MyModule extends Module
{
public function __construct()
{
$this->name = 'mymodule';
$this->tab = 'administration';
$this->version = '1.0.0';
$this->author = 'Your Name';
$this->need_instance = 0;
$this->ps_versions_compliancy = array('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 page.');
$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('custom_field', TextType::class, [
'label' => $this->l('Custom Field'),
'required' => false,
'constraints' => [
new NotBlank(),
new CleanHtml(),
],
]);
}
public function hookActionAfterCreateManufacturerFormHandler(array $params)
{
$this->updateManufacturer($params);
}
public function hookActionAfterUpdateManufacturerFormHandler(array $params)
{
$this->updateManufacturer($params);
}
private function updateManufacturer(array $params)
{
/** @var \PrestaShop\PrestaShop\Core\Domain\Manufacturer\CommandHandler\EditManufacturerCommandHandler $handler */
$manufacturer = $params['manufacturer'];
$form = $params['form'];
$customFieldValue = $form->get('custom_field')->getData();
// Save the custom field value to the database. You'll likely need to create a custom table or use an existing one.
// Example (replace with your actual database interaction):
Db::getInstance()->execute('
UPDATE `'._DB_PREFIX_.'manufacturer`
SET `custom_field` = \''.pSQL($customFieldValue).'\'
WHERE `id_manufacturer` = '.(int)$manufacturer->id
);
}
}
代码解释：
-
hookActionManufacturerFormBuilderModifier 函数：
- 接收 $params 数组，其中包含表单构建器对象 $formBuilder。
- 使用 $formBuilder->add() 方法添加一个新的文本输入框，标签为 "Custom Field"，字段名为 custom_field。
- 'required' => false 表示该字段不是必填项。
- 'constraints' 定义了字段的验证规则。
-
hookActionAfterCreateManufacturerFormHandler 和 hookActionAfterUpdateManufacturerFormHandler 函数:
- 分别在创建和更新制造商后触发。
- 调用 updateManufacturer 函数来处理自定义字段的保存。
-
updateManufacturer 函数:
- 从 $params 数组中获取制造商对象 $manufacturer 和表单对象 $form。
- 使用 $form->get('custom_field')->getData() 获取 custom_field 字段的值。
- 使用 Db::getInstance()->execute() 方法将自定义字段的值保存到数据库中。 请注意，您需要根据您的实际需求修改数据库操作代码。 通常，您需要创建一个新的数据库表来存储这些自定义字段，或者将其添加到现有的表中。
注意事项：
- 数据库存储： 示例代码中的数据库操作只是一个占位符。您需要根据实际情况创建或修改数据库表，并编写相应的 SQL 语句来存储和检索自定义字段的值。
- 数据验证： 在保存数据之前，请务必对用户输入进行验证，以防止恶意代码注入或其他安全问题。
- 模块安装： 将上述代码保存为 mymodule.php，并将其放入 PrestaShop 模块目录（通常是 /modules/mymodule）。然后在 PrestaShop 后台安装并启用该模块。
- 字段显示： 如果需要在品牌页面的其他位置（例如品牌列表）显示自定义字段，您还需要修改相应的模板文件。
总结
通过使用 hookActionManufacturerFormBuilderModifier 钩子，您可以轻松地向 PrestaShop 后台的品牌页面添加自定义字段。记住，"品牌"实际上对应于"制造商"，因此请使用相关的钩子。在添加自定义字段后，还需要处理数据的存储和显示，并确保对用户输入进行验证。希望本教程能够帮助您成功扩展 PrestaShop 的功能。
