Поле DateIntervalType

New in version 3.2: Тип поля DateIntervalType был представлен в Symfony 3.2.

Это поле позволяет польозвателю выбирать интервал времени. Например, если вы хотите разрешить пользователю выбирать как часто он будет получать электронное письмо со статусом, то он может использовать этополе, чтобы выбирать интервалы, вроде каждые "10 минут" или "3 дня".

Поле также может быть отображено множеством разных способов (см. widget) и может быть сконфигурировано так, чтобы давать вам объект DateInterval, строку продолжительности ISO 8601 (например, P1DT12H) или массив (см. input).

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

Базовое применение

Этот тип поля высоко конфигурируемый, но прост в использовании. Наиболее важными опциями являются input и widget.

Вы можете сконфигурировать много разных опций, включая то, какие именно опции диапазона показывать (например, не показывать "месяцы", но показывать "дни"):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
$builder->add('remindEvery', DateIntervalType::class, array(
    'widget'      => 'integer', // отобразить текстовое поле для каждой части
    // 'input'    => 'string',  // если вы хотите, чтобы поле вернуло вам строку ISO 8601

    // customize which text boxes are shown
    'with_years'  => false,
    'with_months' => false,
    'with_days'   => true,
    'with_hours'  => true,
));

Опции поля

days

тип: array по умолчанию: от 0 до 31

Список дней, доступных в типе поля дни. Эта опция важна только тогда, когда опция widget установлена, как choice:

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

placeholder

тип: string или array

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

1
2
3
$builder->add('remindEvery', DateIntervalType::class, array(
    'placeholder' => '',
));

Как вариант, вы можете указать, чтобы для "пустого" значения отображалась строка:

1
2
3
$builder->add('remindEvery', DateIntervalType::class, array(
    'placeholder' => array('years' => 'Years', 'months' => 'Months', 'days' => 'Days')
));

hours

тип: array по умолчанию: от 0 до 24

Список часов, доступных типу поля часы. Эта опция важна только тогда, когда опция widget установлена, как choice:

1
'hours' => range(1, 24)

input

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

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

  • string (строка, форматированная стандартом ISO 8601, например, P7Y6M5DT12H15M30S)
  • dateinterval (объект DateInterval)
  • array (например, array('days' => '1', 'hours' => '12',))

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

labels

New in version 3.3: Опция labels была представлена в Symfony 3.3.

тип: array по умолчанию: (см. ниже)

Ярлыки, отображённые для каждого из элементов этого типа. Значения по умолчанию - null, поэтому они отображают "человеческую версию" дочерних имён (Invert, Years, и т.д.):

1
2
3
4
5
6
7
8
9
'labels' => array(
    'invert' => null,
    'years' => null,
    'months' => null,
    'days' => null,
    'hours' => null,
    'minutes' => null,
    'seconds' => null,
)

minutes

тип: array по умолчанию: от 0 до 60

Список минут, доступных типу поля минуты. Эта опция важна только тогда, когда опция widget установлена, как choice:

1
'minutes' => range(1, 60)

months

тип: array по умолчанию: от 0 до 12

Список месяцев, доступных типу поля месяцы. Эта опция важна только тогда, когда опция widget установлена, как choice:

1
'months' => range(1, 12)

seconds

тип: array по умолчанию: от 0 до 60

Список секунд, доступных типу поля секунды. Эта опция важна только тогда, когда опция widget установлена, как choice:

1
'seconds' => range(1, 60)

weeks

тип: array по умолчанию: от 0 до 52

Список недель, доступных типу поля недели. Эта опция важна только тогда, когда опция widget установлена, как choice:

1
'weeks' => range(1, 52)

widget

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

Основной способ, которым должно быть отображено это поле. Может быть одним из следующих:

  • choice: отображает от одного до шести вводов для годов, месяцев, недель, дней, часов, минут и / или секунд, в зависимости от опций with_years, with_months, with_weeks, with_days, with_hours, with_minutes и with_seconds. По умолчанию: Три поля для годов, месяцев и дней.
  • text: отображает от одного до шести текстовых вводов для годов, месяцев, недель, дней, часов, минут и / или секунд, в зависимости от опций with_years, with_months, with_weeks, with_days, with_hours, with_minutes и with_seconds. По умолчанию: Три поля для годов, месяцев и дней.
  • integer: отображает от одного до шести числовых вводов для годов, месяцев, недель, дней, часов, минут и / или секунд, в зависимости от опций with_years, with_months, with_weeks, with_days, with_hours, with_minutes и with_seconds. По умолчанию: Три поля для годов, месяцев и дней.
  • single_text: отображает один ввод типа text. Пользовательский ввод будет валидировн с формой PnYnMnDTnHnMnS (или PnW, если используются только недели).

with_days

тип: Boolean по умолчанию: true

Включать ли дни во ввод. Это приведёт к дополнительному вводу для фиксаци дней.

Caution

Не может быть использовано, когда включена with_weeks.

with_hours

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

Включать ли часы во ввод. Это приведёт к дополнительному вводу для фиксаци часов.

with_invert

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

Включать ли инверсию во ввод. Это приведёт к дополнительному чекбоксу. Не может быть использовано, когда опция widget установлена, как single_text.

with_minutes

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

Включать ли минуты во ввод. Это приведёт к дополнительному вводу для фиксаци минут.

with_months

тип: Boolean по умолчанию: true

Включать ли месяцы во ввод. Это приведёт к дополнительному вводу для фиксаци месяцев.

with_seconds

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

Включать ли секунды во ввод. Это приведёт к дополнительному вводу для фиксаци секунд.

with_weeks

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

Включать ли недели во ввод. Это приведёт к дополнительному вводу для фиксаци недель.

Caution

Не может быть использовано, когда включена with_days.

with_years

тип: Boolean по умолчанию: true

Включать ли годы во ввод. Это приведёт к дополнительному вводу для фиксаци годов.

years

тип: array по умолчанию: 0 to 100

Список годов, доступпных в типе поля год. Эта опция важна только тогда, когда опция widget установлена, как choice:

1
'years' => range(1, 100)

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

Эти опции наследуются из типа form:

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.
with_days Boolean Значение опции with_days.
with_invert Boolean Значение опции with_invert.
with_hours Boolean Значение опции with_hours.
with_minutes Boolean Значение опции with_minutes.
with_months Boolean Значение опции with_months.
with_seconds Boolean Значение опции with_seconds.
with_weeks Boolean Значение опции with_weeks.
with_years Boolean Значение опции with_years.

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