Поле DateType
Дата оновлення перекладу 2023-09-25
Поле DateType
Поле, яке дозволяє користувачу змінювати інформацію про дату через багато різних HTML-елементів.
Це поле може бути відображено багатьма різними способами через опцію widget, і може розуміти декілька різних форматів введення через опцію input.
???????? ??? ????? | ???? ???? DateTime , ??????, ?????? ???? ??? ??????? (???. ????? input |
?????????????? ?? | ???? ???????? ???? ??? ??? ???? ?????? |
???????????? ???????????? ?? ????????????? | ???? ?????, ??????? ??????? ????. |
??????????? ???????????? ???????????? | ???????? {{ value }} ?????????. |
???????????? ??? | FormType |
???? | DateType |
Дата оновлення перекладу 2022-12-21
Tip
Повний список опцій, визначених та успадкованих цим типом форми, доступний шляхом виконання цієї команди у вашому додатку:
1 2
# замініть 'FooType' імʼям класу вашого типу форми
$ php bin/console debug:form FooType
Базове застосування
Цей тип поля має високу конфігурованість, але легкий у використанні. Найважливішими
опціями є input
та widget
.
Уявіть, що у вас є поле publishedAt
, основні дані якого - об'єкт DateTime
.
Наступне конфігурує тип date
для цього поля, як три різних поля вибору:
1 2 3 4 5 6
use Symfony\Component\Form\Extension\Core\Type\DateType;
// ...
$builder->add('publishedAt', DateType::class, [
'widget' => 'choice',
]);
Якщо ваші основні дані - не об'єкт DateTime
(а, наприклад, мітка часу
unix або об'єкт DateTimeImmutable
), сконфігуруйте опцію input:
1 2 3 4
$builder->add('publishedAt', DateType::class, [
'widget' => 'choice',
'input' => 'datetime_immutable'
]);
Відображення одного текстового поля HTML5
Для кращого досвіду використання, ви можете захотіти відобразити одне текстове поле
та використати якийсь "визначник дати", щоб допомогти вашому користувачу заповнити
у правильному форматі. Щоб зробити це, використайте віджет single_text
:
1 2 3 4 5 6 7
use Symfony\Component\Form\Extension\Core\Type\DateType;
// ...
$builder->add('publishedAt', DateType::class, [
// відображає його як одне текстове поле
'widget' => 'single_text',
]);
Це відобразиться у вигляді поля HTML5 input type="date"
, що означає, що деякі, але
не всі, браузери додаватимуть до поля зручну функціональність визначника дати. Якщо ви
хочете бути абсолютно впевнені, що кожний користувач має працюючий визначник дати,
використовуйте зовнішню бібліотеку JavaScript.
Наприклад, уявіть, що ви хочете використати бібліотеку Bootstrap Datepicker. Для початку, зробіть наступні зміни:
1 2 3 4 5 6 7 8 9 10 11 12
use Symfony\Component\Form\Extension\Core\Type\DateType;
// ...
$builder->add('publishedAt', DateType::class, [
'widget' => 'single_text',
// запобігає його відображенню як type="date", щоб уникнути визначників дати HTML5
'html5' => false,
// додає клас, який може бути обрано в JavaScript
'attr' => ['class' => 'js-datepicker'],
]);
Далі додайте наступний код JavaScript у ваш шаблон, щоб ініціалізувати виборця дати:
1 2 3 4 5 6 7 8
<script>
$(document).ready(function() {
// вам може знадобитися змінити цей код, якщо ви не використовуєте Bootstrap Datepicker
$('.js-datepicker').datepicker({
format: 'yyyy-mm-dd'
});
});
</script>
Цей ключ format
повідомляє визначнику дати, щоб він використовував формат дати,
який очікує Symfony. Це може бути непросто: якщо визначник дати сконфігурований
неправильно, то Symfony не зрозуміє форму і видасть помилку валідації. Ви також
можете сконфігурувати формат, який буде очікуватися Symfony, через опцію format.
Caution
Рядок, який використовується визначником дати JavaScript для опису його формату
(наприклад, yyyy-mm-dd
) може не співпадати з рядком, який використовує Symfony
(наприклад, yyyy-MM-dd
). Це тому, що різні бібліотеки використовують різні
правила форматування, щоб описати формат дати. Майте це на увазі - зробити так,
щоб формати дійсно співпадали, може бути дуже непросто!
Опції поля
days
тип: array
по умолчанию: от 1 до 31
Список дней, доступных в типе поля день. Эта опция применима только тогда
когда опция widget
установлена, как choice
:
1
'days' => range(1,31)
placeholder
тип: string
| array
Якщо ваша опція віджета встановлена як choice
, то це поле буде представлено,
як серію полів вибору select
. Коли значення заповнювача - рядок, він буде
використаний як пусте значення всіх полів вибору:
1 2 3
$builder->add('dueDate', DateType::class, [
'placeholder' => 'Select a value',
]);
Як варіант, ви можете використати масив, який конфігурує різні значення заповнювача для полів року, місяця та дня:
1 2 3 4 5
$builder->add('dueDate', DateType::class, [
'placeholder' => [
'year' => 'Year', 'month' => 'Month', 'day' => 'Day',
]
]);
format
тип: integer
или string
по умолчанию: IntlDateFormatter::MEDIUM
(или yyyy-MM-dd
если widget - single_text
)
Опция, переданная классу IntlDateFormatter
, используется для преобразования
ввода пользователя в правильный формат. Это критично, когда опция widget устанвлена,
как single_text
и будет определять, как пользователь будет вводить данные.
По умолчанию, формат определяется, основываясь на локали текущего пользователя:
это означает, что ожидаемый формат будет отличаться для разных пользователей. Вы
можете переопределить это, передав формат в качестве строки.
Чтобы узнать больше о валидных форматах, см. Синтаксис формата Date/Time:
1 2 3 4 5 6 7 8
use Symfony\Component\Form\Extension\Core\Type\DateType;
// ...
$builder->add('date_created', DateType::class, array(
'widget' => 'single_text',
// Это на самом деле формат по умолчанию для single_text
'format' => 'yyyy-MM-dd',
));
Note
Если вы хотите, чтобы ваше поле отображалось, как поле "данных" HTML5,
то вам нужно использовать виджет single_text
с форматом yyyy-MM-dd
(формат RFC 3339), который является значением по умолчанию, если вы
используете виджет single_text
.
html5
тип: boolean
по умолчанию: true
Если установлена, как true
(по умолчанию), то она будет использовать тип HTML5
(дату, время или datetime), чтобы отобразить поле. Если установлена, как false
,
то будет использован текстовый тип.
Это полезно,когда вы хотите использовать пользовательский выборщик данных JavaScript, который зачастую требует текстовый тип вместо типа HTML5.
input
тип: string
по умолчанию: datetime
Формат данных ввода - т.е. формат, в котором хранятся данные вашего основоположного объекта. Валидные значения:
string
(например,2011-06-05
)datetime
(объектDateTime
)datetime_immutable
(aDateTimeImmutable
object)array
(например,array('year' => 2011, 'month' => 06, 'day' => 05)
)timestamp
(например,1307232000
)
Значение, которое возвращается из формы также будет нормализовано обратно в этот формат.
Дата оновлення перекладу 2022-12-21
Caution
Якщо використано timestamp
, DateType
обмежуєтья датами між пʼятницею,
13 грудня 1901 року 20:45:54 UTC та вівторком, 19 січня 2038 року 03:14:07 UTC
у 32-бітних системах. Це через баг переповнення цілими числами у 32-бітних
системах, відомий як Проблема 2038 року.
Дата оновлення перекладу 2022-12-21
input_format
тип: string
за замовчуванням: Y-m-d
Дата оновлення перекладу 2022-12-21
Якщо опція input
встановлена як string
, ця опція вказує формат дати.
Це має бути валідним PHP-форматом дат.
Дата оновлення перекладу 2024-05-30
model_timezone
тип: string
за замовчуванням: часовий пояс системи за замовчуванням
Часовий пояс, в якому зберігаються вхідні дані. Це має бути один з часових поясів підтримуваних PHP.
months
тип: array
по умолчанию: от 1 до 12
Список месяцев, доступных типу поля месяц. Эта опция применима только когда опция
widget
установлена, как choice
.
view_timezone
тип: string
по умолчанию: системный часовой появ по умолчанию
Часовой пояс для отображения данных пользователю (а следовательно и данных, которые отправляет пользователь). Это должен быть один из часовых поясов, поддерживаемых PHP.
Дата обновления перевода 2023-09-25
widget
Дата оновлення перекладу 2024-05-29
тип: string
за замовчуванням: single_text
Основний спосіб відображення цього поля. Це може бути один з наступних способів:
years
тип: array
по умолчанию: пять лет до или после текущего года
Список годов, доступных типу поля год. Эта опция применима только тогда, когда
опция widget
установлена, как choice
.
Перевизначені опції
by_reference
за замовчуванням: false
До класів DateTime
відносяться як до незмінних об'єктів.
Дата оновлення перекладу 2022-12-21
choice_translation_domain
тип: string
, boolean
або null
за замовчуванням: false
Дата оновлення перекладу 2022-12-21
Ця опція визначає, чи мають значення виборів бути перекладені та у якому домені перекладів.
Значення опції choice_translation_domain
можуть бути true
(повторно використати
поточний домен перекладів), false
(відключити переклад), null
(використовує
батьківський домен перекладів або домен за замовчуванням) або рядок, який представляє
точний домен перекладів для використання.
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. |
type | string |
???????? ???? ????, ???? ?????? - single_text ? ?????????? HTML5,
??????? ??? ???????? ??? ???????????? (datetime , date ??? time ). |
date_pattern | string |
????? ? ???????? ???? ??? ????????????. |