Поле TimeType

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

Поле TimeType

Поле для визначення введення часу.

Може бути відображене як текстове поле, ряд текстових полів (наприклад, година, хвилина, секунда) або ряд полів вибору. Основні дані можуть зберігатися як обʼєкт DateTime, рядок, часова відмітка або масив.

??????? ???? ???? ???? DateTime, ??????, ??????? ????????? ??? ??????? (???. ????? input)
?????????????? ?? ???? ???? ??????? ?????? (???. ?????)
???????????? ???????????? ?? ????????????? ???? ?????, ??????? ???????? ???.
??????????? ???????????? ???????????? ???????? {{ value }} ?? ? ????????.
???????????? ??? FormType
???? TimeType

Дата оновлення перекладу 2022-12-21

Tip

Повний список опцій, визначених та успадкованих цим типом форми, доступний шляхом виконання цієї команди у вашому додатку:

1
2
# замініть 'FooType' імʼям класу вашого типу форми
$ php bin/console debug:form FooType

Базове застосування

Цей тип поля є висококонфігурованим, але простим у використання. Найважливіші опції - input і widget.

Уявіть, що у вас є поле startTime, основні дані часу якого - обʼєкт DateTime. Наступне конфігурує TimeType для цього поля у вигляді двох різних полів вибору:

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

$builder->add('startTime', TimeType::class, array(
    'input'  => 'datetime',
    'widget' => 'choice',
));

Опція input повинна бути змінена так, щоб співпадати з типом основних даних дати. Наприклад, якщо дані поля startTime були часовою відміткою unix, то вам потрібно встановити input як timestamp:

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

$builder->add('startTime', TimeType::class, array(
    'input'  => 'timestamp',
    'widget' => 'choice',
));

Поле також підтримує array і string як валідні значення опції input.

Опції поля

Дата оновлення перекладу 2022-12-21

Ця опція визначає, чи мають значення виборів бути перекладені та у якому домені перекладів.

Значення опції choice_translation_domain можуть бути true (повторно використати поточний домен перекладів), false (відключити переклад), null (використовує батьківський домен перекладів або домен за замовчуванням) або рядок, який представляє точний домен перекладів для використання.

placeholder

тип: string | array

Якщо ваша опція віджету встановлена як choice, то це поле буде представлене у вигляді ряду полів вибору select. Якщо значення заповнювача буде рядком, то воно буде використано як порожнє значення всіх полів вибору:

1
2
3
$builder->add('startTime', 'time', array(
    'placeholder' => 'Select a value',
));

Як варіант, ви можете використати масив, який конфігурує різні значення заповнювача для полів годин, хвилин та секунд:

1
2
3
4
5
$builder->add('startTime', 'time', array(
    'placeholder' => array(
        'hour' => 'Hour', 'minute' => 'Minute', 'second' => 'Second',
    )
));

hours

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

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

html5

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

Если установлена, как true (по умолчанию), то она будет использовать тип HTML5 (дату, время или datetime), чтобы отобразить поле. Если установлена, как false, то будет использован текстовый тип.

Это полезно,когда вы хотите использовать пользовательский выборщик данных JavaScript, который зачастую требует текстовый тип вместо типа HTML5.

input

тип: string за замовчуванням: datetime

Формат даних введення - тобто, формат, в якому зберігаються дані у вашому основному обʼєкті. Валідні значення:

  • string (наприклад, 12:17:26)
  • datetime (обʼєкт DateTime)
  • datetime_immutable (обʼєкт DateTimeImmutable)
  • array (наприклад, array('hour' => 12, 'minute' => 17, 'second' => 26))
  • timestamp (наприклад, 1307232000)

Значення, яке повертається з форми, також буде нормалізовано назад у цей формат.

input_format

тип: string за замовчуванням: H:i:s

Якщо опція input встановлена як string, ця опція вказує формат часу. Це має бути валідним форматом часу PHP.

minutes

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

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

Дата оновлення перекладу 2024-05-30

model_timezone

тип: string за замовчуванням: часовий пояс системи за замовчуванням

Часовий пояс, в якому зберігаються вхідні дані. Це має бути один з часових поясів підтримуваних PHP.

