Locale

Валидирует, что значение является валидной локалью.

"Значение" каждой локали является любым из ID локалей формата ICU. Например, двухбуквенный код языка ISO 639-1 (например, fr), или код языка с нижним подчёркиванием после него (_) и кодом страны ISO 3166-1 alpha-2 (например, fr_FR для французского / Франции).

Применяется к свойству или методу
Опции
Класс Locale
Валидатор LocaleValidator

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

  • Annotations
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    // src/Entity/User.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class User
    {
        /**
         * @Assert\Locale(
         *     canonicalize = true
         * )
         */
         protected $locale;
    }
    
  • YAML
    1
    2
    3
    4
    5
    6
    # config/validator/validation.yaml
    App\Entity\User:
        properties:
            locale:
                - Locale:
                    canonicalize: true
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    <!-- 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 http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
    
        <class name="App\Entity\User">
            <property name="locale">
                <constraint name="Locale">
                    <option name="canonicalize">true</option>
                </constraint>
            </property>
        </class>
    </constraint-mapping>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    // src/Entity/User.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Mapping\ClassMetadata;
    use Symfony\Component\Validator\Constraints as Assert;
    
    class User
    {
        public static function loadValidatorMetadata(ClassMetadata $metadata)
        {
            $metadata->addPropertyConstraint('locale', new Assert\Locale(array('canonicalize' => true)));
        }
    }
    

Опции

message

тип: string по умолчанию: Это значение не является валидной локалью.

Это сообщение отображается, если строка не является валидной локалью.

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.

canonicalize

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

New in version 4.1: Использование этой опции со значением false устарело в Symfony 4.1 и вызовет исключение в Symfony 5.0. Вместо этого используйте true.

Если true, метод Locale::canonicalize() будет применён до проверки валидности данной локали (например, FR-fr.utf8 трансформируется в fr_FR).

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