DateTimeType 字段

date_format

类型: integer 或 string 默认值: IntlDateFormatter::MEDIUM

定义将传递给日期字段的 format 选项。有关更多详细信息，请参阅 DateType 的 format 选项。

date_label

类型: string | null 默认值: 标签从字段名称中“猜测”得出

设置渲染日期部件时将使用的标签。将其设置为 false 将抑制标签

1
2
3
4
5

use Symfony\Component\Form\Extension\Core\Type\DateTimeType;

$builder->add('startDateTime', DateTimeType::class, [
    'date_label' => 'Starts On',
]);

date_widget

类型: string 默认值: single_text

此字段应渲染的基本方式。可以是以下之一

• choice: 渲染三个选择输入框。选择框的顺序在 format 选项中定义。
• text: 渲染一个包含三个字段的输入框，类型为 text (月、日、年)。
• single_text: 渲染一个类型为 date 的单个输入框。用户的输入将根据 format 选项进行验证。

days

类型: array 默认值: 1 到 31

可用于日期字段类型的日期列表。仅当 widget 选项设置为 choice 时，此选项才相关

1

'days' => range(1,31)

placeholder

类型: string | array

如果你的 widget 选项设置为 choice，则此字段将表示为一系列 select 框。当占位符值是字符串时，它将用作所有选择框的空白值

1
2
3
4
5

use Symfony\Component\Form\Extension\Core\Type\DateTimeType;

$builder->add('startDateTime', DateTimeType::class, [
    'placeholder' => 'Select a value',
]);

或者，你可以使用一个数组，为年、月、日、小时、分钟和秒字段配置不同的占位符值

1
2
3
4
5
6
7
8

use Symfony\Component\Form\Extension\Core\Type\DateTimeType;

$builder->add('startDateTime', DateTimeType::class, [
    'placeholder' => [
        'year' => 'Year', 'month' => 'Month', 'day' => 'Day',
        'hour' => 'Hour', 'minute' => 'Minute', 'second' => 'Second',
    ],
]);

format

类型: string 默认值: Symfony\Component\Form\Extension\Core\Type\DateTimeType::HTML5_FORMAT

如果 widget 选项设置为 single_text，则此选项指定输入的格式，即 Symfony 将如何将给定的输入解释为日期时间字符串。它默认为 HTML5 datetime-local 字段使用的 datetime local 格式。保持默认值将导致该字段渲染为 input 字段，其 type="datetime-local"。有关有效格式的更多信息，请参阅 日期/时间格式语法。

hours

类型: array 默认值: 0 到 23

可用于小时字段类型的小时列表。仅当 widget 选项设置为 choice 时，此选项才相关。

html5

类型: boolean 默认值: true

如果设置为 true (默认值)，它将使用 HTML5 类型 (date、time 或 datetime-local) 来渲染字段。当设置为 false 时，它将使用文本类型。

当你想要使用自定义 JavaScript 日期选择器时，这非常有用，它通常需要文本类型而不是 HTML5 类型。

input

类型: string 默认值: datetime

输入数据的格式 - 即日期存储在你的底层对象上的格式。有效值包括

• string (例如 2011-06-05 12:15:00)
• datetime (DateTime 对象)
• datetime_immutable (DateTimeImmutable 对象)
• array (例如 [2011, 06, 05, 12, 15, 0])
• timestamp (例如 1307276100)

从表单返回的值也将被规范化回此格式。

input_format

类型: string 默认值: Y-m-d H:i:s

如果 input 选项设置为 string，则此选项指定日期的格式。这必须是有效的 PHP 日期格式。

minutes

类型: array 默认值: 0 到 59

可用于分钟字段类型的分钟列表。仅当 widget 选项设置为 choice 时，此选项才相关。

model_timezone

类型: string 默认值: 系统默认时区

输入数据存储的时区。这必须是 PHP 支持的时区 之一。

months

类型: array 默认值: 1 到 12

可用于月份字段类型的月份列表。仅当 widget 选项设置为 choice 时，此选项才相关。

seconds

类型: array 默认值: 0 到 59

可用于秒字段类型的秒数列表。仅当 widget 选项设置为 choice 时，此选项才相关。

time_label

类型: string | null 默认值: 标签从字段名称中“猜测”得出

设置渲染时间部件时将使用的标签。将其设置为 false 将抑制标签

1
2
3
4
5

use Symfony\Component\Form\Extension\Core\Type\DateTimeType;

$builder->add('startDateTime', DateTimeType::class, [
    'time_label' => 'Starts On',
]);

time_widget

类型: string 默认值: choice

定义 TimeType 的 widget 选项。

view_timezone

类型: string 默认值: 系统默认时区

