README

A comprehensive Bangladesh Geo Location data package for Laravel with support for Divisions, Districts, Upazilas, and Unions.

Features

Complete administrative hierarchy of Bangladesh
- 8 Divisions
- 68 Districts
- 531 Upazilas
- 4,916 Unions
Bilingual (English & Bengali) names
JSON-based data (fast, zero-config)
Optional database support
Search functionality
Validation rules
Artisan commands
Helper functions
Laravel Facade support

Requirements

PHP: 8.2, 8.3, 8.4
Laravel: 10, 11, 12
Composer: 2.x

Installation

Install the package via Composer:

composer require mazhar/bd-geo-location

The package will auto-register the service provider and facade in Laravel.

Configuration (Optional)

Publish the configuration file:

php artisan vendor:publish --tag=bd-geo-config

This will create config/bd-geo.php where you can configure:

return [
    // Data source: 'json' (default) or 'database'
    'data_source' => env('BD_GEO_DATA_SOURCE', 'json'),

    // Cache duration in seconds (default: 0 = disabled)
    // Set to a positive value to enable caching (e.g., 604800 for 7 days)
    'cache_duration' => env('BD_GEO_CACHE_DURATION', 0),

    // Database table prefix
    'table_prefix' => env('BD_GEO_TABLE_PREFIX', 'bd_'),
];

Usage

Using Facade

use Mazhar\BDGeoLocation\Facades\BDGeo;

// Get all divisions
$divisions = BDGeo::getAllDivisions();

// Get division by ID
$division = BDGeo::getDivisionById('30');

// Get districts by division
$districts = BDGeo::getDistrictsByDivision('30');

// Get upazilas by district
$upazilas = BDGeo::getUpazilasByDistrict('3034');

// Get unions by upazila
$unions = BDGeo::getUnionsByUpazila('303427');

// Search by name
$results = BDGeo::searchByName('Dhaka');

// Get complete hierarchy
$hierarchy = BDGeo::getGeoHierarchy('303427', 'upazila');

Using Helper Functions

// Get all divisions
$divisions = bd_divisions();

// Get division by ID
$division = bd_division('30');

// Get districts (all or by division)
$districts = bd_districts('30');

// Get upazilas (all or by district)
$upazilas = bd_upazilas('3034');

// Get unions (all or by upazila)
$unions = bd_unions('303427');

// Search locations
$results = bd_geo_search('Dhaka');

// Get hierarchy
$hierarchy = bd_geo_hierarchy('303427', 'upazila');

In Controllers

use Mazhar\BDGeoLocation\Facades\BDGeo;

class LocationController extends Controller
{
    public function index()
    {
        $divisions = BDGeo::getAllDivisions();

        return response()->json($divisions);
    }

    public function districts($divisionId)
    {
        $districts = BDGeo::getDistrictsByDivision($divisionId);

        return response()->json($districts);
    }

    public function search(Request $request)
    {
        $results = BDGeo::searchByName($request->query('q'));

        return response()->json($results);
    }
}

In Blade Templates

<select name="division">
    @foreach(bd_divisions() as $division)
        <option value="{{ $division['id'] }}">
            {{ $division['name'] }} ({{ $division['name_bn'] }})
        </option>
    @endforeach
</select>

Validation Rules

Use the built-in validation rules to validate geo location IDs:

use Illuminate\Http\Request;
use Mazhar\BDGeoLocation\Validation\Rules\BDDivision;
use Mazhar\BDGeoLocation\Validation\Rules\BDDistrict;
use Mazhar\BDGeoLocation\Validation\Rules\BDUpazila;
use Mazhar\BDGeoLocation\Validation\Rules\BDUnion;

public function store(Request $request)
{
    $validated = $request->validate([
        'division_id' => ['required', new BDDivision],
        'district_id' => ['required', new BDDistrict],
        'upazila_id' => ['nullable', new BDUpazila],
        'union_id' => ['nullable', new BDUnion],
    ]);

    // Your logic here
}

Artisan Commands

Seed Geo Data to Database

If you want to use database instead of JSON, first publish and run migrations:

# Publish migrations
php artisan vendor:publish --tag=bd-geo-migrations

# Run migrations
php artisan migrate

# Seed data to database
php artisan bd-geo:seed

Database Support (Optional)

By default, the package uses JSON files for fast access. If you prefer database queries:

Set BD_GEO_DATA_SOURCE=database in your .env file
Publish and run migrations
Seed the data

php artisan vendor:publish --tag=bd-geo-migrations
php artisan migrate
php artisan bd-geo:seed

Now you can also use Eloquent models:

use Mazhar\BDGeoLocation\Models\Division;
use Mazhar\BDGeoLocation\Models\District;
use Mazhar\BDGeoLocation\Models\Upazila;
use Mazhar\BDGeoLocation\Models\Union;

// Get division with districts
$division = Division::with('districts')->find('30');

// Get district with upazilas
$district = District::with('upazilas')->find('3034');

// Query with relationships
$upazilas = Upazila::with('district.division')->get();

Data Structure

Each location entity contains:

[
    'id' => '30',           // Unique ID
    'name' => 'Dhaka',      // English name
    'name_bn' => 'ঢাকা',   // Bengali name
    'lat' => 23.7104,       // Latitude (divisions & districts)
    'long' => 90.4074,      // Longitude (divisions & districts)
]

API Response Example

{
    "divisions": [
        {
            "id": "30",
            "name": "Dhaka",
            "name_bn": "ঢাকা",
            "lat": "23.71040000",
            "long": "90.40740000"
        }
    ],
    "districts": [
        {
            "id": "3034",
            "division_id": "30",
            "name": "Dhaka",
            "name_bn": "ঢাকা",
            "lat": "23.71153000",
            "long": "90.41158000"
        }
    ]
}

Testing

# Run tests
composer test

# Run tests with coverage report
composer test:coverage

# Run full CI pipeline locally
composer ci

Development

Code Quality Checks

This package includes automated code quality checks:

# Run static analysis (PHPStan)
composer analyse

# Validate composer.json
composer validate --strict

# Run all quality checks
composer quality

PHPStan Configuration

The package uses Larastan for static analysis at level 5. Configuration is in phpstan.neon.

CI/CD

This package uses GitHub Actions for continuous integration:

✅ Tests on PHP 8.2, 8.3, 8.4 with Laravel 10, 11, and 12
✅ Static analysis with PHPStan
✅ Code quality checks
✅ Security audits
✅ Code coverage reporting via Codecov

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Credits

License

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

Also Available

JavaScript/TypeScript version (npm) - For React, Vue, Angular, Node.js
React Native version - For mobile apps

Support

For issues, questions, or contributions, please visit GitHub Issues.

mazharvai / bd-geo-location

Maintainers

Package info

Statistics

Security