Поле UlidType
Дата обновления перевода 2021-09-29
Поле UlidType
5.3
Поле UlidType
было представлено в Symfony 5.3.
Отображает поле ввода текста с ULID значением строки, и преобразует его обратно в правильный Ulid объект при отправке формы.
???????????? ??? | ???? input text |
????? | (????) |
???????????????? ????? | |
??????????? ????? | |
????????? ???????????? ?? ????????? | ??????????, ??????? ???????? ULID. |
??????????? ????????? ???????????? | ???????? {{ value }} ?? ???????? ????????. |
???????????? ??? | FormType |
????? | UlidType |
Дата оновлення перекладу 2022-12-21
Tip
Повний список опцій, визначених та успадкованих цим типом форми, доступний шляхом виконання цієї команди у вашому додатку:
1 2
# замініть 'FooType' імʼям класу вашого типу форми
$ php bin/console debug:form FooType
Переопределенные опции
compound
тип: boolean
по умолчанию: 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". Любые отправленные данные будут проигнорированы.
empty_data
тип: mixed
- .. Этот файл должен быть включен только с "началом после" или "окончанием до",
- установленными в значении заполнителя. Его цель - позволить нам включать только часть этого файла.
DEFAULT_PLACEHOLDER
Эта опция определяет, какое значение вернёт поле, если отправленное значение пустое (или отсутствует). Она не устаналивает изначальное значение, если оно не предоставлено, когда форма отображается для просмотра.
Это означает, что вам помогают обрабатывать отправку формы с пустыми полями.
Например, если вы хотите, чтобы поле name
было ясно установлено, как
John Doe
, когда значение не выбрано, вы можете сделать это так:
1 2 3 4
$builder->add('name', null, array(
'required' => false,
'empty_data' => 'John Doe',
));
Это всё ещё будет отображать пустое текстовое поле, но при отправке будет
установлено значение John Doe
. Используйте опции data
или placeholder
,
чтобы показать это изначальное значение в отображённой форме.
Если форма составная, то вы можете установить empty_data
в качестве массива,
объекта или замыкания. См. статью Як сконфігурувати порожні дані для класу форми , чтобы узнать больше
об этих опциях.
Note
Если вы хотите установить опцию empty_data
для всего вашего класса
форм, см. статью Як сконфігурувати порожні дані для класу форми.
Caution
Преобразователи данных формы всё ещё будут
применяться к значению empty_data
. Это означает, что пустая строка будет
преобразована в null
. Используйте пользовательский преобразователь данных,
если вы хотите ясно вернуть пустую строку.
:end-before: DEFAULT_PLACEHOLDER
Значение по умолчанию - ''
(пустая строка).
empty_data
тип: mixed
- .. Этот файл должен быть включен только с "началом после" или "окончанием до",
- установленными в значении заполнителя. Его цель - позволить нам включать только часть этого файла.
DEFAULT_PLACEHOLDER
Эта опция определяет, какое значение вернёт поле, если отправленное значение пустое (или отсутствует). Она не устаналивает изначальное значение, если оно не предоставлено, когда форма отображается для просмотра.
Это означает, что вам помогают обрабатывать отправку формы с пустыми полями.
Например, если вы хотите, чтобы поле name
было ясно установлено, как
John Doe
, когда значение не выбрано, вы можете сделать это так:
1 2 3 4
$builder->add('name', null, array(
'required' => false,
'empty_data' => 'John Doe',
));
Это всё ещё будет отображать пустое текстовое поле, но при отправке будет
установлено значение John Doe
. Используйте опции data
или placeholder
,
чтобы показать это изначальное значение в отображённой форме.
Если форма составная, то вы можете установить empty_data
в качестве массива,
объекта или замыкания. См. статью Як сконфігурувати порожні дані для класу форми , чтобы узнать больше
об этих опциях.
Note
Если вы хотите установить опцию empty_data
для всего вашего класса
форм, см. статью Як сконфігурувати порожні дані для класу форми.
Caution
Преобразователи данных формы всё ещё будут
применяться к значению empty_data
. Это означает, что пустая строка будет
преобразована в null
. Используйте пользовательский преобразователь данных,
если вы хотите ясно вернуть пустую строку.
:start-after: DEFAULT_PLACEHOLDER
error_bubbling
тип: boolean
по умолчанию: false
, кроме случаев, когда форма compound
Дата оновлення перекладу 2022-12-21
Якщо true
, будь-які помилки цього поля будуть передані батьківському полю
або формі. Наприклад, якщо встановлено true
у нормальному полі, будь-які
помилки цього поля будуть прикріплені до головної форми, а не до конкретного
поля.
error_mapping
тип: array
по умолчанию: array()
Эта опция позволяет вам изменять цель ошибки валидации.
Представьте, что у вас есть пользовательский метод под именем matchingCityAndZipCode()
,
который валидирует, совпадает ли город и почтовый индекс. К сожалению, поля
"matchingCityAndZipCode" в вашей форме нет, поэтому всё, что Symfony может сделать -
это отобразить ошибку наверху формы.
С настроенным отображением ошибок вы можете сделать лучше: привяжите ошибку к полю города, чтобы она отображалась над ним:
1 2 3 4 5 6 7 8
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults(array(
'error_mapping' => array(
'matchingCityAndZipCode' => 'city',
),
));
}
Вот правила для лево- и правостороннего отображения:
- Левая сторона содержит пути свойств;
- Если наружение генерируется в свойств или методе класс, то его путь - это
просто
propertyName
; - Вы можете создать вложенные пути свойств, соединив их, разделяя свойства точками.
Например:
addresses[work].matchingCityAndZipCode
; - Правая сторона содержит просто имена полей в форме.
По умолчанию, ошибки любого свойства, которое не отображенно, соберутся в
родительской форме. Вы можете использовать точку (.
) в левой части, чтобы
привязать ошибки всех неотображённых свойств к конкретному полю. Например,
чтобы привязать эти ошибки к полю city
, используйте:
1 2 3 4 5
$resolver->setDefaults(array(
'error_mapping' => array(
'.' => 'city',
),
));
Дата оновлення перекладу 2022-12-21
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'),
])
;
6.2
Підтримка обʼєктів TranslatableInterface
в якості змісту допомоги була
представлена в Symfony 6.2.
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.
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),
));
Дата оновлення перекладу 2022-12-21
label
тип: string
або TranslatableMessage
за замовчуванням: Ярлик "вгадується" з імені поля
Встановлює ярлик, який буде використано при відображенні поля. Установка false
прридушить ярлик:
1 2 3 4 5 6 7 8
use Symfony\Component\Translation\TranslatableMessage;
$builder
->add('zipCode', null, [
'label' => 'The ZIP/Postal code',
// опціонально, ви можете використати обʼєкти TranslatableMessage в якості змісту ярлика
'label' => new TranslatableMessage('address.zipCode', ['%country%' => $country], 'address'),
])
Ярлик також може бути встановлений у шаблоні:
- Twig
- PHP
1
{{ form_label(form.name, 'Your name') }}
label_attr
тип: array
по умолчанию: array()
Устанавливает HTML-атрибуты для элемента <label>
, который будет использован
при отображении ярлыка для поля. Это ассоциативный массив с HTML-атрибутом в
качестве ключа. Этот атрибут может также быть установлен прямо внутри шаблона:
- Twig
- PHP
1 2 3
{{ form_label(form.name, 'Your name', {
'label_attr': {'class': 'CUSTOM_LABEL_CLASS'}
}) }}
label_format
тип: string
по умолчанию: null
Конфигурирует строку, используемую в качестве ярылка поля, в случае, если
опция label
не была установлена. Это полезно при использовании
сообщений переводов ключевых слов.
Если вы используете сообщения переводов ключевых слов в качестве ярлыков, то у
вас часто будет несколько сообщений с ключевым словом для одного и того же ярлыка
(например, profile_address_street
, invoice_address_street
). Это потому,
что ярлык строится для каждого "пути" к полю. Чтобы избежать повтора сообщений
ключевых слов, вы можете сконфигурировать формат ярлыка в качестве статичного
значения, например:
1 2 3 4 5 6 7 8
// ...
$profileFormBuilder->add('address', AddressType::class, array(
'label_format' => 'form.address.%name%',
));
$invoiceFormBuilder->add('invoice', AddressType::class, array(
'label_format' => 'form.address.%name%',
));
Эта опция наследуется дочерними типами. С использованием вышенаписанного кода,
ярлык поля street
обеих форм будет использовать сообщение с ключевым словом
form.address.street
.
В формате ярлыка доступны две переменные:
%id%
-
Уникальный идентификатор для поля, состоящий из полного пути к полю и имени
поля (например,
profile_address_street
); %name%
-
Имя поля (например,
street
).
Значение по умолчанию (null
) приводит к
"человеческой" версии имени поля.
Note
Опция label_format
оценивается в теме формы. Убедитесь в том, что вы
обновили ваши щаблоны, в случае, если вы настраивали темизацию форм.
mapped
тип: boolean
по умолчанию: true
Если вы хотите, чтобы поле было проигнорировано про чтении или записи в него
объетка, вы можете установить опцию mapped
, как false
.
required
тип: boolean
по умолчанию: true
Если "true", то будет отображён обязательный атрибут HTML5.
Соответствующий label
также отобразится с классом required
.
Эта опция внешняя и не зависит от валидации. В лучшем случае, если вы позволите Symfony отгадать ваш тип поля, тогда значение этой опции будет угадано из вашей информации о валидации.
Note
Обязательная опция также влияет на то, как будут обработаны пустые данные для каждого поля. Чтобы узнать больше, см. опцию empty_data.
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.