SymfonyのDateType::classでハマった

SymfonyのDateType::classでハマったのでメモしておく。

どのような事が起きていたのか？

値を正しくFormからPostしていたのに、DataTransformerのreverseTransformで値が取得できないという事態に遭遇。

DatePickerを利用して開始日、終了日を選んでもらうフォームで、入力するもの。
諸事情により、Setterを避けたかったので、CallbackTransformerを使って、Entityをnewして生成している。

FormTypeはこんな感じ

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39


<?php

declare(strict_types=1);

namespace App\Form\Type

use App\Entity\Term
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\CallbackTransformer;
use Symfony\Component\Form\Extension\Core\Type\DateType;
use Symfony\Component\Form\FormBuilderInterface;

class TermType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder->add('start', DateType::class, [
            'label' => '開始日',
            'widget' => 'single_text',
            'attr' => ['class' => 'datepicker-start']
        ]);

        $builder->add('end', DateType::class, [
            'label' => '終了日',
            'widget' => 'single_text',
            'attr' => ['class' => 'datepicker-end']
        ]);

        $builder->addModelTransformer(new CallbackTransformer(function ($data) {
            if ($data instanceof \DateTime) {
                return $data->format('Y/m/d');
            }

            return null;
        }, function ($data) {
            return new Term($data['start'], $data['end']);
        }));
    }
}

CallbackTransformerのnew Term($data['start'], $data['end']);部分で$data変数が空になってしまい「Notice: Undefined index: start」って怒られてしまう・・・。

なにが原因だったのか？

DateTypeのフォーマットの問題だった。 DateType::classはDateTimeToLocalizedStringTransformerを利用して日付のStringを\DateTime::classに変換しているんだけど、変換する際にフォーマットを指定する必要がある。
マニュアルを見る限りデフォルトは (Jan 12, 1952)の形式らしいが、今回はY/m/dだったためにエラーが起こっていたようだった。
※Y-m-dの形式なら大丈夫なんだけどね・・・。この辺ちゃんと理解できてないの。。。

どう解決するのか？

$builder->add()でformatを指定すればいい。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41


<?php

declare(strict_types=1);

namespace App\Form\Type

use App\Entity\Term
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\CallbackTransformer;
use Symfony\Component\Form\Extension\Core\Type\DateType;
use Symfony\Component\Form\FormBuilderInterface;

class TermType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder->add('start', DateType::class, [
            'label' => '開始日',
            'widget' => 'single_text',
            'format' => "yyyy/MM/dd",
            'attr' => ['class' => 'datepicker-start']
        ]);

        $builder->add('end', DateType::class, [
            'label' => '終了日',
            'widget' => 'single_text',
            'format' => "yyyy/MM/dd",
            'attr' => ['class' => 'datepicker-end']
        ]);

        $builder->addModelTransformer(new CallbackTransformer(function ($data) {
            if ($data instanceof \DateTime) {
                return $data->format('Y/m/d');
            }

            return null;
        }, function ($data) {
            return new Term($data['start'], $data['end']);
        }));
    }
}