Поле DateType
Дата обновления перевода 2023-09-25
Поле DateType
Поле, которое позволяет пользователю изменять информацию о дате через множество разных HTML-элементов.
Это поле может быть отобажено множеством разных способов через опцию widget и может понимать несколько разных форматов ввода через опцию input.
?????????????? ??? ?????? | ????? ???? DateTime , ???????, ????????? ???????? ??? ????????
??. (????? `input``) |
???????????? ??? | ???? ????????? ???? ??? ??? ???? ?????? |
????????? ???????????? ?? ????????? | ??????????, ??????? ???????? ????. |
??????????? ????????? ???????????? | ???????? {{ value }} ?? ???????? ????????. |
???????????? ??? | FormType |
????? | DateType |
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
.
Представьте, что у вас есть поле 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, [
// renders it as a single text box
'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
)
Значение, которое возвращается из формы также будет нормализовано обратно в этот формат.
Caution
Если используется timestamp
, то DateType
ограничен датами, между
Пт, 13 декабря 1901 20:45:54 GMT и Вт, 19 января 2038 03:14:07 GMT в 32-
битных системах. Это происходит из-за ограничения в самом PHP <https://php.net/manual/en/function.date.php#refsect1-function.date-changelog>`_.
input_format
type: string
default: Y-m-d
Дата обновления перевода 2023-01-12
Если опция input
установлена как string
, эта опция указывает формат
даты. Это должно быть валидным PHP-форматом даты.
Дата обновления перевода 2024-07-26
model_timezone
тип: string
по умолчанию: часовой пояс системы по умолчанию
Часовой появ, в котором хранятся данные вода. Это должен быть один из часовых поясов, поддерживаемых PHP.
months
тип: array
по умолчанию: от 1 до 12
Список месяцев, доступных типу поля месяц. Эта опция применима только когда опция
widget
установлена, как choice
.
view_timezone
тип: string
по умолчанию: системный часовой появ по умолчанию
Часовой пояс для отображения данных пользователю (а следовательно и данных, которые отправляет пользователь). Это должен быть один из часовых поясов, поддерживаемых PHP.
Дата обновления перевода 2023-09-25
widget
Дата обновления перевода 2024-07-26
тип: string
по умолчанию: choice
Основной способ, которым должно быть отображено это поле. Может быть одним из следующих:
years
тип: array
по умолчанию: пять лет до или после текущего года
Список годов, доступных типу поля год. Эта опция применима только тогда, когда
опция widget
установлена, как choice
.
Переопределённые опции
by_reference
по умолчанию: false
К классам DateTime
относятся, как к неизменяемым объектам.
Дата обновления перевода 2023-01-12
choice_translation_domain
тип: string
, boolean
или null
по умолчанию: false
Дата обновления перевода 2023-01-12
Эта опция определяет, должны ли быть переведены значения выбора, и в каком домене переводов.
Значения опции 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-07-26
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-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. |
type |
string |
???????????? ??????, ????? ?????? - single_text ? ??????????? HTML5,
???????? ??? ????? ??? ????????????? (datetime , date ??? time ). |
date_pattern |
string |
?????? ? ???????? ???? ??? ????????????? |