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

Timezone

Валидирует, что значение является валидным идентификатором часового пояса (например, Europe/Paris).

Базовое использование

Представьте, что у вас есть класс UserSettings, с полем timezone, которое является строкой, содержащей любой из PHP-идентификаторов часовых поясов (например, America/New_York):

  • Annotations
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    // src/Entity/UserSettings.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class UserSettings
    {
        /**
         * @Assert\Timezone
         */
        protected $timezone;
    }
    
  • Attributes
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    // src/Entity/UserSettings.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class UserSettings
    {
        #[Assert\Timezone]
        protected $timezone;
    }
    
  • YAML
    1
    2
    3
    4
    5
    # config/validator/validation.yaml
    App\Entity\UserSettings:
        properties:
            timezone:
                - Timezone: ~
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    <!-- config/validator/validation.xml -->
    <?xml version="1.0" encoding="UTF-8" ?>
    <constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
    
        <class name="App\Entity\UserSettings">
            <property name="timezone">
                <constraint name="Timezone"/>
            </property>
        </class>
    </constraint-mapping>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    // src/Entity/UserSettings.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    use Symfony\Component\Validator\Mapping\ClassMetadata;
    
    class UserSettings
    {
        public static function loadValidatorMetadata(ClassMetadata $metadata)
        {
            $metadata->addPropertyConstraint('timezone', new Assert\Timezone());
        }
    }
    

Note

As with most of the other constraints, null and empty strings are considered valid values. This is to allow them to be optional values. If the value is mandatory, a common solution is to combine this constraint with NotBlank.

Опции

countryCode

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

Если опция zone установлена как \DateTimeZone::PER_COUNTRY, эта опция ограничивает валидные идентификаторы часовых поясов, до тех, которые принадлежат заданной стране.

Значение этой опции должно быть валидным кодом страны ISO 3166-1 alpha-2 (например, CN для Китая).

groups

type: array | string

It defines the validation group or groups this constraint belongs to. Read more about validation groups.

intlCompatible

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

Это ограничение считает валидными как `PHP-идентификаторы часовых поясов`_, так и часовые пояса ICU, предоставленные компонентом Intl от Symfony.

Однако, часовые пояса, предоставленные компонентом Intl, могут отличаться от часовых поясов, предоставленных PHP-расширением Intl (так как они используют разные версии ICU). Если эта опция установлена как true, данное ограничение считает валидными только значения, совместимые с PHP-методом \IntlTimeZone::createTimeZone().

message

тип: string по умолчанию: This value is not a valid timezone.

Это сообщение отображается, если базовые данные не являются валидным идентификатором часового пояса.

Вы можете использовать следующие параметры в этом сообщении:

Параметр Описание
{{ value }} Текущее значение (invalid)
{{ label }} Соответствующий ярлык поля формы

New in version 5.2: Параметр {{ label }} был представлен в Symfony 5.2.

payload

type: mixed default: null

This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.

zone

тип: string по умолчанию: \DateTimeZone::ALL

Установите эту опцию в одну из следующих констант, чтобы ограничить валидные идентификаторы часовых поясов до тех, которые принадлежат этой географической зоне:

  • \DateTimeZone::AFRICA
  • \DateTimeZone::AMERICA
  • \DateTimeZone::ANTARCTICA
  • \DateTimeZone::ARCTIC
  • \DateTimeZone::ASIA
  • \DateTimeZone::ATLANTIC
  • \DateTimeZone::AUSTRALIA
  • \DateTimeZone::EUROPE
  • \DateTimeZone::INDIAN
  • \DateTimeZone::PACIFIC

Кроме того, если специальные значения зон:

  • \DateTimeZone::ALL принимает любой часовой пояс, кроме устаревших;
  • \DateTimeZone::ALL_WITH_BC принимает любой часовой пояс, включая устаревшие;
  • \DateTimeZone::PER_COUNTRY ограничивает валидные часовые пояса по определенной стране (которая определяется с использованием опции countryCode).

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