Symfony中如何使用类对象而非getData()方法在控制器获取表单数据

实现步骤如下 #

1. 创建用于绑定表单的DTO（数据传输对象）类

你可以在项目src/Dto目录下新建对应的类，类的属性名必须和表单中定义的字段名完全一致：

<?php

namespace App\Dto;

class TestSearchDTO
{
    // 对应表单中的startDate字段
    private ?\DateTimeInterface $startDate = null;

    public function getStartDate(): ?\DateTimeInterface
    {
        return $this->startDate;
    }

    public function setStartDate(?\DateTimeInterface $startDate): self
    {
        $this->startDate = $startDate;
        return $this;
    }
    
    // 后续新增表单字段只需在此添加对应属性和getter、setter即可
}

如果不需要严格封装，也可以直接声明公共属性，无需编写getter和setter，表单组件同样可以完成自动映射。

2. 修改表单类配置指定映射类

找到你forms目录下的testForm类，在configureOptions方法中设置data_class参数，指定为上面创建的DTO类：

use App\Dto\TestSearchDTO;
use Symfony\Component\OptionsResolver\OptionsResolver;

public function configureOptions(OptionsResolver $resolver): void
{
    $resolver->setDefaults([
        'data_class' => TestSearchDTO::class,
        // 原有的其他默认配置保持不变
    ]);
}

3. 控制器中通过绑定对象获取数据

Symfony表单组件在验证通过后会自动把提交的字段值映射到绑定的对象上，无需手动逐个取字段：

// 初始化空的DTO对象
$searchDto = new TestSearchDTO();
// 创建表单时绑定DTO对象
$form = $this->createForm(testForm::class, $searchDto);
$form->handleRequest($request);

if ($form->isSubmitted() && $form->isValid()) {
    // 直接从DTO对象取对应属性即可，DateType会自动转为DateTimeInterface对象
    $start = $searchDto->getStartDate()->format('Y-m-d');
    
    // 后续业务逻辑直接操作$searchDto对象即可
}

注意事项 #

• 表单字段名必须和DTO类的属性名完全匹配，否则无法完成自动映射。你之前代码中调用$form->get('start')但表单定义的字段是startDate，字段名不匹配会导致取值失败，需要统一命名。
• 所有表单字段的类型转换会自动完成，无需额外处理，比如日期类型会自动转为DateTimeInterface对象，数值类型会自动转为int/float等。

内容的提问来源于stack exchange，提问作者Urban Dormz