Country
Edit this pageWarning: You are browsing the documentation for Symfony 5.1, which is no longer maintained.
Read the updated version of this page for Symfony 6.2 (the current stable version).
Country
Validates that a value is a valid ISO 3166-1 alpha-2 country code.
| Applies to | property or method |
| Options | |
| Class | Country |
| Validator | CountryValidator |
Basic Usage
- Annotations
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12
// src/Entity/User.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class User
{
/**
* @Assert\Country
*/
protected $country;
}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
alpha3
5.1
The alpha3 option was introduced in Symfony 5.1.
type: boolean default: false
If this option is true, the constraint checks that the value is a
ISO 3166-1 alpha-3 three-letter code (e.g. France = FRA) instead
of the default ISO 3166-1 alpha-2 two-letter code (e.g. France = FR).
groups
type: array | string
It defines the validation group or groups this constraint belongs to. Read more about validation groups.
message
type: string default: This value is not a valid country.
This message is shown if the string is not a valid country code.
You can use the following parameters in this message:
| Parameter | Description |
|---|---|
{{ value }} |
The current (invalid) country code |
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.
