Rinvex Country is a simple and lightweight package for retrieving country details with flexibility. A whole bunch of data including name, demonym, capital, iso codes, dialling codes, geo data, currencies, and other attributes for all 250 countries worldwide at your fingertips.
Install via composer require rinvex/country, then use as follows:
use Rinvex\Country\Models\Country;
// Find a country by it's ISO 3166-1 alpha-2
$egypt = (new Country)->find('EG');
// Find a country by one of it's attributes
$usa = (new Country)->findBy('capital', 'Washington D.C.');
// Find all countries
$countries = (new Country)->findAll();
// Retrieve only `name`, `demonym`, and `currency` attributes of "Japan":
$japan = (new Country)->find('JP', ['name', 'demonym', 'currency']);
// Utilize Laravel Collections to get an array of all country names, with their 'iso_3166_1_alpha2' as the array keys
$allCountries = (new Country)->findAll()->pluck('name.common', 'iso_3166_1_alpha2');Mission accomplished! You're good to use this package right now! ✅
Unless you're new to this kind of stuff, you can skip the following steps! 😉
- Installation
- Integration
- Usage
- Country Example
- Features Explained
- Inspired By
- Changelog
- Support
- Contributing & Protocols
- Security Vulnerabilities
- About Rinvex
- License
The best and easiest way to install this package is through Composer.
This package fully compatible with Laravel 5.1.*, 5.2.*, and 5.3.*.
While this package tends to be framework-agnostic, it embraces Laravel culture and best practices to some extent. It's tested mainly with Laravel but you still can use it with other frameworks or even without any framework if you want.
"php": ">=5.5.9",
"illuminate/support": "5.1.*|5.2.*|5.3.*"Open your application's composer.json file and add the following line to the require array:
"rinvex/country": "1.0.*"Note: Make sure that after the required changes your
composer.jsonfile is valid by runningcomposer validate.
On your terminal run composer install or composer update command according to your application's status to install the new requirements.
Note: Checkout Composer's Basic Usage documentation for further details.
Rinvex Repository package is framework-agnostic and as such can be integrated easily natively or with your favorite framework.
Integrating the package outside of a framework is incredibly easy, just require the vendor/autoload.php file to autoload the package.
Note: Checkout Composer's Autoloading documentation for further details.
Integrating the package inside Laravel framework takes much less work, actually it doesn't require any integration steps after installation. Just jump directly to the Usage section. Awesome, huh?
Using this package is pretty easy, and straightforward. It provides you with few simple and intuitive API.
First you need to import Rinvex\Country\Models\Country class in your file, then you can use any of the Country class methods, as follows:
use Rinvex\Country\Models\Country;The find method finds a country by it's ISO 3166-1 alpha-2, and returns an array of first result:
$egypt = (new Country)->find('EG');The findBy method finds a country by one of it's attributes, and returns an array of first result:
$usa = (new Country)->findBy('capital', 'Washington D.C.');The findAll method finds all countries, and returns a collection of all results:
$countries = (new Country)->findAll();This package utilizes Laravel Collections, so you can just manipulate findAll method results the way you need. Example:
// Get an array of all country names, with their 'iso_3166_1_alpha2' as the array keys
$allCountries = (new Country)->findAll()->pluck('name.common', 'iso_3166_1_alpha2');Note: All
find*methods have an optional parameter for retrieved columns/attributes, see the following example:
Retrieve only name, demonym, and currency attributes of "Japan":
$japan = (new Country)->find('JP', ['name', 'demonym', 'currency']);{
"EG": {
"name": {
"common": "Egypt",
"official": "Arab Republic of Egypt",
"native": {
"ara": {
"official": "جمهورية مصر العربية",
"common": "مصر"
}
}
},
"demonym": "Egyptian",
"capital": "Cairo",
"iso_3166_1_alpha2": "EG",
"iso_3166_1_alpha3": "EGY",
"iso_3166_1_numeric": "818",
"currency": {
"EGP": {
"iso_4217_code": "EGP",
"iso_4217_numeric": 818,
"iso_4217_name": "Egyptian Pound",
"iso_4217_minor_unit": 2
}
},
"tld": [
".eg",
".مصر"
],
"alt_spellings": [
"EG",
"Arab Republic of Egypt"
],
"languages": {
"ara": "Arabic"
},
"translations": {
"cym": {
"official": "Arab Republic of Egypt",
"common": "Yr Aifft"
},
"deu": {
"official": "Arabische Republik Ägypten",
"common": "Ägypten"
},
"fra": {
"official": "République arabe d'Égypte",
"common": "Égypte"
},
"hrv": {
"official": "Arapska Republika Egipat",
"common": "Egipat"
},
"ita": {
"official": "Repubblica araba d'Egitto",
"common": "Egitto"
},
"jpn": {
"official": "エジプト·アラブ共和国",
"common": "エジプト"
},
"nld": {
"official": "Arabische Republiek Egypte",
"common": "Egypte"
},
"por": {
"official": "República Árabe do Egipto",
"common": "Egito"
},
"rus": {
"official": "Арабская Республика Египет",
"common": "Египет"
},
"spa": {
"official": "República Árabe de Egipto",
"common": "Egipto"
},
"fin": {
"official": "Egyptin arabitasavalta",
"common": "Egypti"
}
},
"geo": {
"continent": {
"AF": "Africa"
},
"postal_code": true,
"latitude": "27 00 N",
"latitude_dec": "26.756103515625",
"longitude": "30 00 E",
"longitude_dec": "29.86229705810547",
"max_latitude": "31.916667",
"max_longitude": "36.333333",
"min_latitude": "20.383333",
"min_longitude": "24.7",
"area": 1002450,
"region": "Africa",
"subregion": "Northern Africa",
"world_region": "EMEA",
"region_code": "002",
"subregion_code": "015",
"landlocked": false,
"borders": [
"ISR",
"LBY",
"SDN"
],
"independent": "Yes"
},
"dialling": {
"calling_code": [
"20"
],
"national_prefix": "0",
"national_number_lengths": [
9
],
"national_destination_code_lengths": [
2
],
"international_prefix": "00"
},
"extra": {
"geonameid": 357994,
"edgar": "H2",
"itu": "EGY",
"marc": "ua",
"wmo": "EG",
"ds": "ET",
"fifa": "EGY",
"fips": "EG",
"gaul": 40765,
"ioc": "EGY",
"cowc": "EGY",
"cown": 651,
"fao": 59,
"imf": 469,
"ar5": "MAF",
"address_format": "{{recipient}}\n{{street}}\n{{postalcode}} {{city}}\n{{country}}",
"eu_member": null,
"vat_rates": null
}
}
}- Country data are all stored here:
resources/data/countries.json. namecommon- common name in englishofficial- official name in englishnative- list of all native names- key: three-letter ISO 639-3 language alpha code
- value: name object
- key:
official- official name translation - key:
common- common name translation
- key:
demonym- name of residentscapital- capital cityiso_3166_1_alpha2- code ISO 3166-1 alpha-2iso_3166_1_alpha3-code ISO 3166-1 alpha-3iso_3166_1_numeric- code ISO 3166-1 numericcurrency- ISO 4217 currency code(s)- key: three-letter ISO 4217 currency code
- value: currency object
- key:
iso_4217_code- three-letter ISO 4217 currency alpha code - key:
iso_4217_numeric- three-number ISO 4217 currency numeric code - key:
iso_4217_name- official ISO 4217 currency name - key:
iso_4217_minor_unit- minor currency unit
- key:
tld- country code top-level domainalt_spellings- alternative spellingslanguages- list of official languages- key: three-letter ISO 639-3 language code
- value: name of the language in english
translations- list of name translations- key: three-letter ISO 639-3 language code
- value: name object
- key:
official- official name translation - key:
common- common name translation
- key:
geocontinent- continents that country lies in- key: two-letter continent code
- value: name of the continent in english
postal_code- geographical area postal codelatitude- short form of latitude coordinate pointlatitude_dec- described latitude coordinate pointlongitude- short form of longitude coordinate pointlongitude_dec- described longitude coordinate pointmax_latitude- maximum latitude coordinate pointmax_longitude- maximum longitude coordinate pointmin_latitude- minimum latitude coordinate pointmin_longitude- minimum longitude coordinate pointarea- land area in km²region- geographical regionsubregion- geographical sub-regionworld_region- geographical world regionregion_code- geographical region numeric codesubregion_code- geographical sub-region numeric codelandlocked- landlocked statusborders- land bordersindependent- independent status
diallingcalling_code- calling code(s)national_prefix- national prefixnational_number_lengths- national number lengthsnational_destination_code_lengths- national destination code lengthsinternational_prefix- international prefix
extrageonameid- Geoname IDedgar- Electronic Data Gathering, Analysis, and Retrieval systemitu- Codes assigned by the International Telecommunications Unionmarc- MAchine-Readable Cataloging codes from the Library of Congresswmo- Country abbreviations by the World Meteorological Organizationds- Distinguishing signs of vehicles in international trafficfifa- Codes assigned by the Fédération Internationale de Football Associationfips- Codes from the U.S. Federal Information Processing Standardgaul- Global Administrative Unit Layers from the Food and Agriculture Organizationioc- Codes assigned by the International Olympics Committeecowc- Correlates of War charactercown- Correlates of War numericfao- Food and Agriculture Organizationimf- International Monetary Fundar5- Fifth Assessment Report (AR5)address_format- Address formaeu_member- European Union Membervat_rates- Value-Added Tax
This package has been inspired by, and used some country data of the following open-source projects:
- https://en.wikipedia.org
- https://github.com/hexorx/countries
- https://github.com/mledoze/countries
- https://github.com/annexare/Countries
- https://github.com/umpirsky/country-list
- https://github.com/datasets/country-list
- https://github.com/datasets/country-codes
- https://github.com/sripaulgit/country-codes
- https://github.com/alexrabarts/iso_country_codes
- https://github.com/vincentarelbundock/countrycode
- https://github.com/lukes/ISO-3166-Countries-with-Regional-Codes
Refer to the Changelog for a full history of the project.
The following support channels are available at your fingertips:
Thank you for considering contributing to this project! The contribution guide can be found in CONTRIBUTING.md.
Bug reports, feature requests, and pull requests are very welcome.
If you discover a security vulnerability within this project, please send an e-mail to help@rinvex.com. All security vulnerabilities will be promptly addressed.
Rinvex is a software solutions startup, specialized in integrated enterprise solutions for SMEs established in Alexandria, Egypt since June 2016. We believe that our drive The Value, The Reach, and The Impact is what differentiates us and unleash the endless possibilities of our philosophy through the power of software. We like to call it Innovation At The Speed Of Life. That’s how we do our share of advancing humanity.
This software is released under The MIT License (MIT).
(c) 2016 Rinvex LLC, Some rights reserved.