README

Enhanced Laravel Locations package with Cities/Districts support, including comprehensive Egypt cities data.

Features

This package provides quick and easy methods to get:

• ✅ Timezones
• ✅ Continents
• ✅ Countries (with Currency, Phone Code, Languages, Capital)
• ✅ States/Provinces
• ✅ Cities/Districts (NEW!) - With full Egypt cities support
• ✅ Multi-language support (English & Arabic)

Installation

composer require fatmasaad/laravel-locations-egypt

Usage

Get Countries

$countries = getCountries();
$egypt = getCountry('EG');

Get States

$states = getStates('EG'); // Get all Egypt states
$cairo = getState('C', 'EG'); // Get Cairo state

Get Cities/Districts (NEW!)

// Get all cities for Egypt (all governorates)
$allCities = getCities('EG');

// Get cities for Cairo Governorate
$cairoCities = getCities('EG', 'C');

// Get cities in Arabic
$cairoCitiesAr = getCities('EG', 'C', 'ar');

// Get a specific city
$city = getCity('C001', 'EG', 'C'); // Returns "Cairo"
$cityAr = getCity('C001', 'EG', 'C', 'ar'); // Returns "القاهرة"

Get Cities for Giza Governorate

$gizaCities = getCities('EG', 'GZ');
// Returns: Giza, 6th of October City, Agouza, Dokki, etc.

$gizaCitiesAr = getCities('EG', 'GZ', 'ar');
// Returns: الجيزة، مدينة السادس من أكتوبر، العجوزة، الدقي، إلخ

Egypt Cities Coverage

All 26 Egyptian governorates are included with their major cities:

• Alexandria (ALX) - 13 cities
• Aswan (ASN) - 7 cities
• Asyut (AST) - 10 cities
• Beheira (BH) - 13 cities
• Beni Suef (BNS) - 7 cities
• Cairo (C) - 35 cities
• Dakahlia (DK) - 14 cities
• Damietta (DT) - 6 cities
• Faiyum (FYM) - 7 cities
• Gharbia (GH) - 9 cities
• Giza (GZ) - 22 cities
• Ismailia (IS) - 7 cities
• Kafr el-Sheikh (KFS) - 9 cities
• Luxor (LX) - 7 cities
• Matrouh (MT) - 7 cities
• Minya (MN) - 7 cities
• Monufia (MNF) - 8 cities
• New Valley (WAD) - 5 cities
• North Sinai (SIN) - 6 cities
• Port Said (PTS) - 2 cities
• Qalyubia (KB) - 6 cities
• Qena (KN) - 6 cities
• Red Sea (BA) - 6 cities
• Sohag (SHG) - 9 cities
• South Sinai (JS) - 8 cities
• Suez (SUZ) - 4 cities

Total: 26 governorates, 250+ cities with English and Arabic translations

Language Support

The package supports multiple languages. By default, it uses your application's locale:

// Uses app locale
app()->setLocale('ar');
$cities = getCities('EG', 'C'); // Returns Arabic names

app()->setLocale('en');
$cities = getCities('EG', 'C'); // Returns English names

// Or specify language explicitly
$cities = getCities('EG', 'C', 'ar');
$cities = getCities('EG', 'C', 'en');

Available Functions

Location Functions

• getTimeZones($lang) - Get all timezones
• getContinents($lang) - Get all continents
• getContinent($code, $lang) - Get specific continent
• getCountries($lang) - Get all countries
• getCountry($code, $lang) - Get specific country
• getCountriesNames($lang) - Get country names only
• getStates($country, $lang) - Get states for a country
• getState($code, $country, $lang) - Get specific state
• getCurrencies() - Get all currencies

City Functions (NEW!)

• getCities($country, $state, $lang) - Get cities for country/state
• getCity($code, $country, $state, $lang) - Get specific city

Credits

This package is based on pharaonic/laravel-locations with enhanced cities support.

License

This package is open-sourced software licensed under the MIT license.