Value Object representing a country using ISO-3166 specifications.
composer require tiny-blocks/countryThe library exposes country codes according to ISO-3166 specifications. Also, it is possible to create a representation of a country that groups the codes and its name.
Alpha-2 code: a two-letter code that represents a country name, recommended as the general purpose code.
$alpha2Code = Alpha2Code::UNITED_STATES_OF_AMERICA;
$alpha2Code->name; # UNITED_STATES_OF_AMERICA
$alpha2Code->value; # US
$alpha2Code->toAlpha3()->value; # USAAlpha-3 code: a three-letter code that represents a country name, which is usually more closely related to the country name.
$alpha3Code = Alpha3Code::UNITED_STATES_OF_AMERICA;
$alpha3Code->name; # UNITED_STATES_OF_AMERICA
$alpha3Code->value; # USA
$alpha3Code->toAlpha2()->value; # USA country might change a significant part of its name, so there is no specific ISO for this case.
You can create an instance of Country, using the from method, informing an alpha code (Alpha2Codeor Alpha3Code),
where they can be of type AlphaCode or just strings. Optionally, you can enter the name of the country. If the
country name is not given in the from method, then the default is to assume an English version of the country name.
$country = Country::from(alphaCode: Alpha2Code::UNITED_STATES_OF_AMERICA);
$country->name; # United States of America
$country->alpha2->value; # US
$country->alpha3->value; # USAor
$country = Country::from(alphaCode: 'US');
$country->name; # United States of America
$country->alpha2->value; # US
$country->alpha3->value; # USACreating an instance passing the country name.
$country = Country::from(alphaCode: Alpha3Code::UNITED_STATES_OF_AMERICA, name: 'United States');
$country->name; # United States
$country->alpha2->value; # US
$country->alpha3->value; # USACountry is licensed under MIT.
Please follow the contributing guidelines to contribute to the project.