将自定义域添加到Adminhtml表单并填充数据(Magento 2)

在Magento 2中，将自定义域添加到Adminhtml表单并填充数据涉及到几个步骤，包括创建自定义模块、定义表单字段、以及在控制器中处理数据。以下是一个详细的指南：

基础概念

Magento模块：Magento的扩展功能是通过模块实现的，每个模块可以包含控制器、模型、视图和布局文件。
Adminhtml表单：Adminhtml是Magento的后台管理界面，表单用于数据的输入和展示。

类型与应用场景

自定义字段：适用于需要额外信息输入的场景，如产品自定义属性、客户附加信息等。
数据填充：适用于需要在表单加载时预填充数据的场景，如编辑现有记录时显示已有数据。

实现步骤

1. 创建自定义模块

首先，创建一个新的模块目录结构，例如Custom/CustomForm。

app/code/Custom/CustomForm/

在该目录下创建以下文件：

registration.php
etc/module.xml
view/adminhtml/layout/adminhtml_customform_index_index.xml
view/adminhtml/ui_component/customform_form.xml
Controller/Adminhtml/Index/Index.php
Model/Form.php

2. 注册模块

在registration.php中注册模块：

<?php
\Magento\Framework\Component\ComponentRegistrar::register(
    \Magento\Framework\Component\ComponentRegistrar::MODULE,
    'Custom_CustomForm',
    __DIR__
);

在etc/module.xml中定义模块：

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
    <module name="Custom_CustomForm" setup_version="1.0.0"/>
</config>

3. 定义表单布局

在view/adminhtml/layout/adminhtml_customform_index_index.xml中定义表单布局：

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <body>
        <referenceContainer name="content">
            <block class="Magento\Backend\Block\Template" template="Custom_CustomForm::form.phtml"/>
        </referenceContainer>
    </body>
</page>

4. 创建UI组件

在view/adminhtml/ui_component/customform_form.xml中定义表单字段：

<?xml version="1.0"?>
<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
    <fieldset name="custom_form">
        <field name="custom_field">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="label" xsi:type="string" translate="true">Custom Field</item>
                    <item name="dataType" xsi:type="string">text</item>
                    <item name="formElement" xsi:type="string">input</item>
                </item>
            </argument>
        </field>
    </fieldset>
</form>

5. 创建控制器

在Controller/Adminhtml/Index/Index.php中处理表单提交和数据填充：

<?php
namespace Custom\CustomForm\Controller\Adminhtml\Index;

use Magento\Backend\App\Action;
use Magento\Backend\App\Action\Context;
use Magento\Framework\View\Result\PageFactory;

class Index extends Action
{
    protected $resultPageFactory;

    public function __construct(Context $context, PageFactory $resultPageFactory)
    {
        parent::__construct($context);
        $this->resultPageFactory = $resultPageFactory;
    }

    public function execute()
    {
        $resultPage = $this->resultPageFactory->create();
        $resultPage->getConfig()->getTitle()->prepend(__('Custom Form'));
        return $resultPage;
    }
}

6. 创建模型

在Model/Form.php中处理数据逻辑：

<?php
namespace Custom\CustomForm\Model;

use Magento\Framework\Model\AbstractModel;

class Form extends AbstractModel
{
    protected function _construct()
    {
        $this->_init('Custom\CustomForm\Model\ResourceModel\Form');
    }
}