Download the PHP package shimadotdev/iran-regions without Composer
On this page you can find all versions of the php package shimadotdev/iran-regions. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download shimadotdev/iran-regions
More information about shimadotdev/iran-regions
Files in shimadotdev/iran-regions
Package iran-regions
Short Description A Laravel package containing province and city data of Iran, including calling codes, along with geolocation functionality. Ideal for managing location-based information within Laravel apps.
License MIT
Informations about the package iran-regions
Iran Regions Laravel Package
A Laravel package containing province and city data of Iran, including calling codes, along with geolocation functionality. Ideal for managing location-based information within Laravel apps.
Installation
You can install the package via Composer by running:
After installing the package, run the following Artisan command to set up the necessary migrations and seed the database with provided data:
This command will create two tables named cities and provinces in your database, seeded with the required data.
Usage
Once the package is installed and migrations are run, you can start using the provided functionality.
Example Usage
You can access province and city data using the Iran
Class:
As you see, you can also utilize Laravel's Eloquent ORM to create custom queries and interact with the data as usual.
Localization Support
The package supports two languages: English (en) and Persian (fa) for all city and province names. You can access them using their respective slugs:
Database Structure
The package creates the following tables in your database:
cities
Table
Column | Description |
---|---|
id | Primary key |
slug | City slug |
is_active | Active status |
province_id | Foreign key to provinces table |
latitude | City latitude |
longitude | City longitude |
provinces
Table
Column | Description |
---|---|
id | Primary key |
slug | Province slug |
is_active | Active status |
latitude | Province latitude |
longitude | Province longitude |
calling_code | Calling code of the province |
Testing
You can run the automated tests for the package using PHPUnit:
Contributing
Contributions are welcome! If you have any ideas for improvements or find any issues, please submit them through GitHub issues or create a pull request.
Security Vulnerabilities
If you discover any security vulnerabilities, please report them via email to [email protected]
Credits
This package is developed and maintained by Shima.Dev
License
This package is open-source software licensed under the MIT licensev.