laranepal icon indicating copy to clipboard operation
laranepal copied to clipboard

Laravel Package to retrieve provinces, districts and municipalities of Nepal

Laravel Nepal

Stars Software License Total Downloads

LaraNepal

Install

composer require pratiksh/laranepal

then publish the package seeds

php artisan import:nepal
composer dump-autoload

then migrate the tables

php artisan migrate

that's it, you are good to go.

Note if seeder not found run composer dump-autoload

Usage

Package uses facade LaraNepal to retrive

  • Provinces
  • Districts
  • Municipalities
// use Pratiksh\LaraNepal\Facade\LaraNepal;

$provinces = LaraNepal::provinces();
$districts = LaraNepal::districts();
$municipalities = LaraNepal::municipalities();

Relations

Package also provides relation among provinces, districts and municipalities.

// use Pratiksh\LaraNepal\Facade\LaraNepal;

// Province District Relation
$province = LaraNepal::provinces()->first();
$provinces->districts; // Retrives districts of that particular province

// District Province Relation
$district = LaraNepal::districts()->first();
$district->province; // Retrives province where that district belongs to.

// District Municipality Relation
$district = LaraNepal::districts()->first();
$district->municipalities;

// Muncipality district relation
$municipality = LaraNepal::municipalities()->first();
$municipality->district; // Retrive district where that municipality belongs to

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

License

The MIT License (MIT). Please see License File for more information.