EasyAdmin Country Field
This field is used to represent the name and/or flag that corresponds to the country code stored in some property.
In form pages (edit and new) it looks like this:
Basic Information
- PHP Class:
EasyCorp\Bundle \EasyAdminBundle \Field \CountryField - Doctrine DBAL Type used to store this value:
string - Symfony Form Type used to render the field: CountryType
Rendered as:
1
<select> ... </select>
Tip
EasyAdmin includes all the valid country flags as SVG files. You don't have to do anything to make the backend render those flags. However, if you want to render flags in your own custom templates, you can use the Twig Component included in EasyAdmin as follows:
1
<twig:ea:Flag countryCode="CR" height="18"/>4.20.0
The `<twig:ea:Flag/>` component was introduced in EasyAdmin 4.20.0.
Options
allowMultipleChoices
By default, the country selector allows to select zero (if the property is nullable)
or one value. Set this option to true if you want to allow selecting any
number of values:
1
yield CountryField::new('...')->allowMultipleChoices();If you allow choosing multiple values, you might need to change your current entity because EasyAdmin will try to get/set an array with the country codes instead of a string with just one country code. You could use a Doctrine entity of type array or you could keep using a string property and handle the array to string conversion manually:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
public class MyEntity
{
// ...
public function getCountry(): ?array
{
return '' === $this->country ? null : explode('|', $this->country);
}
public function setCountry(?array $countryCodes): self
{
$this->country = null === $countryCodes ? '' : implode('|', $countryCodes);
return $this;
}
}includeOnly
By default, the country selector displays all the countries/regions defined by the ICU project, the same which is used by Symfony and many other tech projects. Use this option to only display the given country codes:
1
yield CountryField::new('...')->includeOnly(['AR', 'BR', 'ES', 'PT']);remove
By default, the country selector displays all the countries/regions defined by the ICU project, the same which is used by Symfony and many other tech projects. Use this option to remove the given countries/regions codes from that list:
1
yield CountryField::new('...')->remove(['AF', 'KP']);showFlag
By default, the country flag is displayed both in read-only pages (index and
detail) and in the selector used in form pages. Use this option if you want
to hide the flag:
1
yield CountryField::new('...')->showFlag(false);showName
By default, the country name is displayed both in read-only pages (index and
detail) and in the selector used in form pages. Use this option if you want
to hide the name:
1
yield CountryField::new('...')->showName(false);useAlpha3Codes
By default, the field expects that the given country code is a 2-letter value following the ISO 3166-1 alpha-2 format. Use this option if you store the country code using the 3-letter value of the ISO 3166-1 alpha-3 format:
1
yield CountryField::new('...')->useAlpha3Codes();