Поле DateTimeType

Этот тип поля позволяет пользователю изменять данные, которые представляют конкретную дату и время (например, 1984-06-05 12:15:30).

Может быть отображён как текстовый ввод или теги выбора. Основоположный формат даты может быть объектом DateTime, строкой, временной меткой или массивом.

Основоположный тип данных может быть DateTime, строкой, временной меткой или массивом (см. опцию input)
Отображается как одно текстовое поле или три поля выбора
Опции
Переопределённые опции
Наследуемые опции
Родительский тип FormType
Класс DateTimeType

Опции поля

choice_translation_domain

type: string, boolean or null

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.

date_format

тип: integer or string по умолчанию: IntlDateFormatter::MEDIUM

Определяет опцию format, которая будет передана полю даты. См. опцию формата DateType, чтобы узнать больше.

date_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 type text (month, day, year).
  • single_text: renders a single input of type date. User's input is validated based on the format option.

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:

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

placeholder

тип: string | array

Если ваша опция виджета установлена, как choice, то это поле будет представлено в виде ряда полей select. Когда значение заполнителя является строкой, оно будет использовано, как пустое значение всех полей выбора:

1
2
3
4
5
use Symfony\Component\Form\Extension\Core\Type\DateTimeType;

$builder->add('startDateTime', DateTimeType::class, array(
    '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, array(
    'placeholder' => array(
        '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 будет воспринимать заданный ввод строки даты и времени. По умолчанию - это формат RFC 3339, который используется полем HTML5 datetime. Если вы оставите значение по умолчанию, поле будет отображено, как поле input с type="datetime".

hours

type: array default: 0 to 23

List of hours available to the hours field type. This option is only relevant when the widget option is set to choice.

html5

type: boolean default: true

If this is set to true (the default), it'll use the HTML5 type (date, time or datetime) to render the field. When set to false, it'll use the text type.

This is useful when you want to use a custom JavaScript datepicker, which often requires a text type instead of an HTML5 type.

input

тип: string default: datetime

Формат данных ввода - т.е. формат, в котором хранится дата вашего основоположного объекта. Валидные значения:

  • string (например, 2011-06-05 12:15:00)
  • datetime (объект DateTime)
  • datetime_immutable (a DateTimeImmutable object)
  • array (например, array(2011, 06, 05, 12, 15, 0))
  • timestamp (например, 1307276100)

Значение, которое возвращается из формы, также будет нормализовано обратно в этот формат.

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.

minutes

type: array default: 0 to 59

List of minutes available to the minutes field type. This option is only relevant when the widget option is set to choice.

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.

seconds

type: array default: 0 to 59

List of seconds available to the seconds field type. This option is only relevant when the widget option is set to choice.

time_widget

тип: string по умолчанию: choice

Определяет опцию widget для TimeType.

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

тип: string по умолчанию: null

Определяет опцию widget для DateType и TimeType. Это можно переопределить с опциями date_widget и time_widget.

with_minutes

type: boolean default: true

Whether or not to include minutes in the input. This will result in an additional input to capture minutes.

with_seconds

type: boolean default: false

Whether or not to include seconds in the input. This will result in an additional input to capture seconds.

years

type: array default: five years before to five years after the current year

List of years available to the year field type. This option is only relevant when the widget option is set to choice.

Переопределённые опции

by_reference

по умолчанию: false

Классы DateTime рассматриваются, как неизменные объекты.

compound

type: boolean default: false

This option specifies whether the type contains child types or not. This option is managed internally for built-in types, so there is no need to configure it explicitly.

data_class

type: string default: null

The internal normalized representation of this type is an array, not a \DateTime object. Therefore, the data_class option is initialized to null to avoid the FormType object from initializing it to \DateTime.

error_bubbling

по умолчанию: false

Наследуемые опции

Эти опции наследуются из 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:

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

$builder->add('token', HiddenType::class, array(
    '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 overriden 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: array()

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:

1
2
3
4
5
$builder->add('some_field', SomeFormType::class, array(
    // ...
    'invalid_message' => 'You entered an invalid value, it should include %num% letters',
    'invalid_message_parameters' => array('%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.

Переменные поля

Переменная Тип Применение
widget mixed Значение опции widget.
type string Присутствует, только если виджет - single_text и активирован HTML5, содержит тип ввода для использования (datetime, date или time).

Эта документация является переводом официальной документации Symfony и предоставляется по свободной лицензии CC BY-SA 3.0.