denason/iran-location

A Laravel package to manage Iranian location data including provinces and cities,and Eloquent relations,helpers,facades and Caching features

v1.1.4 2025-04-21 14:10 UTC

This package is auto-updated.

Last update: 2025-05-13 07:58:33 UTC


README

🌾 اطلاعات موقعیت مکانی ایران (استان‌ها و شهرها)

Latest Version on Packagist License: MIT Laravel Tests Total Downloads

🌾 اطلاعات موقعیت مکانی ایران (استان‌ها و شهرها)

این پکیج لاراول، لیست کامل استان‌های ایران و شهرهای وابسته به هر استان را فراهم می‌کند.

A professional and extendable Laravel package for accessing all Iranian provinces and their cities.

✨ ویژگی‌ها

  • 🌍 لیست کامل استان‌ها و شهرهای ایران
  • 🔗 رابطه‌ی یک‌به‌چند بین استان‌ها و شهرها
  • ⚡ فراخوانی ساده از طریق Facade و Helper
  • 🔎 قابلیت دریافت شهرها براساس ID یا نام استان
  • 🌐 پشتیبانی از نام فارسی (و در آینده: انگلیسی)
  • 🧰 مناسب برای پروژه‌های فرم‌محور
  • ⚙️ کشینگ برای افزایش سرعت و کارایی

📦 نصب پکیج

composer require denason/iran-location

⚙️ مراحل نصب و راه‌اندازی

php artisan iran-location:install
  • اجرای مایگریشن‌ها
  • اجرای Seeder برای استان‌ها و شهرها

🚀 استفاده از پکیج

Facade:

use Denason\IranLocation\Facades\IranLocation;

$provinces = IranLocation::getProvinces();

Helper:

$provinces = iranLocation()->getProvinces();
$cities = iranLocation()->getCitiesByProvinceId(1);

⚖️ متدهای قابل استفاده

Method Description
getProvinces() دریافت تمام استان‌ها
getProvinceById($id) دریافت استان بر اساس ID
getProvinceByName($name) دریافت استان بر اساس نام
getCities() دریافت تمام شهرها
getCitiesByProvinceId($provinceId) دریافت شهرهای یک استان بر اساس ID
getCitiesByProvinceName($provinceName) دریافت شهرهای یک استان بر اساس نام
getCityById($id) دریافت یک شهر خاص بر اساس ID
getCityByName($name) دریافت یک شهر خاص بر اساس نام
getProvincesWithCities() دریافت همه استان‌ها همراه با لیست شهرها
getProvinceOfCityId($cityId) دریافت استان مربوط به یک شهر بر اساس ID
getProvinceOfCityName($cityName) دریافت استان مربوط به یک شهر بر اساس نام