Поле WeekType

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

Поле WeekType

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

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

???????? ??? ?????? ????? ???? ??????? ??? ???????? (??. ????? input)
???????????? ??? ???? ????????? ????, ??? ????????? ???? ??? ??? ???? ??????
????????? ???????????? ?? ????????? ??????????, ??????? ???????? ??????
??????????? ????????? ???????????? ???????? {{ 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

Опции поля

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

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

Значения опции choice_translation_domain могут быть: true (повторно использовать текущий домен переводов), false (отключить перевод), null (использует родительский домен переводов или домен по умолчанию) или строка, которая представляет собой точный домен переводов для использования.

placeholder

тип: string | array

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

1
2
3
4
5
use Symfony\Component\Form\Extension\Core\Type\WeekType;

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

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

1
2
3
4
5
6
7
8
use Symfony\Component\Form\Extension\Core\Type\WeekType;

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

html5

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

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

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

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

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

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

empty_data

type: mixed

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

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

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

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

Это означает, что она помогает вам обрабатывать отправку формы с пустыми полями. Например, если вы хотите, чтобы поле name было явно установлено как John Doe, когда значение не выбрано, вы можете сделать это следующим образом:

1
2
3
4
$builder->add('name', null, [
    'required'   => false,
    'empty_data' => 'John Doe',
]);

В результате все еще будет отображаться пустое текстовое поле, но при отправке будет установлено значение John Doe. Используйте опции data или placeholder, чтобы показать это начальное значение в отображаемой форме.

Note

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

Caution

Преобразователи данных формы все равно будут
применяться к значению empty_data. Это означает, что пустая строка будет будет приведена к значению null. Используйте пользовательский преобразователь данных, если вы явно хотите вернуть пустую строку.

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

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