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

Поле WeekType

Этот тип поля позволяет пользователю изменять данные, представляющие собой конкретный номер недели в формате ISO 8601 (например, 1984-W05).

Может быть отображено как текстовы ввод или тег выбора. Основной формат данных может быть строкой или массивом.

Основной тип данных может быть строкой или массивом (см. опцию input)
Отображается как одно текстовое окно, два текстовых окна или два поля выбора
Options
Переопределенные опции
Наследуемые опции
Сообщение невалидности по умолчанию Пожалуйста, введите валидную неделю
Наследуемое сообщение невалидности Значение {{ value }} не является валидным.
Родительский тип FormType
Класс WeekType

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

Опции моля

choice_translation_domain

DEFAULT_VALUE

This option determines if the choice values should be translated and in which translation domain.

The values of the choice_translation_domain option can be true (reuse the current translation domain), false (disable translation), null (uses the parent translation domain or the default domain) or a string which represents the exact translation domain to use.

placeholder

тип: string | array

Если ваша опция виджета установлена как choice, то это поле будет представлено в виде серии полей select. Когда значение заменителя является строкой, оно будет использовано в качестве пустого значения всех полей выбора:

use Symfony\Component\Form\Extension\Core\Type\WeekType;

$builder->add('startWeek', WeekType::class, [
    'placeholder' => 'Select a value',
]);

Как вариант, вы можете использовать массив, который конфигурирует разные значение заполнителей, для каждого поля года и недели:

use Symfony\Component\Form\Extension\Core\Type\WeekType;

$builder->add('startDateTime', WeekType::class, [
    'placeholder' => [
        'year' => 'Year',
        'week' => 'Week',
    ]
]);

html5

type: boolean default: true

If this is set to true (the default), it’ll use the HTML5 type (date, time or datetime-local) to render the field. When set to false, it’ll use the text type.

This is useful when you want to use a custom JavaScript datepicker, which often requires a text type instead of an HTML5 type.

input

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

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

  • string (например, "2011-W17")
  • array (например, [2011, 17])

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

widget

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

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

  • choice: отображает два ввода выбора;
  • text: отображает ввод с двумя полями типа text (год и неделя);
  • single_text: отображает один ввод типа week.

years

тип: array по умолчанию: за десять лет до или через десять лет после текущего года

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

weeks

type: array default: 1 to 53

List of weeks available to the week field type. This option is only relevant when the widget option is set to choice.

Переопределенные опции

compound

type: boolean default: false

This option specifies whether the type contains child types or not. This option is managed internally for built-in types, so there is no need to configure it explicitly.

Реальное значение по умолчанию этой опции зависит от других опций поля:

  • Если widget - single_text, то - '' (empty string);
  • Иначе - [] (пустой массив).

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

type: array default: []

If you want to add extra attributes to an HTML field representation you can use the attr option. It’s an associative array with HTML attributes as keys. This can be useful when you need to set a custom class for some widget:

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

See also

Use the row_attr option if you want to add these attributes to the form type row element.

data

type: mixed default: Defaults to field of the underlying structure.

When you create a form, each field initially displays the value of the corresponding property of the form’s domain data (e.g. if you bind an object to the form). If you want to override this initial value for the form or an individual field, you can set it in the data option:

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

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

Caution

The data option always overrides the value taken from the domain data (object) when rendering. This means the object value is also overridden when the form edits an already persisted object, causing it to lose its persisted value when the form is submitted.

disabled

type: boolean default: false

If you don’t want a user to modify the value of a field, you can set the disabled option to true. Any submitted value will be ignored.

help

type: string or TranslatableMessage default: null

Allows you to define a help message for the form field, which by default is rendered below the field:

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

type: boolean default: false

This option determines if the form will inherit data from its parent form. This can be useful if you have a set of fields that are duplicated across multiple forms. See How to Reduce Code Duplication with “inherit_data”.

Caution

When a field has the inherit_data option set, it uses the data of the parent form as is. This means that Data Transformers won’t be applied to that field.

invalid_message_parameters

type: array default: []

When setting the invalid_message option, you may need to include some variables in the string. This can be done by adding placeholders to that option and including the variables in this option:

$builder->add('someField', SomeFormType::class, [
    // ...
    'invalid_message' => 'You entered an invalid value, it should include %num% letters',
    'invalid_message_parameters' => ['%num%' => 6],
]);

mapped

type: boolean default: true

If you wish the field to be ignored when reading or writing to the object, you can set the mapped option to 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:

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

Эта документация является переводом официальной документации Symfony и предоставляется по свободной лицензии CC BY-SA 3.0.