README

Grew tired of repeating the same step in every project to add address to your forms. I had the same frustration, which why I made this package to get you up and running with just few commands.

Acknowledgment

Dataset was taken from this repo

Status

This package is still under development. Use at your own discretion. You can open an issue for bugs or features you would like to be included in the future.

Instalation

composer require  anouar-touati/algerian-cities-laravel

php artisan migrate

php artisan db:seed --class="AnouarTouati\AlgerianCitiesLaravel\Database\Seeders\AlgerianCitiesSeeder"

If auto discovery does not work for you, add this under providers in config/app.php :

AnouarTouati\AlgerianCitiesLaravel\AlgerianCitiesServiceProvider::class

Usage

API

Call these json endpoints

response format :

[
    {
        "wilaya_code": 3,
        "wilaya_name": "الأغواط",
        "wilaya_name_ascii": "Laghouat"
    },
    {
        "wilaya_code": 4,
        "wilaya_name": "أم البواقي",
        "wilaya_name_ascii": "Oum El Bouaghi"
    },

]

response format :

[
    {
        "daira_name": "المنيعة",
        "daira_name_ascii": "El Menia"
    },
    {
        "daira_name": "المنصورة",
        "daira_name_ascii": "Mansourah"
    },

]

response format :

[
    {
        "commune_name": "بئر مراد رايس",
        "commune_name_ascii": "Bir Mourad Rais"
    },
    {
        "commune_name": "بئر خادم",
        "commune_name_ascii": "Birkhadem"
    },

]

response format :

[
    {
        "post_code": 35000,
        "post_name": "بومرداس - القباضة الرئيسية",
        "post_name_ascii": "Boumerdes",
        "post_address": "بومرداس - حي 408 مسكن",
        "post_address_ascii": "Cité 408 Logements Boumerdes"
    },
    {
        "post_code": 35007,
        "post_name": "بومرداس - فرانتز فانون",
        "post_name_ascii": "Boumerdes Frantz Fanon",
        "post_address": "بومرداس - حي 350 مسكن",
        "post_address_ascii": "Cité 350 Logements Boumerdes"
    },

]

Use through the AlgerianCitiesFacade

you can use the methods that the API controller is built with by including this line to the top of your file :

use AnouarTouati\AlgerianCitiesLaravel\Facades\AlgerianCitiesFacade;

All of these methods return a Collection

Built-in address Blade component

You can add this ready to use component to your form which will provide the HTML dropdowns for selecting the address and the logic to populate them.

You can add styling by passing values to the :select_style and :label_style props as shown below.

You also need to have the Blade directive @stack with the word scripts like so @stack('scripts') under the closing body tag if you dont have that already.

Example:

 <form action="/formsubmit" method="get">
        <p>Please fill this form</p>

        <x-algerian-citites-laravel::address 
            {{-- The styles below are hideous xD, they are just for demonstartion purposes --}}
            :select_style="'background:green;color:white;'" 
            :label_style="'display:block;color:blue;'"
            />

        <button type="submit">Submit</button>
</form>

Localization

English, French and Arabic translations are available by default for the address form.

If you want to override the default translations you may do so, publish the file to lang/vendor/algerian-cities-laravel by running the following command:

php artisan vendor:publish --tag=algerian-cities-laravel-localization