Feature #3 : Districts

app/Exports/DistrictsExport.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Modules\Location\Exports;
+
+use Maatwebsite\Excel\Concerns\FromCollection;
+use Maatwebsite\Excel\Concerns\WithColumnFormatting;
+use Maatwebsite\Excel\Concerns\WithHeadings;
+use Maatwebsite\Excel\Concerns\WithMapping;
+use Modules\Location\Models\District;
+
+class DistrictsExport implements WithColumnFormatting, WithHeadings, FromCollection, withMapping
+{
+    public function collection(){
+        return District::with('city.province')->get();
+    }
+
+    public function map($row): array{
+        return [
+            $row->id,
+            $row->code,
+            $row->name,
+            $row->city->name,
+            $row->city->province->name,
+            $row->created_at
+        ];
+    }
+    public function headings(): array{
+        return [
+            'ID',
+            'Code',
+            'Name',
+            'City',
+            'Province',
+            'Created At'
+        ];
+    }
+
+    public function columnFormats(): array{
+        return [
+            'A' => \PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_NUMBER,
+            'F' => \PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_DATETIME
+        ];
+    }
+}

app/Http/Controllers/CitiesController.php

@@ -132,4 +132,8 @@ class CitiesController extends Controller
     {
         return Excel::download(new CitiesExport, 'cities.xlsx');
     }
+
+    public function getCitiesByProvinceId($id){
+        return response()->json(City::where('province_code', $id)->get());
+    }
 }

app/Http/Controllers/DistrictsController.php

@@ -0,0 +1,135 @@
+<?php
+
+namespace Modules\Location\Http\Controllers;
+
+use App\Http\Controllers\Controller;
+use Illuminate\Http\Request;
+use Maatwebsite\Excel\Facades\Excel;
+use Modules\Location\Exports\DistrictsExport;
+use Modules\Location\Http\Requests\DistrictRequest;
+use Modules\Location\Models\City;
+use Modules\Location\Models\District;
+use Modules\Location\Models\Province;
+
+class DistrictsController extends Controller
+{
+    public $user;
+
+    public function index(){
+        return view('location::districts.index');
+    }
+
+    public function create(){
+        $provinces = Province::all();
+        return view('location::districts.create', compact('provinces'));
+    }
+
+    public function store(DistrictRequest $request){
+        $validate = $request->validated();
+
+        if($validate){
+            try{
+                $district = District::create($validate);
+                return redirect()->route('locations.districts.index')->with('success', 'District created successfully');
+            } catch(\Exception $e){
+                return redirect()->back()->with('error', 'Failed to create district. '.$e->getMessage());
+            }
+        }
+    }
+
+    public function edit($id){
+        $district = District::find($id);
+        $provinces = Province::all();
+        $cities = City::where('province_code', $district->province_code)->get();
+        return view('location::districts.create', compact('district', 'provinces','cities'));
+    }
+
+    public function update(DistrictRequest $request, $id){
+        $validate = $request->validated();
+
+        if($validate){
+            try{
+                $district = District::find($id);
+                $district->update($validate);
+                return redirect()->route('locations.districts.index')->with('success', 'District updated successfully');
+            } catch(\Exception $e){
+                return redirect()->back()->with('error', 'Failed to update district. '.$e->getMessage());
+            }
+        }
+    }
+
+    public function destroy($id){
+        try{
+            District::destroy($id);
+            echo json_encode(['message' => 'District deleted successfully','success'=>true ]);
+        } catch(\Exception $e){
+            echo json_encode(['message' => 'Failed to delete District', 'success' => false]);
+        }
+    }
+
+    public function dataForDatatables(Request $request){
+        if (is_null($this->user) || !$this->user->can('provinces.view')) {
+            //abort(403, 'Sorry! You are not allowed to view users.');
+        }
+
+        // Retrieve data from the database
+        $query = District::query();
+
+        // Apply search filter if provided
+        if ($request->has('search') && !empty($request->get('search'))) {
+            $search = $request->get('search');
+            $query->where(function ($q) use ($search) {
+                $q->where('code', 'LIKE', "%$search%");
+                $q->orWhere('name', 'LIKE', "%$search%");
+                $q->orWhereRelation('city','name', 'LIKE', "%$search%");
+                $q->orWhereRelation('city.province','name', 'LIKE', "%$search%");
+            });
+        }
+
+        // Apply sorting if provided
+        if ($request->has('sortOrder') && !empty($request->get('sortOrder'))) {
+            $order  = $request->get('sortOrder');
+            $column = $request->get('sortField');
+            $query->orderBy($column, $order);
+        }
+
+        // Get the total count of records
+        $totalRecords = $query->count();
+
+        // Apply pagination if provided
+        if ($request->has('page') && $request->has('size')) {
+            $page   = $request->get('page');
+            $size   = $request->get('size');
+            $offset = ($page - 1) * $size; // Calculate the offset
+
+            $query->skip($offset)->take($size);
+        }
+
+        // Get the filtered count of records
+        $filteredRecords = $query->count();
+
+        // Get the data for the current page
+        $cities = $query->with('city.province')->get();
+
+        // Calculate the page count
+        $pageCount = ceil($totalRecords/$request->get('size'));
+
+        // Calculate the current page number
+        $currentPage = 0 + 1;
+
+        // Return the response data as a JSON object
+        return response()->json([
+            'draw'            => $request->get('draw'),
+            'recordsTotal'    => $totalRecords,
+            'recordsFiltered' => $filteredRecords,
+            'pageCount'       => $pageCount,
+            'page'            => $currentPage,
+            'totalCount'      => $totalRecords,
+            'data'            => $cities,
+        ]);
+    }
+
+    public function export(Request $request){
+        return Excel::download(new DistrictsExport, 'districts.xlsx');
+    }
+}

