Отображение одного текстового поля 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.

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',
    ]
]);

Дата обновления перевода 2025-02-24

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('dateCreated', DateType::class, [
    'widget' => 'single_text',
    // Это на самом деле формат по умолчанию для single_text
    'format' => 'yyyy-MM-dd',
));

Дата обновления перевода 2025-02-24

html5

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

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

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

Дата обновления перевода 2025-02-24

input

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

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

• string (например, 2011-06-05)
• datetime (объект DateTime)
• datetime_immutable (объект DateTimeImmutable)
• array (например, array('year' => 2011, 'month' => 06, 'day' => 05))
• timestamp (например, 1307232000)

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

Дата обновления перевода 2025-02-05

Дата обновления перевода 2025-02-24

input_format

тип: string по умолчанию: Y-m-d

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

Если опция input установлена как string, эта опция указывает формат даты. Это должно быть валидным PHP-форматом даты.

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

model_timezone

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

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

Дата обновления перевода 2025-02-24

months

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

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

Дата обновления перевода 2025-02-22

view_timezone

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

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

calendar

тип: integer или \IntlCalendar по умолчанию: null

Календарь, который будет использоваться для форматирования и анализа даты. Значение должно быть integer из констант календаря IntlDateFormatter` или экземпляром календаря IntlCalendar для использования. По умолчанию используется григорианский календарь с локалью приложения по умолчанию.

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

widget

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

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

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

• choice: отображает три ввода выбора. Порядок вариантов определяется опцией format.
• text: отображает три поля ввода типа text (месяц, день, год).
• single_text: отображает один ввод типа date. Пользовательский ввод валидируется, основываясь на опции format.

Дата обновления перевода 2025-02-22

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 (использует родительский домен переводов или домен по умолчанию) или строка, которая представляет собой точный домен переводов для использования.

Дата обновления перевода 2025-02-22

compound

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

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

Дата обновления перевода 2025-02-22

data_class

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

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

error_bubbling

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

Дата обновления перевода 2025-02-24

invalid_message

тип: string по умолчанию: Это значение не валидно

Это сообщение ошибки валидации, которое используется, если данные, введенные в это поле, не имеют смысла (т.е. валидация проходит неудачно).

Это может случиться, к примеру, если пользователь вводит в поле TimeType асбурдную строку, которая не может быть конвертирована в настоящее время, или если пользователь вводит строку (например, apple) в числовое поле.

Нормальная (программный код) валидация (например, установка минимальной длины для поля), должна быть установлена с использованием сообщений валидации с вашими правилами валидации (справочник ).

attr

тип: array по умолчанию: []

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

1
2
3

$builder->add('body', TextareaType::class, [
    'attr' => ['class' => 'tinymce'],
]);

Дата обновления перевода 2025-02-05

data

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

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

1
2
3
4
5
6

use Symfony\Component\Form\Extension\Core\Type\HiddenType;
// ...

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

Дата обновления перевода 2025-02-24

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'),
    ])
;

Дата обновления перевода 2025-02-24

help_attr

тип: array по умолчанию: []

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

1
2
3

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

Дата обновления перевода 2025-02-24

help_html

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

По умолчанию содержание опции help экранируется перед отображением в шаблоне.
Установите для этой опции значение true, чтобы не экранировать их, что полезно,
когда справка содержит элементы HTML.

Дата обновления перевода 2025-02-05

inherit_data

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

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

Дата обновления перевода 2025-02-24

invalid_message_parameters

тип: array по умолчанию: []

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

1
2
3
4

$builder->add('someField', SomeFormType::class, [
    // ...
    'invalid_message' => 'Вы ввели невалидное значение, оно должно содержать %num% букв',
    'invalid_message_parameters' => ['%num%' => 6],

Дата обновления перевода 2025-02-24

mapped

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

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

Дата обновления перевода 2025-02-24

row_attr

тип: array по умолчанию: []

Ассоциативный массив атрибутов HTML, добавляемых к элементу, который используется для отображения строки типа формы :

1
2
3

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