Stars: 392
Forks: 82
Pull Requests: 27
Issues: 37
Watchers: 18
Last Updated: 2023-08-14 12:37:28
provide countries, states, and cities relations and database.
License: MIT License
Languages: PHP
This package focused on World Countries, Regions, and Cities database with locale support for Laravel.
There are 5 main objects in this package.
Common attributes:
name
: Common name of region(english).full_name
: Full name or official name(english).code
: ISO-3166-1-alpha2/ISO-3166-2 codelocal_name
: translation of Common namelocal_full_name
: translation of full namelocal_alias
: alias in different languagelocal_abbr
: AbbreviationCountry spec attributes:
emoji
: Emoji flag of countrycapital
: Captial of this countrycode_alpha3
: Code of ISO-3166-1-alpha3currency_code
: ISO-4177 Currency Code, e.g. USD, CNYcurrency_name
: ISO-4177 Currency Name,local_currency_name
: ISO-4177 Currency name in localeExample:
use Khsing\World\World;
$china = World::getByCode('cn');
$china->setLocale('zh-cn');
$china->name; // China
$china->local_name; // 中国
$china->full_name; // People's Republic of China
$china->local_full_name; // 中华人民共和国
$china->emoji; // 🇨🇳
$china->callingcode; // 86
$china->code; // CN
$china->code_alpha3; // CHN
$china->has_division; // true
$china->currency_code; // CNY
$china->currency_name; // Yuan Renminbi
$china->local_currency_name; // 人民币
Right now, only English(default and fallback) and Chinese-Simp zh-cn
are supported. Locale settings is following Laravel project settings in config/app.php
.
composer require
composer require khsing/world
config/app.php
, (Only required before Laravel 5.5)'providers' => [
// ...
Khsing\World\WorldServiceProvider::class,
]
php artisan vendor:publish --force --provider="Khsing\World\WorldServiceProvider"
composer dump-autoload
php artisan world:init
use Khsing\World\World;
World::Continents()
use Khsing\World\World;
World::Countries()
use Khsing\World\World;
World::getByCode('cn'); // iso-3166 alpha 2 code
World::getByCode('chn'); // iso-3166 alpha 3 code
World::getByCode('cn-11'); // Beijing
use Khsing\World\Models\Continent;
$asia = Continent::getByCode('AS');
$countries = $asia->countries()->get();
// or use children method
$countries = $asia->children();
$china = Country::getByCode('cn');
$asia = $china->parent();
$china = Country::getByCode('cn');
$provinces = $china->divisions()->get()
// or use children method
$provinces = $china->children();
$china = Country::getByCode('cn');
// check has_division to determine next level is division or city.
$china->has_division; // true, otherwise is false
$regsions = $china->children();
If you want contribute to this library, issue and pr are welcome. please following those steps.
artisan iseed world_cities,world_cities_locale,world_continents,world_continents_locale,world_countries,world_countries_locale,world_divisions,world_divisions_locale
delete()
with truncate()
, cd database/seeders/ && sed -i 's/->delete()/->truncate()/g' World*.php
This package published under MIT license. If you have any question or suggestion, please feel free to submit a issue, or email me Guixing<khsing.cn(AT)gmail.com>.
Have a nice day.