Поле BirthdayType¶
Поле DateType, которое специализируется на работе с данными о дате рождения.
Может быть отображено, как одно текстовое поле, три текстовых поля (месяц, день и год) или три поля выбора.
Этот тип по сути такой же, как и тип DateType, но с более правильным значением по умолчанию для опции years. Опция years по умолчанию равняется 120 годам назад от текущего года.
Основоположный тип данных | может быть DateTime , string , timestamp , или array
(см. опцию ввода) |
Отображается как | три поля выбора, 1 или 3 текстовых поля, основываясь на опции widget |
Переопределённые опции | |
Наследуемые опции | из DateType: из FormType: |
Тип родителя | DateType |
Класс | BirthdayType |
Переопределённые опции¶
years¶
тип: array
по умолчанию: 120 лет назад от текущего года
Список годов, доступных в типе поля год. Эта опция имеет значение только
когда опция widget
установлена, как choice
.
Наследуемые опции¶
Эти опции наследуются из DateType:
choice_translation_domain
¶
DEFAULT_VALUE
This option determines if the choice values should be translated and in which translation domain.
The values of the choice_translation_domain
option can be true
(reuse the current
translation domain), false
(disable translation), null
(uses the parent translation
domain or the default domain) or a string which represents the exact translation
domain to use.
days
¶
type: array
default: 1 to 31
List of days available to the day field type. This option is only relevant
when the widget
option is set to choice
:
'days' => range(1,31)
placeholder¶
тип: string
| array
Если ваша оцпия виджета установлена, как choice
, то это поле будет представлено
как набор полей выбора select
. Когда значение заполнителя является строкой, оно
будет использовано в качестве пустого значения всех полей выбора:
$builder->add('birthdate', BirthdayType::class, array(
'placeholder' => 'Select a value',
));
Как вариант, вы можете использовать массив, который конфигурирует разные значения заполнителей для полей года, месяца и дня:
$builder->add('birthdate', BirthdayType::class, array(
'placeholder' => array(
'year' => 'Year', 'month' => 'Month', 'day' => 'Day',
)
));
format
¶
type: integer
or string
default: IntlDateFormatter::MEDIUM
(or yyyy-MM-dd
if widget is single_text
)
Option passed to the IntlDateFormatter
class, used to transform user
input into the proper format. This is critical when the widget option
is set to single_text
and will define how the user will input the data.
By default, the format is determined based on the current user locale: meaning
that the expected format will be different for different users. You can
override it by passing the format as a string.
For more information on valid formats, see Date/Time Format Syntax:
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',
]);
Note
If you want your field to be rendered as an HTML5 “date” field, you
have to use a single_text
widget with the yyyy-MM-dd
format
(the RFC 3339 format) which is the default value if you use the
single_text
widget.
input
¶
type: string
default: datetime
The format of the input data - i.e. the format that the date is stored on your underlying object. Valid values are:
string
(e.g.2011-06-05
)datetime
(aDateTime
object)datetime_immutable
(aDateTimeImmutable
object)array
(e.g.['year' => 2011, 'month' => 06, 'day' => 05]
)timestamp
(e.g.1307232000
)
The value that comes back from the form will also be normalized back into this format.
Caution
If timestamp
is used, DateType
is limited to dates between
Fri, 13 Dec 1901 20:45:54 GMT and Tue, 19 Jan 2038 03:14:07 GMT on 32bit
systems. This is due to a limitation in PHP itself.
model_timezone
¶
type: string
default: system default timezone
Timezone that the input data is stored in. This must be one of the PHP supported timezones.
months
¶
type: array
default: 1 to 12
List of months available to the month field type. This option is only relevant
when the widget
option is set to choice
.
view_timezone
¶
type: string
default: system default timezone
Timezone for how the data should be shown to the user (and therefore also the data that the user submits). This must be one of the PHP supported timezones.
widget
¶
type: string
default: choice
The basic way in which this field should be rendered. Can be one of the following:
choice
: renders three select inputs. The order of the selects is defined in the format option.text
: renders a three field input of typetext
(month, day, year).single_text
: renders a single input of typedate
. User’s input is validated based on the format option.
Эти опции наследуются из FormType:
data
¶
type: mixed
default: Defaults to field of the underlying structure.
When you create a form, each field initially displays the value of the corresponding property of the form’s domain data (e.g. if you bind an object to the form). If you want to override this initial value for the form or an individual field, you can set it in the data option:
use Symfony\Component\Form\Extension\Core\Type\HiddenType;
// ...
$builder->add('token', HiddenType::class, [
'data' => 'abcdef',
]);
Caution
The data
option always overrides the value taken from the domain data
(object) when rendering. This means the object value is also overridden when
the form edits an already persisted object, causing it to lose its
persisted value when the form is submitted.
disabled
¶
type: boolean
default: false
If you don’t want a user to modify the value of a field, you can set the disabled option to true. Any submitted value will be ignored.
inherit_data
¶
type: boolean
default: false
This option determines if the form will inherit data from its parent form. This can be useful if you have a set of fields that are duplicated across multiple forms. See How to Reduce Code Duplication with “inherit_data”.
Caution
When a field has the inherit_data
option set, it uses the data of
the parent form as is. This means that
Data Transformers won’t be
applied to that field.
invalid_message
¶
type: string
default: This value is not valid
This is the validation error message that’s used if the data entered into this field doesn’t make sense (i.e. fails validation).
This might happen, for example, if the user enters a nonsense string into
a TimeType field that cannot be converted
into a real time or if the user enters a string (e.g. apple
) into a
number field.
Normal (business logic) validation (such as when setting a minimum length for a field) should be set using validation messages with your validation rules (reference).
invalid_message_parameters
¶
type: array
default: []
When setting the invalid_message
option, you may need to
include some variables in the string. This can be done by adding placeholders
to that option and including the variables in this option:
$builder->add('someField', SomeFormType::class, [
// ...
'invalid_message' => 'You entered an invalid value, it should include %num% letters',
'invalid_message_parameters' => ['%num%' => 6],
]);
mapped
¶
type: boolean
default: true
If you wish the field to be ignored when reading or writing to the object,
you can set the mapped
option to false
.
Эта документация является переводом официальной документации Symfony и предоставляется по свободной лицензии CC BY-SA 3.0.