Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thedevsaddam/world-countries
Provide world country list with country code, city, states and flag
https://github.com/thedevsaddam/world-countries
city countries world
Last synced: 11 days ago
JSON representation
Provide world country list with country code, city, states and flag
- Host: GitHub
- URL: https://github.com/thedevsaddam/world-countries
- Owner: thedevsaddam
- License: mit
- Created: 2016-08-30T13:05:10.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-09-15T18:38:21.000Z (about 8 years ago)
- Last Synced: 2024-03-29T02:04:11.674Z (8 months ago)
- Topics: city, countries, world
- Language: PHP
- Homepage: https://packagist.org/packages/thedevsaddam/world-countries
- Size: 1.16 MB
- Stars: 19
- Watchers: 3
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
World Countries
===================
This package contains world country list along with states, cities, country code and country flags.
----------
Installation
-------------
Via Composer
``` bash
$ composer require thedevsaddam/world-countries
```
Install manually (add the line to composer.json file)
``` bash
"thedevsaddam/world-countries": "1.1"
```
Open your terminal and hit the command
```bash
composer update
```
Add the following line to config/app.php file
```bash
Thedevsaddam\WorldCountries\WorldCountriesServiceProvider::class,
```
To publish the configuration and resources
```bash
php artisan vendor:publish
```
###### ***If you need only flags then avoid the command below. The command will required when you are going to use countries with states, cities, country code etc***
```bash
php artisan world-countries:populate
```
The above command will populate the countries and other tables to database
To drop the populated tables
```bash
php artisan world-countries:drop
```
### **Features**
1. World country list with Official name, short name, flag, latitude, longitude.
1. World country list with states and cities
1. World Timezones (coming soon)
### **Usage**
To fetch all the countries with flag. This will return a collection object so that you can use the available method of Collection class
```php
WorldCountries::getCountriesWithFlag();
```
##### Example
```php
$countries = WorldCountries::getCountriesWithFlag();
foreach($countries as $key => $country){
echo "
";
echo $country['name'];
echo "
";
}
// you can use all the method of Collection class
$country = WorldCountries::getCountriesWithFlag()->where('name', 'Bangladesh');
```
#### Fetch all the countries with state and cities ####
```php
$countries = WorldCountries::getCountriesWithStateCity();
//Note: This query will take some time to fetch all the countries with its associate states and cities
```
#### Get Eloquent model to perform custom query
```php
$countryModel = WorldCountries::getCountryModel();
//Fetch all the countries in array
$countries = $countryModel->get()->toArray();
//Fetch all the countries with states
$countriesWithStates = $countryModel->with('states')->get();
//Note: you can use Laravel eloquent available methods (See the below example)
$countryModel = WorldCountries::getCountryModel();
$country = $countryModel->where('name', 'Bangladesh')->first();
```
Note: You can get city and state model as well. To get them use the methods below
```php
$stateModel = WorldCountries::getStateModel();
$cityModel = WorldCountries::getCityModel();
//now you can perform any query available to Eloquent model
```
###### Best uses of this package is to populate dropdown with countries.
```php
//first get all the countries and populate the country dropdown
$countryModel = WorldCountries::getCountryModel();
$countries = $countryModel->lists('name', 'id');
//you can make an endpoint to fetch all the states against some individual country
$stateModel = WorldCountries::getStateModel();
$states = $stateModel->where('country_id', $someRequest->countryId)->get()->toArray();
return response()-json($states);
// now make another endpoint against the state and fetch all of it's cities.
$cityModel = WorldCountries::getCityModel();
$cities = $cityModel->where('state_id', $someRequest->stateId)->get()->toArray();
return response()->json($cities);
```
##### Config
If you change the flag directory name or path then update the config/flag.php file_path according to the path name
##### Credit
###### Flag and country list json from: [cristiroma](https://github.com/cristiroma/countries)
###### Countries, state and cities mysql dump from: [cristiroma](https://github.com/cristiroma/countries)
Thank you :)