Download the PHP package tiny-blocks/country without Composer
On this page you can find all versions of the php package tiny-blocks/country. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tiny-blocks/country
More information about tiny-blocks/country
Files in tiny-blocks/country
Package country
Short Description Value Object representing a country using ISO-3166 specifications.
License MIT
Homepage https://github.com/tiny-blocks/country
Informations about the package country
Country
- Overview
- Installation
- How to use
- License
- Contributing
Overview
Value Object representing a country using ISO-3166 specifications.
Installation
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
A two-letter code that represents a country name, recommended as the general purpose code.
Alpha3Code
A three-letter code that represents a country name, which is usually more closely related to the country name.
Country
A 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).
Creating from objects
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.
or
If you want to specify a custom name:
Creating from string
Alternatively, 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.
You can also pass a custom country name when using the fromString
method:
License
Country is licensed under MIT.
Contributing
Please follow the contributing guidelines to contribute to the project.