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

Country

2.2 version
Maintained
3.4 4.4 5.1 current 5.0 5.2 master
Unmaintained
2.0 2.1 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 4.3

Country

Validates that a value is a valid ISO 3166-1 alpha-2 country code.

Applies to property or method
Options
Class Symfony\Component\Validator\Constraints\Country
Validator Symfony\Component\Validator\Constraints\CountryValidator

Basic Usage

  • YAML
    1
2
3
4
5
    # src/UserBundle/Resources/config/validation.yml
Acme\UserBundle\Entity\User:
    properties:
        country:
            - Country: ~
  • 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\Country
     */
     protected $country;
}
  • 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="country">
            <constraint name="Country" />
        </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 loadValidationMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('country', new Assert\Country());
    }
}

Options

message

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

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

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