Поле TimeType¶
Поле для определения ввода времени.
Может быть отображено как текстовое поле, ряд текстовых полей (например,
час, минута, секунда) или ряд полей выбора. Основоположные данные могут
храниться как объект DateTime
, строка, временная отметка или массив.
Основоположный тип данных | может быть DateTime , строкой, временной меткой, или массивом (см. опцию input ) |
Отображается как | может быть разными тегами (см. ниже) |
Опции | |
Переопределённые опции | |
Наследуемые опции | |
Родительский тип | FormType |
Класс | TimeType |
Базовое применение¶
Этот тип поля высоко конфигурируемый, но простой в использовании. Наиболее важные
опции - input
и widget
.
Представьте, что у вас есть поле startTime
, основоположные данные времени которого
- объект DateTime
. Следующее конфигурирует TimeType
для этого поля в виде двух
разных полей выбора:
use Symfony\Component\Form\Extension\Core\Type\TimeType;
// ...
$builder->add('startTime', TimeType::class, array(
'input' => 'datetime',
'widget' => 'choice',
));
Опция input
должна быть изменена так, чтобы совпадать с типом основоположных
данных даты. Например, если данные поля startTime
были временной меткой unix,
то вам нужно установить input
, как timestamp
:
use Symfony\Component\Form\Extension\Core\Type\TimeType;
// ...
$builder->add('startTime', TimeType::class, array(
'input' => 'timestamp',
'widget' => 'choice',
));
Поле также поддерживает array
и string
, как валидные значения опции
input
.
Опции поля¶
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
. Если значение заполнтеля будет строкой, то оно
будет использовано, как пустое значение всех полей выбора:
$builder->add('startTime', 'time', array(
'placeholder' => 'Select a value',
));
Как вариант, вы можете использовать массив, который конфигурирует разные значения заполнителя для полей часов, минут и секунд:
$builder->add('startTime', 'time', array(
'placeholder' => array(
'hour' => 'Hour', 'minute' => 'Minute', 'second' => 'Second',
)
));
hours
¶
type: array
default: 0 to 23
List of hours available to the hours field type. This option is only relevant
when the widget
option is set to choice
.
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
по умолчанию: datetime
Формат данных ввода - т.е. формат, в котором хранятся данные в вашем основоположном объекте. Валидные значения:
string
(например,12:17:26
)datetime
(объектDateTime
)datetime_immutable
(aDateTimeImmutable
object)array
(например,array('hour' => 12, 'minute' => 17, 'second' => 26)
)timestamp
(например,1307232000
)
Значение, которое возвращается из формы, также будет нормализовано обратно в этот формат.
minutes
¶
type: array
default: 0 to 59
List of minutes available to the minutes field type. This option is only
relevant when the widget
option is set to choice
.
model_timezone
¶
type: string
default: system default timezone
Timezone that the input data is stored in. This must be one of the PHP supported timezones.
seconds
¶
type: array
default: 0 to 59
List of seconds available to the seconds field type. This option is only
relevant when the widget
option is set to choice
.
view_timezone
¶
type: string
default: system default timezone
Timezone for how the data should be shown to the user (and therefore also the data that the user submits). This must be one of the PHP supported timezones.
widget¶
тип: string
по умолчанию: choice
Базовый способ, которым должно быть отображено поле. Может быть одним из следующих:
choice
: отображает один, два (по умолчанию) или три ввода выбора (час, минута, секунда), в зависимости от опций with_minutes и with_seconds.text
: отображает один, два (по умолчанию) или три текстовых ввода (час, минута, секунда), в зависимости от опций with_minutes и with_seconds.single_text
: отображает один тип вводаtime
. Ввод пользователя будет валидирован формойhh:mm
(илиhh:mm:ss
, если используются секунды).
Caution
Комбинирование типа виджета single_text
и опции with_minutes
установленной, как false
может вызывать неожиданное поведение в
клиенте, так как тип ввода time
может не поддерживать выбор только
часа.
with_minutes
¶
type: boolean
default: true
Whether or not to include minutes in the input. This will result in an additional input to capture minutes.
with_seconds
¶
type: boolean
default: false
Whether or not to include seconds in the input. This will result in an additional input to capture seconds.
Переопределённые опци¶
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.
data_class
¶
type: string
default: null
The internal normalized representation of this type is an array, not a \DateTime
object. Therefore, the data_class
option is initialized to null
to avoid
the FormType
object from initializing it to \DateTime
.
error_bubbling¶
по умолчанию: false
Наследуемые опции¶
Эти опции наследуются из FormType:
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.
error_mapping
¶
type: array
default: []
This option allows you to modify the target of a validation error.
Imagine you have a custom method named matchingCityAndZipCode()
that validates
whether the city and zip code match. Unfortunately, there is no matchingCityAndZipCode
field in your form, so all that Symfony can do is display the error on top
of the form.
With customized error mapping, you can do better: map the error to the city field so that it displays above it:
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults([
'error_mapping' => [
'matchingCityAndZipCode' => 'city',
],
]);
}
Here are the rules for the left and the right side of the mapping:
- The left side contains property paths;
- If the violation is generated on a property or method of a class, its
path is the
propertyName
; - If the violation is generated on an entry of an
array
orArrayAccess
object, the property path is[indexName]
; - You can construct nested property paths by concatenating them, separating
properties by dots. For example:
addresses[work].matchingCityAndZipCode
; - The right side contains the names of fields in the form.
By default, errors for any property that is not mapped will bubble up to the
parent form. You can use the dot (.
) on the left side to map errors of all
unmapped properties to a particular field. For instance, to map all these
errors to the city
field, use:
$resolver->setDefaults([
'error_mapping' => [
'.' => 'city',
],
]);
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
¶
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).
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
.
Переменные формы¶
Переменная | Тип | Применение |
---|---|---|
widget | mixed |
Значение опции widget. |
with_minutes | boolean |
Значение опции with_minutes. |
with_seconds | boolean |
Значение опции with_seconds. |
type | string |
Присутствует только, когда виджет - single_text и активирован HTML5,
содержит тип ввода для использования (datetime , date или time ). |
Эта документация является переводом официальной документации Symfony и предоставляется по свободной лицензии CC BY-SA 3.0.