数据应向用户显示的时区 (因此也是用户提交的数据)。这必须是 PHP 支持的时区 之一。

widget

类型: string 默认值: null

为 DateType 和 TimeType 定义 widget 选项。可以使用 date_widget 和 time_widget 选项覆盖它。

with_minutes

类型: boolean 默认值: true

是否在输入中包含分钟。这将导致额外的输入来捕获分钟。

with_seconds

类型: boolean 默认值: false

是否在输入中包含秒。这将导致额外的输入来捕获秒。

years

类型: array 默认值: 当前年份前五年到后五年

可用于年份字段类型的年份列表。仅当 widget 选项设置为 choice 时，此选项才相关。

by_reference

默认值: false

DateTime 类被视为不可变对象。

compound

类型: boolean 默认值: false

此选项指定该类型是否包含子类型。此选项在内置类型中进行内部管理，因此无需显式配置它。

data_class

类型: string 默认值: null

此类型的内部规范化表示形式是一个数组，而不是 \DateTime 对象。因此，data_class 选项被初始化为 null，以避免 FormType 对象将其初始化为 \DateTime。

error_bubbling

默认值: false

invalid_message

类型: string 默认值: This value is not valid

如果输入到此字段的数据没有意义 (即验证失败)，则会使用此验证错误消息。

例如，如果用户在 TimeType 字段中输入了无法转换为实际时间的无意义字符串，或者如果用户在数字字段中输入了字符串 (例如 apple)，则可能会发生这种情况。

正常的 (业务逻辑) 验证 (例如设置字段的最小长度) 应使用验证规则的验证消息进行设置 (参考)。

attr

类型: array 默认值: []

如果想向 HTML 字段表示形式添加额外的属性，可以使用 attr 选项。它是一个关联数组，其中 HTML 属性作为键。当需要为某些部件设置自定义类时，这可能很有用

1
2
3

$builder->add('body', TextareaType::class, [
    'attr' => ['class' => 'tinymce'],
]);

data

类型: mixed 默认值: 默认为底层结构的字段。

创建表单时，每个字段最初显示表单域数据的相应属性值 (例如，如果将对象绑定到表单)。如果想要覆盖表单或单个字段的此初始值，可以在 data 选项中设置它

1
2
3
4
5
6

use Symfony\Component\Form\Extension\Core\Type\HiddenType;
// ...

$builder->add('token', HiddenType::class, [
    'data' => 'abcdef',
]);

disabled

类型: boolean 默认值: false

如果不希望用户修改字段的值，可以将 disabled 选项设置为 true。任何提交的值都将被忽略。

help

type: string 或 TranslatableInterface default: null

允许您为表单字段定义帮助消息，默认情况下，该消息呈现在字段下方

1
2
3
4
5
6
7
8
9
10
11
12
13

use Symfony\Component\Translation\TranslatableMessage;

$builder
    ->add('zipCode', null, [
        'help' => 'The ZIP/Postal code for your credit card\'s billing address.',
    ])

    // ...

    ->add('status', null, [
        'help' => new TranslatableMessage('order.status', ['%order_id%' => $order->getId()], 'store'),
    ])
;

help_attr

类型: array 默认值: []

设置用于显示表单字段帮助消息的元素的 HTML 属性。其值是一个关联数组，其中 HTML 属性名称作为键。这些属性也可以在模板中设置

1
2
3

{{ form_help(form.name, 'Your name', {
    'help_attr': {'class': 'CUSTOM_LABEL_CLASS'}
}) }}

help_html

类型: boolean 默认值: false

默认情况下，help 选项的内容在模板中呈现之前会被转义。将此选项设置为 true 可不转义它们，这在帮助内容包含 HTML 元素时非常有用。

inherit_data

类型: boolean 默认值: false

此选项确定表单是否将从其父表单继承数据。如果您有一组字段在多个表单中重复，这将非常有用。请参阅 如何使用 "inherit_data" 减少代码重复。

invalid_message_parameters

类型: array 默认值: []

当设置 invalid_message 选项时，您可能需要在字符串中包含一些变量。这可以通过向该选项添加占位符并将变量包含在此选项中来完成

1
2
3
4
5

$builder->add('someField', SomeFormType::class, [
    // ...
    'invalid_message' => 'You entered an invalid value, it should include %num% letters',
    'invalid_message_parameters' => ['%num%' => 6],
]);

mapped

类型: boolean 默认值: true

如果您希望在读取或写入对象时忽略该字段，您可以将 mapped 选项设置为 false。

row_attr

类型: array 默认值: []

添加到用于呈现 表单类型行 的元素的 HTML 属性的关联数组

1
2
3

$builder->add('body', TextareaType::class, [
    'row_attr' => ['class' => 'text-editor', 'id' => '...'],
]);