app/Http/Requests/DistrictRequest.php

@@ -0,0 +1,40 @@
+<?php
+
+    namespace Modules\Location\Http\Requests;
+
+    use Illuminate\Foundation\Http\FormRequest;
+
+    class DistrictRequest extends FormRequest
+    {
+        /**
+         * Get the validation rules that apply to the request.
+         */
+        public function rules()
+        : array
+        {
+            $rules = [
+                'province_code' => 'required|exists:provinces,code',
+                'city_code'     => 'required|exists:cities,code',
+            ];
+
+            if ($this->method() === 'PUT') {
+                $rules['code'] = 'required|string|max:6|unique:districts,code,' . $this->id;
+                $rules['name'] = 'required|string|max:2554|unique:districts,name,' . $this->id;
+            } else {
+                $rules['code'] = 'required|string|max:6|unique:districts,code';
+                $rules['name'] = 'required|string|max:2554|unique:districts,name';
+            }
+
+            return $rules;
+        }
+
+
+        /**
+         * Determine if the user is authorized to make this request.
+         */
+        public function authorize()
+        : bool
+        {
+            return true;
+        }
+    }

app/Models/District.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Modules\Location\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Modules\Location\Database\Factories\DistrictFactory;
+
+class District extends Base
+{
+    protected $fillable = ['province_code','city_code', 'code', 'name'];
+
+    public function city(){
+        return $this->belongsTo(City::class, 'city_code', 'code');
+    }
+
+    public function villages(){
+        return $this->hasMany(Village::class, 'district_code', 'code');
+    }
+}

database/migrations/2024_08_08_144302_create_districts_table.php

@@ -0,0 +1,35 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('districts', function (Blueprint $table) {
+            $table->id();
+            $table->string('province_code')->index();
+            $table->string('city_code')->index();
+            $table->string('code');
+            $table->string('name');
+            $table->timestamps();
+            $table->softDeletes();
+            $table->uuid('created_by')->nullable();
+            $table->uuid('updated_by')->nullable();
+            $table->uuid('deleted_by')->nullable();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('districts');
+    }
+};

database/seeders/LocationDatabaseSeeder.php

