You are browsing the Symfony 4 documentation, which changes significantly from Symfony 3.x. If your app doesn't use Symfony 4 yet, browse the Symfony 3.4 documentation.

Locale

Locale

Validates that a value is a valid locale.

The "value" for each locale is any of the ICU format locale IDs. For example, the two letter ISO 639-1 language code (e.g. fr), or the language code followed by an underscore (_) and the ISO 3166-1 alpha-2 country code (e.g. fr_FR for French/France).

Applies to property or method
Options
Class Locale
Validator LocaleValidator

Basic Usage

  • 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)));
        }
    }
    

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.

Options

message

type: string default: This value is not a valid locale.

This message is shown if the string is not a valid locale.

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

type: boolean default: false

New in version 4.1: Using this option with value false was deprecated in Symfony 4.1 and it will throw an exception in Symfony 5.0. Use true instead.

If true, the Locale::canonicalize() method will be applied before checking the validity of the given locale (e.g. FR-fr.utf8 is transformed into fr_FR).

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.