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.
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; # USAA 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 instance can be created using either an Alpha-2 or Alpha-3 code, along with an optional country name.
There are two main methods to create a Country object: from (which accepts objects) and fromString (which accepts
strings).
You can create a Country instance using the from method by providing an Alpha2Code or Alpha3Code object.
Optionally, you can pass the name of the country. If no name is provided, the default is the 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: Alpha3Code::UNITED_STATES_OF_AMERICA);
$country->name; # United States of America
$country->alpha2->value; # US
$country->alpha3->value; # USAIf you want to specify a custom name:
$country = Country::from(alphaCode: Alpha3Code::UNITED_STATES_OF_AMERICA, name: 'United States');
$country->name; # United States
$country->alpha2->value; # US
$country->alpha3->value; # USAAlternatively, you can create a Country instance using the fromString method, which accepts an Alpha-2 or
Alpha-3 code as a string. This method is useful when the alpha code is provided as a string.
$country = Country::fromString(alphaCode: 'US');
$country->name; # United States of America
$country->alpha2->value; # US
$country->alpha3->value; # USAYou can also pass a custom country name when using the fromString method:
$country = Country::fromString(alphaCode: 'USA', 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.