Поле DateIntervalType

Дата обновления перевода 2023-09-25

Поле DateIntervalType

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

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

?????????????? ??? ?????? ????? ???? DateInterval, ??????? ??? ???????? (??. ????? input)
???????????? ??? ???? ??? ????????? ????????? ???? ??? ????? ?????? - ??. ????? widget
????????? ???????????? ?? ????????? ??????????, ???????? ???????? ???????? ???.
??????????? ????????? ???????????? ???????? {{ value }} ?? ???????? ????????.
???????????? ??? FormType
????? DateIntervalType

Tip

The full list of options defined and inherited by this form type is available running this command in your app:

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

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

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

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

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

    // настройте, какие текстовые поля отображаются
    'with_years'  => false,
    'with_months' => false,
    'with_days'   => true,
    'with_hours'  => true,
));

Опции поля

days

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

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

1
2
3
4
5
// значения, отображённые пользователю, варьируются от 0 до 30 (включительно)
'days' => range(1, 31),

// значения, отображённые пользователю, варьируются от 0 до 31 (включительно)
'days' => array_combine(range(1, 31), 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
2
3
4
5
// значения, отображённые пользователю, варьируются от 0 до 23 (включительно)
'hours' => range(1, 24),

// значения, отображённые пользователю, варьируются от 0 до 24 (включительно)
'hours' => array_combine(range(1, 24), range(1, 24)),

input

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

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

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

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

labels

тип: 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
2
3
4
5
// значения, отображённые пользователю, варьируются от 0 до 59 (включительно)
'minutes' => range(1, 60),

// значения, отображённые пользователю, варьируются от 0 до 60 (включительно)
'minutes' => array_combine(range(1, 60), range(1, 60)),

months

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

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

1
2
3
4
5
// значения, отображённые пользователю, варьируются от 0 до 1 (включительно)
'months' => range(1, 12),

// значения, отображённые пользователю, варьируются от 0 до 12 (включительно)
'months' => array_combine(range(1, 12), range(1, 12)),

seconds

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

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

1
2
3
4
5
// значения, отображённые пользователю, варьируются от 0 до 59 (включительно)
'seconds' => range(1, 60),

// значения, отображённые пользователю, варьируются от 0 до 60 (включительно)
'seconds' => array_combine(range(1, 60), range(1, 60)),

weeks

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

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

1
2
3
4
5
// значения, отображённые пользователю, варьируются от 0 до 51 (включительно)
'weeks' => range(1, 52),

// значения, отображённые пользователю, варьируются от 0 до 52 (включительно)
'weeks' => array_combine(range(1, 52), 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 до 100

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

1
2
3
4
5
// values displayed to users range from 0 to 99 (both inclusive)
'years' => range(1, 100),

// values displayed to users range from 1 to 100 (both inclusive)
'years' => array_combine(range(1, 100), range(1, 100)),

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

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 ).

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

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

attr

тип: array по умолчанию: array()

Если вы хотите добавить дополнительные атрибуты к HTML представлению поля, то вы можете использовать опцию attr. Это ассоциативный массив с HTML-атрибутами в качестве ключей. Этоможет быть полезно, когда вам нужно установить для некоторого виджета пользовательский класс:

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

data

тип: mixed по умолчанию : По умолчанию является полем основоположной структуры.

Когда вы создаёте форму, каждое поле изначально отображает значение соотствующего свойства данных домена формы (например, если вы привязываете объект к форме). Если вы хотите переопределить эти изначальные значения для формы или индивидуального поля, вы можете установить это в опции данных:

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

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

Caution

Опция data всегда переопределяет значение, взятое из данных домена (объекта) при отображении. Это означает, что значение объекта также переопределяется, когда форма редактирует уже существующий сохранённый объект, что приводит к потере сохранённого значения при отправке формы.

disabled

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

Если вы не хотите, чтобы пользователь изменял значение поля, то вы можете установить опцию отключения, как "true". Любые отправленные данные будут проигнорированы.

Дата обновления перевода 2024-07-26

help

тип: string или TranslatableInterface по умолчанию: 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

type: array default: []

Sets the HTML attributes for the element used to display the help message of the form field. Its value is an associative array with HTML attribute names as keys. These attributes can also be set in the template:

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

help_html

type: boolean default: false

By default, the contents of the help option are escaped before rendering them in the template. Set this option to true to not escape them, which is useful when the help contains HTML elements.

inherit_data

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

Эта опция определяет, будет ли форма наследовать данные из родительской формы. Это может быть полезной, если у вас есть набор полей, которые повторяется в нескольких формах. См. Как уменьшить дублирование кода с помощью "inherit_data".

Caution

Когда поле имеет установленную опцию inherit_data, оно использует данные родительской формы так, как они есть. Это означает, что Преобразователи Данных не будут применяться к этому полю.

invalid_message_parameters

тип: array по умолчанию: array()

При установке опции invalid_message вам может понадобиться включить в строку некоторые переменные. Это можно сделать, добавив заполнители в эту опцию,и включив переменные в этой опции:

1
2
3
4
5
$builder->add('some_field', SomeFormType::class, array(
    // ...
    'invalid_message' => 'Вы ввели невалидное значение, оно должносодержать %num% букв',
    'invalid_message_parameters' => array('%num%' => 6),
));

mapped

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

Если вы хотите, чтобы поле было проигнорировано про чтении или записи в него объетка, вы можете установить опцию mapped, как false.

row_attr

type: array default: []

An associative array of the HTML attributes added to the element which is used to render the form type row :

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

See also

Use the attr option if you want to add these attributes to the form type widget element.

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

?????????? ??? ??????????
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.