@@ -14,7 +14,8 @@ class LocationDatabaseSeeder extends Seeder
     {
         $this->call([
             ProvinceSeeder::class,
-            CitySeeder::class
+            CitySeeder::class,
+            DistrictSeeder::class,
         ]);
     }
 }

module.json

@@ -39,7 +39,7 @@
                     },
                     {
                         "title": "Districts",
-                        "path": "",
+                        "path": "locations.districts",
                         "classes": "",
                         "attributes": [],
                         "permission": "",

resources/assets/js/app.js

@@ -0,0 +1,46 @@
+import TomSelect from "tom-select";
+
+let settings = {
+    plugins: ['dropdown_input'],
+    create: true,
+    createOnBlur: true
+};
+
+const provinceSelect = document.querySelector('#province_code');
+const citySelect = document.querySelector('#city_code');
+
+if (provinceSelect && !citySelect) {
+    new TomSelect('#province_code', settings);
+}
+
+if (citySelect) {
+    var tomcities = new TomSelect('#city_code', settings);
+    var tomprovince = new TomSelect('#province_code', {
+        ...settings, // Spread existing settings
+        onChange: function (value) {
+
+            // Destroy only if necessary (prevents unnecessary re-initialization)
+            if (tomcities) {
+                tomcities.destroy();
+            }
+
+            var url = 'locations/cities/province/' + value;
+            fetch(url)
+                .then(response => response.json())
+                .then(data => {
+                    const options = data.map(item => ({
+                        value: item.code,
+                        text: item.name
+                    }));
+
+                    tomcities = new TomSelect('#city_code', {
+                        ...settings, // Spread existing settings (including createOnBlur: false)
+                        options: options
+                    });
+                })
+                .catch(error => {
+                    console.error('Error fetching data:', error);
+                });
+        }
+    });
+}

resources/views/cities/create.blade.php

@@ -29,7 +29,8 @@
                             Province
                         </label>
                         <div class="flex flex-wrap items-baseline w-full">
-                            <select name="province_code" class="select tomselect w-full @error('province_id') border-danger @enderror">
+                            <select id="province_code" name="province_code" class="select w-full @error('province_code') border-danger @enderror">
+                                <option value="">Select Province</option>
                                 @foreach($provinces as $province)
                                     @if(isset($city))
                                         <option value="{{ $province->code }}" {{ isset($city->province_code) && $city->province_code == $province->code?'selected' : '' }}>

resources/views/districts/create.blade.php

@@ -0,0 +1,112 @@
+@extends('layouts.main')
+
+@section('breadcrumbs')
+    {{ Breadcrumbs::render(request()->route()->getName()) }}
+@endsection
+
+@section('content')
+    <div class="w-full grid gap-5 lg:gap-7.5 mx-auto">
+        @if(isset($district->id))
+            <form action="{{ route('locations.districts.update', $district->id) }}" method="POST">
+                <input type="hidden" name="id" value="{{ $district->id }}">
+            @method('PUT')
+        @else
+            <form method="POST" action="{{ route('locations.districts.store') }}">
+        @endif
+        @csrf
+            <div class="card pb-2.5">
+                <div class="card-header" id="basic_settings">
+                    <h3 class="card-title">
+                        {{ isset($district->id) ? 'Edit' : 'Add' }} City
+                    </h3>
+                    <div class="flex items-center gap-2">
+                        <a href="{{ route('locations.districts.index') }}" class="btn btn-xs btn-info">Back</a>
+                    </div>
+                </div>
+                <div class="card-body grid gap-5">
+                    <div class="flex items-baseline flex-wrap lg:flex-nowrap gap-2.5">
+                        <label class="form-label max-w-56">
+                            Province
+                        </label>
+                        <div class="flex flex-wrap items-baseline w-full">
+                            <select id="province_code" name="province_code" class="select w-full @error('province_code') border-danger @enderror">
+                                <option value="">Select Province</option>
+                                @foreach($provinces as $province)
+                                    @if(isset($district))
+                                        <option value="{{ $province->code }}" {{ isset($district->province_code) && $district->province_code == $province->code?'selected' : '' }}>
+                                            {{ $province->name }}
+                                        </option>
+                                    @else
+                                        <option value="{{ $province->code }}">
+                                            {{ $province->name }}
+                                        </option>
+                                    @endif
+                                @endforeach
+                            </select>
+                            @error('province_code')
+                            <em class="alert text-danger text-sm">{{ $message }}</em>
+                            @enderror
+                        </div>
+                    </div>
+                    <div class="flex items-baseline flex-wrap lg:flex-nowrap gap-2.5">
+                        <label class="form-label max-w-56">
+                            City
+                        </label>
+                        <div class="flex flex-wrap items-baseline w-full">
+                            <select id="city_code" name="city_code" class="select w-full @error('city_code') border-danger @enderror">
+                                <option value="">Select City</option>
+                                @if(isset($cities))
+                                    @foreach($cities as $city)
+                                        @if(isset($district))
+                                            <option value="{{ $city->code }}" {{ isset($district->city_code) && $district->city_code == $city->code?'selected' : '' }}>
+                                                {{ $city->name }}
+                                            </option>
+                                        @else
+                                            <option value="{{ $city->code }}">
+                                                {{ $city->name }}
+                                            </option>
+                                        @endif
+                                    @endforeach
+
+                                @endif
+                            </select>
+                            @error('city_code')
+                            <em class="alert text-danger text-sm">{{ $message }}</em>
+                            @enderror
+                        </div>
+                    </div>
+                    <div class="flex items-baseline flex-wrap lg:flex-nowrap gap-2.5">
+                        <label class="form-label max-w-56">
+                            Code
+                        </label>
+                        <div class="flex flex-wrap items-baseline w-full">
+                            <input class="input  @error('code') border-danger @enderror" type="text" name="code" value="{{ $district->code ?? '' }}">
+                            @error('code')
+                            <em class="alert text-danger text-sm">{{ $message }}</em>
+                            @enderror
+                        </div>
+                    </div>
+                    <div class="flex items-baseline flex-wrap lg:flex-nowrap gap-2.5">
+                        <label class="form-label max-w-56">
+                            Name
+                        </label>
+                        <div class="flex flex-wrap items-baseline w-full">
+                            <input class="input  @error('name') border-danger @enderror" type="text" name="name" value="{{ $district->name ?? '' }}">
+                            @error('name')
+                            <em class="alert text-danger text-sm">{{ $message }}</em>
+                            @enderror
+                        </div>
+                    </div>
+                    <div class="flex justify-end">
+                        <button type="submit" class="btn btn-primary">
+                            Save
+                        </button>
+                    </div>
+                </div>
+            </div>
+        </form>
+    </div>
+@endsection
+
+@push('scripts')
+@endpush

resources/views/districts/index.blade.php

@@ -0,0 +1,192 @@
+@extends('layouts.main')
+
+@section('breadcrumbs')
+    {{ Breadcrumbs::render('locations.districts') }}
+@endsection
+
+@section('content')
+    <div class="container-fluid">
+        <div class="grid">
+            <div class="card card-grid min-w-full" data-datatable="false" data-datatable-page-size="5" data-datatable-state-save="true" id="districts-table" data-api-url="{{ route('locations.districts.datatables') }}">
+                <div class="card-header py-5 flex-wrap">
+                    <h3 class="card-title">
+                        List of Districts
+                    </h3>
+                    <div class="flex flex-wrap gap-2 lg:gap-5">
+                        <div class="flex">
+                            <label class="input input-sm"> <i class="ki-filled ki-magnifier"> </i>
+                                <input placeholder="Search districts" id="search" type="text" value="">
+
+                            </label>
+                        </div>
+                        <div class="flex flex-wrap gap-2.5">
+                            <select class="select select-sm w-28">
+                                <option value="1">
+                                    Active
+                                </option>
+                                <option value="2">
+                                    Disabled
+                                </option>
+                                <option value="2">
+                                    Pending
+                                </option>
+                            </select>
+                            <select class="select select-sm w-28">
+                                <option value="desc">
+                                    Latest
+                                </option>
+                                <option value="asc">
+                                    Oldest
+                                </option>
+                            </select>
+                            <button class="btn btn-sm btn-outline btn-primary">
+                                <i class="ki-filled ki-setting-4"> </i> <Filters></Filters>
+                            </button>
+                            <div class="h-[24px] border border-r-gray-200"> </div>
+                            <a class="btn btn-sm btn-light" href="{{ route('locations.districts.export') }}"> Export to Excel </a>
+                            <a class="btn btn-sm btn-primary" href="{{ route('locations.districts.create') }}"> Add District </a>
+                        </div>
+                    </div>
+                </div>
+                <div class="card-body">
+                    <div class="scrollable-x-auto">
+                        <table class="table table-auto table-border align-middle text-gray-700 font-medium text-sm" data-datatable-table="true">
+                            <thead>
+                            <tr>
+                                <th class="w-14">
+                                    <input class="checkbox checkbox-sm" data-datatable-check="true" type="checkbox"/>
+                                </th>
+                                <th class="min-w-[250px]" data-datatable-column="code">
+                                    <span class="sort"> <span class="sort-label"> Code </span>
+                                        <span class="sort-icon"> </span> </span>
+                                </th>
+                                <th class="min-w-[250px]" data-datatable-column="name">
+                                    <span class="sort"> <span class="sort-label"> District </span>
+                                        <span class="sort-icon"> </span> </span>
+                                </th>
+                                <th class="min-w-[250px]" data-datatable-column="city">
+                                    <span class="sort"> <span class="sort-label"> City </span>
+                                        <span class="sort-icon"> </span> </span>
+                                </th>
+                                <th class="min-w-[250px]" data-datatable-column="province">
+                                    <span class="sort"> <span class="sort-label"> Province </span>
+                                        <span class="sort-icon"> </span> </span>
+                                </th>
+                                <th class="min-w-[50px] text-center" data-datatable-column="actions">Action</th>
+                            </tr>
+                            </thead>
+                        </table>
+                    </div>
+                    <div class="card-footer justify-center md:justify-between flex-col md:flex-row gap-3 text-gray-600 text-2sm font-medium">
+                        <div class="flex items-center gap-2">
+                            Show
+                            <select class="select select-sm w-16" data-datatable-size="true" name="perpage"> </select> per page
+                        </div>
+                        <div class="flex items-center gap-4">
+                            <span data-datatable-info="true"> </span>
+                            <div class="pagination" data-datatable-pagination="true">
+                            </div>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+@endsection
+
+@push('scripts')
+    <script src="https://cdn.jsdelivr.net/npm/sweetalert2@11"></script>
+    <script type="text/javascript">
+        function deleteData(data) {
+            Swal.fire({
+                title: 'Are you sure?',
+                text: "You won't be able to revert this!" + data,
+                icon: 'warning',
+                showCancelButton: true,
+                confirmButtonColor: '#3085d6',
+                cancelButtonColor: '#d33',
+                confirmButtonText: 'Yes, delete it!'
+            }).then((result) => {
+                if (result.isConfirmed) {
+                    $.ajaxSetup({
+                        headers: {
+                            'X-CSRF-TOKEN': '{{ csrf_token()  }}'
+                        }
+                    });
+
+                    $.ajax(`locations/districts/${data}`, {
+                        type: 'DELETE'
+                    }).then((response) => {
+                        swal.fire('Deleted!', 'User has been deleted.','success').then(() => {
+                            window.location.reload();
+                        });
+                    }).catch((error) => {
+                        console.error('Error:', error);
+                        Swal.fire('Error!', 'An error occurred while deleting the file.', 'error');
+                    });
+                }
+            })
+        }
+    </script>
+    <script type="module">
+        const element = document.querySelector('#districts-table');
+        const searchInput = document.getElementById('search');
+
+        const apiUrl = element.getAttribute('data-api-url');
+        const dataTableOptions = {
+            apiEndpoint: apiUrl,
+            pageSize: 5,
+            columns: {
+                select: {
+                    render: (item, data, context) => {
+                        const checkbox = document.createElement('input');
+                        checkbox.className = 'checkbox checkbox-sm';
+                        checkbox.type = 'checkbox';
+                        checkbox.value = data.id.toString();
+                        checkbox.setAttribute('data-datatable-row-check', 'true');
+                        return checkbox.outerHTML.trim();
+                    },
+                },
+                code: {
+                    title: 'Code',
+                },
+                name: {
+                    title: 'District',
+                },
+                city: {
+                    title: 'City',
+                    render: (item, data) => {
+                        return data.city.name;
+                    }
+                },
+                province: {
+                    title: 'Province',
+                    render: (item, data) => {
+                        return data.city.province.name;
+                    }
+                },
+                actions: {
+                    title: 'Status',
+                    render: (item, data) => {
+                        return `<div class="flex flex-nowrap justify-center">
+                            <a class="btn btn-sm btn-icon btn-clear btn-info" href="locations/districts/${data.id}/edit">
+                                <i class="ki-outline ki-notepad-edit"></i>
+                            </a>
+                            <a onclick="deleteData(${data.id})" class="delete btn btn-sm btn-icon btn-clear btn-danger">
+                                <i class="ki-outline ki-trash"></i>
+                            </a>
+                        </div>`;
+                    },
+                }
+            },
+        };
+
+        let dataTable = new KTDataTable(element, dataTableOptions);
+        // Custom search functionality
+        searchInput.addEventListener('input', function () {
+            const searchValue = this.value.trim();
+            dataTable.search(searchValue, true);
+        });
+    </script>
+@endpush
+

routes/breadcrumbs.php

@@ -26,7 +26,7 @@
 
     // Cities
     Breadcrumbs::for('locations.cities', function (BreadcrumbTrail $trail) {
-        $trail->parent('locations.provinces');
+        $trail->parent('locations');
         $trail->push('Cities', route('locations.cities.index'));
     });
 
@@ -40,3 +40,20 @@
         $trail->parent('locations.cities');
         $trail->push('Edit City');
     });
