Skip to content

Commit b1e1e83

Browse files
mediliesmedilies
committed
update readme
1 parent 0d5fd64 commit b1e1e83

File tree

2 files changed

+91
-69
lines changed

2 files changed

+91
-69
lines changed

‎README.md

Lines changed: 27 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/elaborate-code/laravel-algerian-provinces/run-tests?label=Tests&style=for-the-badge)
66
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/elaborate-code/laravel-algerian-provinces/Fix%20PHP%20code%20style%20issues?label=Code%20Style&style=for-the-badge)
77

8-
![banner](https://banners.beyondco.de/Algerian%20provinces.png?theme=dark&packageManager=composer+require&packageName=elaborate-code%2Flaravel-algerian-provinces&pattern=architect&style=style_1&description=Add+Algerian+provinces+table+to+Laravel&md=1&showWatermark=0&fontSize=100px&images=database)
8+
![banner](https://banners.beyondco.de/Algerian%20provinces.png?theme=dark&packageManager=composer+require&packageName=elaborate-code%2Flaravel-algerian-provinces&pattern=architect&style=style_1&description=A+table+seeded+with+the+58+Algerian+provinces+for+Laravel+apps&md=1&showWatermark=0&fontSize=100px&images=database)
99

10-
Algerian provinces migration and seeder for Laravel applications
10+
[Algerian provinces](wilayas.md) migration and seeder for Laravel applications
1111

1212
## Installation
1313

@@ -44,7 +44,7 @@ This is the contents of the published config file:
4444
```php
4545
return [
4646
'table_name' => null, // defaults to wilayas
47-
'column_name' => [
47+
'columns_names' => [
4848
'wilaya_fr_name' => null, // defaults to fr_name
4949
'wilaya_ar_name' => null, // defaults to ar_name
5050
],
@@ -55,7 +55,9 @@ That allows you to rename the `table` and `columns` names before running the mig
5555

5656
## Usage
5757

58-
After publishing and running the migrations, add the `ElaborateCode\AlgerianProvinces\Database\Seeders\WilayaSeeder` to the called seeders list or call it directly from the command line.
58+
### Seeding
59+
60+
After publishing and running the migrations, add the `ElaborateCode\AlgerianProvinces\Database\Seeders\WilayaSeeder` to the called seeders list:
5961

6062
```php
6163
<?php
@@ -66,11 +68,7 @@ use Illuminate\Database\Seeder;
6668

6769
class DatabaseSeeder extends Seeder
6870
{
69-
/**
70-
* Seed the application's database.
71-
*
72-
* @return void
73-
*/
71+
7472
public function run()
7573
{
7674
$this->call([
@@ -80,70 +78,30 @@ class DatabaseSeeder extends Seeder
8078
}
8179
```
8280

81+
Or call it directly from the command line:
82+
8383
```php
8484
php .\artisan db:seed --class=ElaborateCode\AlgerianProvinces\Database\Seeders\WilayaSeeder
8585
```
86+
### Model
8687

87-
| Code | Province | Arabic name |
88-
|--------|--------------------|------------------|
89-
| 01 | Adrar | أدرار |
90-
| 02 | Chlef | الشلف |
91-
| 03 | Laghouat | الأغواط |
92-
| 04 | Oum El Bouaghi | أم البواقي |
93-
| 05 | Batna | باتنة |
94-
| 06 | Béjaïa | بجاية |
95-
| 07 | Biskra | بسكرة |
96-
| 08 | Béchar | بشار |
97-
| 09 | Blida | البليدة |
98-
| 10 | Bouïra | البويرة |
99-
| 11 | Tamanrasset | تمنراست |
100-
| 12 | Tébessa | تبسة |
101-
| 13 | Tlemcen | تلمسان |
102-
| 14 | Tiaret | تيارت |
103-
| 15 | Tizi Ouzou | تيزي وزو |
104-
| 16 | Algiers | الجزائر |
105-
| 17 | Djelfa | الجلفة |
106-
| 18 | Jijel | جيجل |
107-
| 19 | Sétif | سطيف |
108-
| 20 | Saïda | سعيدة |
109-
| 21 | Skikda | سكيكدة |
110-
| 22 | Sidi Bel Abbès | سيدي بلعباس |
111-
| 23 | Annaba | عنابة |
112-
| 24 | Guelma | قالمة |
113-
| 25 | Constantine | قسنطينة |
114-
| 26 | Médéa | المدية |
115-
| 27 | Mostaganem | مستغانم |
116-
| 28 | M'Sila | المسيلة |
117-
| 29 | Mascara | معسكر |
118-
| 30 | Ouargla | ورقلة |
119-
| 31 | Oran | وهران |
120-
| 32 | El Bayadh | البيض |
121-
| 33 | Illizi | اليزي |
122-
| 34 | Bordj Bou Arréridj | برج بوعريريج |
123-
| 35 | Boumerdès | بومرداس |
124-
| 36 | El Tarf | الطارف |
125-
| 37 | Tindouf | تندوف |
126-
| 38 | Tissemsilt | تسمسيلت |
127-
| 39 | El Oued | الوادي |
128-
| 40 | Khenchela | خنشلة |
129-
| 41 | Souk Ahras | سوق أهراس |
130-
| 42 | Tipaza | تيبازة |
131-
| 43 | Mila | ميلة |
132-
| 44 | Aïn Defla | عين الدفلى |
133-
| 45 | Naâma | النعامة |
134-
| 46 | Aïn Témouchent | عين تموشنت |
135-
| 47 | Ghardaïa | غرداية |
136-
| 48 | Relizane | غليزان |
137-
| 49 | El M'Ghair | المغير |
138-
| 50 | El Menia | المنيعة |
139-
| 51 | Ouled Djellal | أولاد جلال |
140-
| 52 | Bordj Baji Mokhtar | برج باجي مختار |
141-
| 53 | Béni Abbès | بني عباس |
142-
| 54 | Timimoun | تيميمون |
143-
| 55 | Touggourt | تقرت |
144-
| 56 | Djanet | جانت |
145-
| 57 | In Salah | عين صالح |
146-
| 58 | In Guezzam | عين قزّام |
88+
```php
89+
namespace ElaborateCode\AlgerianProvinces\Models;
90+
91+
use Illuminate\Database\Eloquent\Model;
92+
93+
class Wilaya extends Model
94+
{
95+
protected $fillable = [];
96+
97+
public function __construct(array $attributes = [])
98+
{
99+
parent::__construct($attributes);
100+
101+
$this->table = config('algerian-provinces.table_name') ?? 'wilayas';
102+
}
103+
}
104+
```
147105

148106
## Testing
149107

‎wilayas.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Wilayas table
2+
3+
Here is what the migrated and seeded table will look like
4+
5+
| id | fr_name | ar_name |
6+
| --- | ------------------ | -------------- |
7+
| 1 | Adrar | أدرار |
8+
| 2 | Chlef | الشلف |
9+
| 3 | Laghouat | الأغواط |
10+
| 4 | Oum El Bouaghi | أم البواقي |
11+
| 5 | Batna | باتنة |
12+
| 6 | Béjaïa | بجاية |
13+
| 7 | Biskra | بسكرة |
14+
| 8 | Béchar | بشار |
15+
| 9 | Blida | البليدة |
16+
| 10 | Bouïra | البويرة |
17+
| 11 | Tamanrasset | تمنراست |
18+
| 12 | Tébessa | تبسة |
19+
| 13 | Tlemcen | تلمسان |
20+
| 14 | Tiaret | تيارت |
21+
| 15 | Tizi Ouzou | تيزي وزو |
22+
| 16 | Algiers | الجزائر |
23+
| 17 | Djelfa | الجلفة |
24+
| 18 | Jijel | جيجل |
25+
| 19 | Sétif | سطيف |
26+
| 20 | Saïda | سعيدة |
27+
| 21 | Skikda | سكيكدة |
28+
| 22 | Sidi Bel Abbès | سيدي بلعباس |
29+
| 23 | Annaba | عنابة |
30+
| 24 | Guelma | قالمة |
31+
| 25 | Constantine | قسنطينة |
32+
| 26 | Médéa | المدية |
33+
| 27 | Mostaganem | مستغانم |
34+
| 28 | M'Sila | المسيلة |
35+
| 29 | Mascara | معسكر |
36+
| 30 | Ouargla | ورقلة |
37+
| 31 | Oran | وهران |
38+
| 32 | El Bayadh | البيض |
39+
| 33 | Illizi | اليزي |
40+
| 34 | Bordj Bou Arréridj | برج بوعريريج |
41+
| 35 | Boumerdès | بومرداس |
42+
| 36 | El Tarf | الطارف |
43+
| 37 | Tindouf | تندوف |
44+
| 38 | Tissemsilt | تسمسيلت |
45+
| 39 | El Oued | الوادي |
46+
| 40 | Khenchela | خنشلة |
47+
| 41 | Souk Ahras | سوق أهراس |
48+
| 42 | Tipaza | تيبازة |
49+
| 43 | Mila | ميلة |
50+
| 44 | Aïn Defla | عين الدفلى |
51+
| 45 | Naâma | النعامة |
52+
| 46 | Aïn Témouchent | عين تموشنت |
53+
| 47 | Ghardaïa | غرداية |
54+
| 48 | Relizane | غليزان |
55+
| 49 | El M'Ghair | المغير |
56+
| 50 | El Menia | المنيعة |
57+
| 51 | Ouled Djellal | أولاد جلال |
58+
| 52 | Bordj Baji Mokhtar | برج باجي مختار |
59+
| 53 | Béni Abbès | بني عباس |
60+
| 54 | Timimoun | تيميمون |
61+
| 55 | Touggourt | تقرت |
62+
| 56 | Djanet | جانت |
63+
| 57 | In Salah | عين صالح |
64+
| 58 | In Guezzam | عين قزّام |

0 commit comments

Comments
 (0)