Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tiny-blocks/country
Value Object representing a country using ISO-3166 specifications.
https://github.com/tiny-blocks/country
brasil country hacktoberfest iso-3166 open-source php tiny-blocks value-object
Last synced: about 1 month ago
JSON representation
Value Object representing a country using ISO-3166 specifications.
- Host: GitHub
- URL: https://github.com/tiny-blocks/country
- Owner: tiny-blocks
- License: mit
- Created: 2022-07-26T02:43:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-05T04:37:13.000Z (about 1 month ago)
- Last Synced: 2024-10-05T06:49:47.815Z (about 1 month ago)
- Topics: brasil, country, hacktoberfest, iso-3166, open-source, php, tiny-blocks, value-object
- Language: PHP
- Homepage: https://packagist.org/packages/tiny-blocks/country
- Size: 33.2 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Country
[](LICENSE)
* [Overview](#overview)
* [Installation](#installation)
* [How to use](#how-to-use)
* [License](#license)
* [Contributing](#contributing)
## Overview
Value Object representing a country using ISO-3166 specifications.
## Installation
```bash
composer require tiny-blocks/country
```
## How to use
The 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.
### Alpha2Code
**Alpha-2 code**: a two-letter code that represents a country name, recommended as the general purpose code.
```php
$alpha2Code = Alpha2Code::UNITED_STATES_OF_AMERICA;
$alpha2Code->name; # UNITED_STATES_OF_AMERICA
$alpha2Code->value; # US
$alpha2Code->toAlpha3()->value; # USA
```
### Alpha3Code
**Alpha-3 code**: a three-letter code that represents a country name, which is usually more closely related to the
country name.
```php
$alpha3Code = Alpha3Code::UNITED_STATES_OF_AMERICA;
$alpha3Code->name; # UNITED_STATES_OF_AMERICA
$alpha3Code->value; # USA
$alpha3Code->toAlpha2()->value; # US
```
### Country
A 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 (`Alpha2Code`or `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.
```php
$country = Country::from(alphaCode: Alpha2Code::UNITED_STATES_OF_AMERICA);
$country->name; # United States of America
$country->alpha2->value; # US
$country->alpha3->value; # USA
```
or
```php
$country = Country::from(alphaCode: 'US');
$country->name; # United States of America
$country->alpha2->value; # US
$country->alpha3->value; # USA
```
Creating an instance passing the country name.
```php
$country = Country::from(alphaCode: Alpha3Code::UNITED_STATES_OF_AMERICA, name: 'United States');
$country->name; # United States
$country->alpha2->value; # US
$country->alpha3->value; # USA
```
## License
Country is licensed under [MIT](LICENSE).
## Contributing
Please follow the [contributing guidelines](https://github.com/tiny-blocks/tiny-blocks/blob/main/CONTRIBUTING.md) to
contribute to the project.