Caution

При використанні різних значень для model_timezone та view_timezone, має бути сконфігуровано reference_date.

reference_date

тип: DateTimeInterface за замовчуванням: null

Конфігурація дати довідкової дати обовʼязкова коли model_timezone та view_timezone відрізняються. Конверсії часового поясу будуть обчислені, засновуючись на цій даті.

seconds

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

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

view_timezone

тип: string по умолчанию: системный часовой появ по умолчанию

Часовой пояс для отображения данных пользователю (а следовательно и данных, которые отправляет пользователь). Это должен быть один из часовых поясов, поддерживаемых PHP.

Коли не встановлено reference_date, view_timezone за замовчуванням має значення, сконфігуроване в model_timezone.

Caution

При використанні різних значень для model_timezone та view_timezone, має бути сконфігуровано reference_date.

widget

тип: string за замовчуванням: choice

Базовий спосіб, яким повинно бути відображене поле. Може бути одним з наступного:

  • choice: відображає один, два (за замовчуванням) або три введення вибору (година, хвилина, секунда), в залежності від опцій with_minutes та with_seconds.
  • text: відображає один, два (за замовчуванням) або три текстових введення (година, хвилина, секунда), в залежності від опцій with_minutes та with_seconds.
  • single_text: відображає один тип введення time. Введення користувача буде валідовано формою hh:mm (або hh:mm:ss, якщо використовуються секунди).

Caution

Комбінування типу віджету single_text та опції with_minutes, встановленої як false, може викликати неочікувану поведінку у клієнті, так як тип введення time може не підтримувати вибір лише години.

with_minutes

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

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

with_seconds

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

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

Перевизначені опції

by_reference

за замовчуванням: false

Класи DateTime розглядаються як незмінні обʼєкти.

compound

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

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

data_class

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

Внутреннее нормализованное представление этого типа - массив, а не объект \DateTime. Следовательско, опция data_class инициализируется, как null, чтобы избежать инициализации объектом FormType, как \DateTime.

error_bubbling

за замовчуванням: false

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

Успадковані опції

Ці опції наслідуються з FormType:

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-05-30

error_mapping

тип: array за замовчуванням: []

Ця опція дозволяє вам змінювати ціль помилки валідації.

Уявіть, що у вас є користувацький метод з назвою matchingCityAndZipCode(), який валідує чи співпадають місто та поштовий індекс. На жаль, у вашій формі немає поля matchingCityAndZipCode, тому все, що може зробити Symfony, це відобразити помилку у верхній частині форми.

За допомогою кастомізованого мапування помилок ви можете зробити краще: співставити помилку з полем міста так, щоб воно відображалося над ним:

1
2
3
4
5
6
7
8
public function configureOptions(OptionsResolver $resolver): void
{
    $resolver->setDefaults([
        'error_mapping' => [
            'matchingCityAndZipCode' => 'city',
        ],
    ]);
}

Ось правила для лівої та правої частини мапування:

  • Ліва частина містить шляхи властивостей;
  • Якщо порушення генерується у властивості або методі класу, то його шлях - це propertyName;
  • Якщо порушення згенеровано в елементі об'єкту array або ArrayAccess, то шлях до нього - [indexName];
  • Ви можете створювати вкладені шляхи властивостей шляхом їх конкатенації, розділяючи властивості крапками. Наприклад: addresses[work].matchingCityAndZipCode;
  • Права частина містить назви полів форми.

За замовчуванням, помилки для будь-якої властивості, яка не мапована, будуть спливати в батьківську форму. Ви можете використовувати крапку (.) зліва, щоб співставити помилки всіх неспівставлених властивостей до певного поля. Наприклад, щоб мапувати всі ці помилки до поля city, використовуйте:

1
2
3
4
5
$resolver->setDefaults([
    'error_mapping' => [
        '.' => 'city',
    ],
]);

Дата оновлення перекладу 2024-05-30

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_minutes boolean ???????? ????? with_minutes.
with_seconds boolean ???????? ????? with_seconds.
type string ?????? ???? ???? ?????? - single_text ?? ?????????? HTML5, ??????? ??? ???????? ??? ???????????? (datetime, date ??? time).