Поле TimeType

Поле TimeType

Поле для определения ввода времени.

Может быть отображено как текстовое поле, ряд текстовых полей (например, час, минута, секунда) или ряд полей выбора. Основоположные данные могут храниться как объект DateTime, строка, временная отметка или массив.

?????????????? ??? ?????? ????? ???? DateTime, ???????, ????????? ??????, ??? ???????? (??. ????? input)
???????????? ??? ????? ???? ??????? ?????? (??. ????)
?????
???????????????? ?????
??????????? ?????
???????????? ??? FormType
????? TimeType

Базовое применение

Этот тип поля высоко конфигурируемый, но простой в использовании. Наиболее важные опции - input и widget.

Представьте, что у вас есть поле startTime, основоположные данные времени которого - объект DateTime. Следующее конфигурирует TimeType для этого поля в виде двух разных полей выбора:

1
2
3
4
5
6
7
use Symfony\Component\Form\Extension\Core\Type\TimeType;
// ...

$builder->add('startTime', TimeType::class, array(
    'input'  => 'datetime',
    'widget' => 'choice',
));

Опция input должна быть изменена так, чтобы совпадать с типом основоположных данных даты. Например, если данные поля startTime были временной меткой unix, то вам нужно установить input, как timestamp:

1
2
3
4
5
6
7
use Symfony\Component\Form\Extension\Core\Type\TimeType;
// ...

$builder->add('startTime', TimeType::class, array(
    'input'  => 'timestamp',
    'widget' => 'choice',
));

Поле также поддерживает array и string, как валидные значения опции input.

Опции поля

choice_translation_domain

тип: string, boolean или null

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

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

placeholder

тип: string | array

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

1
2
3
$builder->add('startTime', 'time', array(
    'placeholder' => 'Select a value',
));

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

1
2
3
4
5
$builder->add('startTime', 'time', array(
    'placeholder' => array(
        'hour' => 'Hour', 'minute' => 'Minute', 'second' => 'Second',
    )
));

hours

тип: array по умолчанию: от 0 до 23

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

html5

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

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

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

input

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

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

  • string (например, 12:17:26)
  • datetime (объект DateTime)
  • datetime_immutable (a DateTimeImmutable object)
  • array (например, array('hour' => 12, 'minute' => 17, 'second' => 26))
  • timestamp (например, 1307232000)

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

minutes

тип: array по умолчанию: от 0 до 59

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

model_timezone

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

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

seconds

тип: array по умолчанию: от 0 до 59

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

view_timezone

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

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

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

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

Включать ли минуты во ввод. Приведёт к дополнительному вводу для фиксации минут.

with_seconds

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

Включать ли секундыы во ввод. Приведёт к дополнительному вводу для фиксации секунд.

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

by_reference

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

Классы DateTime рассматриваются, как неизменные объекты.

compound

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

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

data_class

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

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

error_bubbling

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

Наследуемые опции

Эти опции наследуются из FormType:

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". Любые отправленные данные будут проигнорированы.

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

inherit_data

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

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

Caution

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

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

тип: 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.

Переменные формы

?????????? ??? ??????????
widget mixed ???????? ????? widget.
with_minutes boolean ???????? ????? with_minutes.
with_seconds boolean ???????? ????? with_seconds.
type string ???????????? ??????, ????? ?????? - single_text ? ??????????? HTML5, ???????? ??? ????? ??? ????????????? (datetime, date ??? time).