coolsam/laravel-mongodb-world

Provide countries, states, and cities relations database for mongodb in laravel using jenssegers/laravel-mongodb

v1.0.1 2018-07-23 13:40 UTC

Requires

• php: >=7.0
• jenssegers/mongodb: ^3.4
• jenssegers/mongodb-session: ^1.2
• laravel/framework: >=5.3.0

Requires (Dev)

• mockery/mockery: ~0.9
• phpunit/phpunit: ~5.0

MIT

• Sam (coolsam) Maosa

• mongodb
• locale
• laravel
• country
• region
• city
• world
• laravel-mongodb

README

This package focused on World Countries, Regions, and Cities database with locale support for Laravel using the Laravel-MongoDB package by Jenssegers.

Conceptions

There are 5 main objects in this package.

• World: the earth world.
• Continent: 7 continent
• Country: 247 countries
• Division: Divisions such as state/province.
• City: the last level of region, some cities up to Country, some up to Division.

Attributes

Common attributes:

• name: Common name of region.
• full_name: Full name or official name
• code: ISO-3166-1-alpha2/ISO-3166-2 code
• local_name: translation of Common name
• local_full_name: translation of full name
• local_alias: alias in different language
• local_abbr: Abbreviation

Country spec attributes:

• emoji: Emoji flag of country
• capital: Captial of this country
• code_alpha3: Code of ISO-3166-1-alpha3
• currency_code: ISO-4177 Currency Code, e.g. USD, CNY
• currency_name: ISO-4177 Currency Name,
• local_currency_name: ISO-4177 Currency name in locale

Example:

use Coolsam\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; // 人民币

Localization

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.

##Dependencies

• This package depends on jenssegers/laravel-mongodbhttps://github.com/jenssegers/laravel-mongodb. Ensure you finish all the setup steps and have your laravel app working with mongodb before you proceed to setup.

Setup

• composer require

composer require coolsam/laravel-mongodb-world

• Add Service Provider into config/app.php

'providers' => [
    // ...
    Coolsam\World\WorldServiceProvider::class,
]

• Publish and init

php artisan vendor:publish --force --provider="Coolsam\World\WorldServiceProvider"
composer dump-autoload
php artisan world:init

Usage

• get all Continent

use Coolsam\World\World;

World::Continents()

• get all Countries

use Coolsam\World\World;

World::Countries()

• get country by code

use Coolsam\World\World;

Country::getByCode('cn');

• get countries belong to a continent

use Coolsam\World\Models\Continent;

$asia = Continent::getByCode('AS');
$countries = $asia->countries()->get();
// or use children method
$countries = $asia->children();

• get continent or parent

$china = Country::getByCode('cn');
$asia = $china->parent();

• get division/state/province via Conutry

$china = Country::getByCode('cn');
$provinces = $china->divisions()->get()
// or use children method
$provinces = $china->children();

• get cities via Country or Division.

$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();

About

This package published under MIT license. If you have any question or suggestion, please feel free to submit a issue, or email me Sam Maosa<maosa.sam(AT)gmail.com>.

Good luck being a real Big-Data artisan.