1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. Locale
WARNING: You are browsing the documentation for Symfony 2.0 which is not maintained anymore. Consider upgrading your projects to Symfony 5.0.

Locale

2.0 version
Maintained
3.4 4.3 4.4 5.0 current 5.1 master
Unmaintained
2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 4.0 4.1 4.2

Locale

Validates that a value is a valid locale.

The "value" for each locale is either the two letter ISO639-1 language code (e.g. fr), or the language code followed by an underscore (_), then the ISO3166 country code (e.g. fr_FR for French/France).

Applies to property or method
Options
Class Locale
Validator LocaleValidator

Basic Usage

  • YAML
    1
2
3
4
5
    # src/UserBundle/Resources/config/validation.yml
Acme\UserBundle\Entity\User:
    properties:
        locale:
            - Locale:
  • Annotations
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    // src/Acme/UserBundle/Entity/User.php
namespace Acme\UserBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class User
{
    /**
     * @Assert\Locale
     */
     protected $locale;
}
  • XML
    1
2
3
4
5
6
    <!-- src/Acme/UserBundle/Resources/config/validation.xml -->
<class name="Acme\UserBundle\Entity\User">
    <property name="locale">
        <constraint name="Locale" />
    </property>
</class>
  • PHP
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    // src/Acme/UserBundle/Entity/User.php
namespace Acme\UserBundle\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());
    }
}

Options

message

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

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

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