Cover of the book Symfony 5: The Fast Track

Symfony 5: The Fast Track is the best book to learn modern Symfony development, from zero to production. +300 pages showcasing Symfony with Docker, APIs, queues & async tasks, Webpack, SPAs, etc.

  1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. Language
WARNING:

You are browsing the documentation for Symfony 2.2 which is not maintained anymore.

Consider upgrading your projects to Symfony 5.2.

Language

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

Language

Validates that a value is a valid language Unicode language identifier (e.g. fr or zh-Hant).

Applies to property or method
Options
Class Symfony\Component\Validator\Constraints\Language
Validator Symfony\Component\Validator\Constraints\LanguageValidator

Basic Usage

  • YAML
    1
2
3
4
5
    # src/UserBundle/Resources/config/validation.yml
Acme\UserBundle\Entity\User:
    properties:
        preferredLanguage:
            - Language: ~
  • 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\Language
     */
     protected $preferredLanguage;
}
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    <!-- src/Acme/UserBundle/Resources/config/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="Acme\UserBundle\Entity\User">
        <property name="preferredLanguage">
            <constraint name="Language" />
        </property>
    </class>
</constraint-mapping>
  • 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('preferredLanguage', new Assert\Language());
    }
}

Options

message

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

This message is shown if the string is not a valid language code.

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