跳到内容

BirthdayType 字段

编辑此页

一个 DateType 字段,专门用于处理出生日期数据。

可以渲染为单个文本框、三个文本框(月、日和年),或三个选择框。

此类型本质上与 DateType 类型相同,但 years 选项具有更合适的默认值。 years 选项默认为从 120 年前至今。

底层数据类型 可以是 DateTimestringtimestamparray (参见 input 选项
渲染为 可以是三个选择框,或 1 个或 3 个文本框,取决于 widget 选项
默认无效消息 请输入有效的出生日期。
父类型 DateType
BirthdayType

提示

此表单类型定义和继承的完整选项列表可通过在您的应用中运行此命令获得

1
2
# replace 'FooType' by the class name of your form type
$ php bin/console debug:form FooType

重写选项

invalid_message

类型: string 默认值: 此值无效

这是验证错误消息,当在此字段中输入的数据没有意义时(即验证失败)使用。

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

正常的(业务逻辑)验证(例如,当为字段设置最小长度时)应使用带有验证规则的验证消息来设置( 参考 )。

years

类型: array 默认值: 从 120 年前至今

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

继承选项

这些选项继承自 DateType

choice_translation_domain

类型: string, booleannull 默认值: false

此选项确定是否应翻译 choice 值以及在哪个翻译域中翻译。

choice_translation_domain 选项的值可以是 true (重用当前翻译域)、 false (禁用翻译)、 null (使用父翻译域或默认域)或表示要使用的确切翻译域的字符串。

days

类型: array 默认值: 1 到 31

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

1
'days' => range(1,31)

placeholder

类型: string | array

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

1
2
3
$builder->add('birthdate', BirthdayType::class, [
    'placeholder' => 'Select a value',
]);

或者,您可以使用一个数组,为年、月和日字段配置不同的 placeholder 值

1
2
3
4
5
$builder->add('birthdate', BirthdayType::class, [
    'placeholder' => [
        'year' => 'Year', 'month' => 'Month', 'day' => 'Day',
    ],
]);

format

类型: integerstring 默认值: IntlDateFormatter::MEDIUM (如果 widgetsingle_text ,则为 yyyy-MM-dd

传递给 IntlDateFormatter 类的选项,用于将用户输入转换为正确的格式。当 widget 选项设置为 single_text 时,这至关重要,并将定义用户如何输入数据。默认情况下,格式根据当前用户区域设置确定:这意味着 不同用户的预期格式将不同 。您可以通过将格式作为字符串传递来覆盖它。

有关有效格式的更多信息,请参阅 Date/Time Format Syntax

1
2
3
4
5
6
7
8
use Symfony\Component\Form\Extension\Core\Type\DateType;
// ...

$builder->add('dateCreated', DateType::class, [
    'widget' => 'single_text',
    // this is actually the default format for single_text
    'format' => 'yyyy-MM-dd',
]);

注意

如果您希望将字段呈现为 HTML5 “date” 字段,则必须使用 single_text widget 和 yyyy-MM-dd 格式( RFC 3339 格式),如果您使用 single_text widget,这是默认值。

input

类型: string 默认值: datetime

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

  • string (例如 2011-06-05 )
  • datetime ( DateTime 对象)
  • datetime_immutable ( DateTimeImmutable 对象)
  • array (例如 ['year' => 2011, 'month' => 06, 'day' => 05] )
  • timestamp (例如 1307232000 )

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

警告

如果使用 timestamp ,则在 32 位系统上, DateType 仅限于 1901 年 12 月 13 日星期五 20:45:54 UTC 和 2038 年 1 月 19 日星期二 03:14:07 UTC 之间的日期。这是由于 32 位系统中称为 Year 2038 problem 的整数溢出错误造成的。

input_format

类型: string 默认值: Y-m-d

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

model_timezone

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

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

months

类型: array 默认值: 1 到 12

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

view_timezone

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

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

widget

类型: string 默认值: single_text

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

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

这些选项继承自 FormType

attr

类型: array 默认值: []

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

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

另请参阅

如果您想将这些属性添加到 表单类型行 元素,请使用 row_attr 选项。

data

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

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

1
2
3
4
5
6
use Symfony\Component\Form\Extension\Core\Type\HiddenType;
// ...

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

警告

data 选项始终覆盖渲染时从域数据(对象)获取的值。这意味着当表单编辑已持久化的对象时,对象值也会被覆盖,导致它在提交表单时丢失其持久化的值。

disabled

类型: boolean 默认值: false

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

help

类型: stringTranslatableInterface 默认值: 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”减少代码重复

警告

当字段设置了 inherit_data 选项时,它会按原样使用父表单的数据。这意味着 Data Transformers 将不会应用于该字段。

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' => '...'],
]);

另请参阅

如果您想将这些属性添加到 表单类型 widget 元素,请使用 attr 选项。

本作品,包括代码示例,根据 Creative Commons BY-SA 3.0 许可协议获得许可。
目录
    版本