+
+
+    //Districts
+    Breadcrumbs::for('locations.districts', function (BreadcrumbTrail $trail) {
+        $trail->parent('locations');
+        $trail->push('Districts', route('locations.districts.index'));
+    });
+
+    Breadcrumbs::for('locations.districts.create', function (BreadcrumbTrail $trail) {
+        $trail->parent('locations.districts');
+        $trail->push('Create District', route('locations.districts.create'));
+    });
+
+    Breadcrumbs::for('locations.districts.edit', function (BreadcrumbTrail $trail) {
+        $trail->parent('locations.districts');
+        $trail->push('Edit District');
+    });

routes/web.php

@@ -2,6 +2,7 @@
 
 use Illuminate\Support\Facades\Route;
     use Modules\Location\Http\Controllers\CitiesController;
+    use Modules\Location\Http\Controllers\DistrictsController;
     use Modules\Location\Http\Controllers\LocationController;
     use Modules\Location\Http\Controllers\ProvincesController;
 
@@ -29,8 +30,16 @@ use Illuminate\Support\Facades\Route;
                 Route::get('restore/{id}', [CitiesController::class, 'restore'])->name('restore');
                 Route::get('datatables', [CitiesController::class, 'dataForDatatables'])->name('datatables');
                 Route::get('export', [CitiesController   ::class, 'export'])->name('export');
+                Route::get('province/{province_code}', [CitiesController::class, 'getCitiesByProvinceId'])->name('province');
             });
             Route::resource('cities', CitiesController::class);
 
+            Route::name('districts.')->prefix('districts')->group(function () {
+                Route::get('restore/{id}', [DistrictsController::class, 'restore'])->name('restore');
+                Route::get('datatables', [DistrictsController::class, 'dataForDatatables'])->name('datatables');
+                Route::get('export', [DistrictsController   ::class, 'export'])->name('export');
+                Route::get('city/{city_code}', [DistrictsController::class, 'getDistrictsByCityId'])->name('city');
+            });
+            Route::resource('districts', DistrictsController::class);
         });
     });