feat: many ui improvements for the claim part

This commit is contained in:
Noah Lancien 2025-11-24 12:58:47 +01:00
parent d8796ee78a
commit 8fbaa234b4
19 changed files with 451 additions and 9 deletions

View file

@ -12,6 +12,7 @@ enum ClaimStatus: int
case sentDigital = 2;
case sentMarketing = 3;
case treated = 4;
case refused = 5;
/**
* Optionnal labels definition
@ -21,6 +22,7 @@ enum ClaimStatus: int
self::sentDigital->name => 'Transférée au service Digital',
self::sentMarketing->name => 'Retournée au Marketing',
self::treated->name => 'Traitée',
self::refused->name => 'Refusé de répondre',
];
/**
@ -31,6 +33,7 @@ enum ClaimStatus: int
self::sentDigital->name => '#0033c0',
self::sentMarketing->name => '#69077c',
self::treated->name => '#188618',
self::refused->name => '#dc143c',
];
/**

View file

@ -7,9 +7,11 @@ use App\Enums\Claims\ClaimStatus;
use App\Enums\Users\RoleEnum;
use App\Events\ClaimModelChanged;
use App\Http\Controllers\Controller;
use App\Http\Requests\Bo\Claims\ExportClaimRequest;
use App\Http\Requests\Bo\Claims\SendClaimAnswerRequest;
use App\Http\Requests\Bo\Claims\UpdateClaimRequest;
use App\Http\Requests\Bo\PaginateModelsRequest;
use App\Jobs\ExportClaimsAsCsv;
use App\Mail\ClaimAnswerMail;
use App\Models\Brand;
use App\Models\Claim;
@ -54,8 +56,19 @@ class ClaimController extends Controller
)->when(
$userModel->role->equals(RoleEnum::marketing),
fn($q) => $q->whereHas('brand', fn($q) => $q->whereIn('id', $userModel->brands->modelKeys()))
)
->when(
$request->filled('subject'),
fn($q) => $q->whereHas('claimSubject', fn($q) => $q->where('id', $request->subject))
)
->when(
$request->filled('status'),
fn($q) => $q->whereIn('status', $request->status),
fn($q) => $q->whereNotIn('status', [ClaimStatus::treated, ClaimStatus::refused])
);
// dd($query->toRawSql());
/** @var string $search Search field */
$search = $request->search;
if ($search) {
@ -82,7 +95,9 @@ class ClaimController extends Controller
/** Custom pagination */
$claimModels = $query->simplePaginate($this->getPagination());
return view('bo.pages.claims.index', compact('claimModels', 'search', 'searchFields'));
$claimSubjectModels = ClaimSubject::all();
return view('bo.pages.claims.index', compact('claimModels', 'search', 'searchFields', 'claimSubjectModels'));
}
/**
@ -204,4 +219,29 @@ class ClaimController extends Controller
);
return \response()->json($models);
}
public function export(ExportClaimRequest $request)
{
$claims = Claim::query()->whereIn('id', $request->validated('claimList'))->get();
$brandNames = Brand::query()
->whereIn(
'id',
\collect($claims)
->pluck('brand_id')
->unique()
)->pluck('name')
->toArray();
// dd($brandNames);
\dispatch(new ExportClaimsAsCsv($request->validated('email'), $brandNames, $claims));
return \redirect()
->back()
->with('success', trans("Le traitement de l'export partiel a été lancé. Si vous n'avez pas recu de mail
cela signifie qu'une erreur est survenue et nous sommes au courant."));
}
}

View file

@ -0,0 +1,59 @@
<?php
namespace App\Http\Requests\Bo\Claims;
use App\Enums\Claims\ClaimResponseType;
use App\Enums\Claims\ClaimStatus;
use App\Enums\Claims\ClaimType;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Rules\Enum;
class ExportClaimRequest extends FormRequest
{
/**
* Determine if the user is authorized to make this request.
*
* @return boolean
*/
public function authorize(): bool
{
return auth('backend')->check();
}
public function prepareForValidation()
{
$this->merge([
'claimList' => json_decode($this->input('claimList'), true)
]);
}
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules(): array
{
return [
'email' => 'required|email',
'claimList' => 'required|array',
'claimList.*' => 'required|numeric|exists:claims,id',
];
}
/**
* Get custom attributes for validator errors.
*
* @return array<string,\Illuminate\Contracts\Translation\Translator|string|array<mixed>|null>
*/
public function attributes(): array
{
return [
'brand_id' => trans('models.classes.brands'),
'subject_id' => trans('models.classes.claimsubjects'),
'type' => trans('validation.custom.type'),
'status' => trans('validation.custom.status'),
'response_type' => trans('validation.custom.response_type'),
];
}
}

View file

@ -0,0 +1,134 @@
<?php
namespace App\Jobs;
use App\Mail\ExportClaims;
use App\Models\Claim;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Foundation\Queue\Queueable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Mail;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Str;
class ExportClaimsAsCsv implements ShouldQueue
{
use Queueable;
use Dispatchable;
use InteractsWithQueue;
use SerializesModels;
/**
* CSV File headers
*
* @var array
*/
private $header = [
"Prénom NOM",
"Email",
"Adresse",
"Date de création",
"Sujet",
"Statut",
"Message",
"Pièce jointe",
];
/**
* Create a new job instance.
*/
public function __construct(private string $recipient, private array $brandNames, private $claims)
{
//
}
/**
* Execute the job.
*/
public function handle(): void
{
/** @var \Illuminate\Filesystem\FilesystemAdapter */
$disk = Storage::disk('export');
$disk->deleteDirectory('export_claims');
$disk->makeDirectory('export_claims');
// Insertion de la ligne d'en-têtes.
$csvlines[] = $this->header;
foreach ($this->claims as $inscription) {
$csvlines[] = $this->fillLine($inscription);
}
$data = $this->array2csv($csvlines, ";");
$uuid = Str::uuid();
$fileName = date('d-m-Y') . '-' . $uuid . '.csv';
$disk->put("export_claims/{$fileName}", $data);
if (!$disk->exists("export_claims/{$fileName}")) {
throw new \RuntimeException(
"The CSV file 'export_claims/{$fileName}' has not been created."
);
}
$brandNamesString = implode(', ', $this->brandNames);
Mail::to($this->recipient)->send(new ExportClaims($fileName, $brandNamesString));
}
/**
* fill one line for csv
* @param \App\Models\Claim $claim
*
* @return array
* @phpcs:disable Generic.Metrics.CyclomaticComplexity.TooHigh, Generic.Metrics.CyclomaticComplexity.MaxExceeded
*/
private function fillLine(Claim $claim)
{
// @phpcs:enable
$oneline = [
sprintf('%s %s', $claim->first_name, Str::upper($claim->last_name)),
$claim->email,
$claim->address . "," . $claim->postcode . "," . $claim->city,
$claim->created_at->toDateTimeString(),
$claim->claimSubject->label,
$claim->status->label(),
$claim->message,
asset($claim->file),
];
return $oneline;
}
/**
* converts an array to a csv stream
*
* @param array $data
* @param string $delimiter
* @param string $enclosure
* @param string $escape_char
*
* @return string
*/
private function array2csv(
array $data,
string $delimiter = ',',
string $enclosure = '"',
string $escape_char = "\\"
) {
$f = fopen('php://memory', 'r+');
// UTF-8 BOM.
$BOM = "\xEF\xBB\xBF";
fwrite($f, $BOM);
foreach ($data as $item) {
fputcsv($f, $item, $delimiter, $enclosure, $escape_char);
}
rewind($f);
return stream_get_contents($f);
}
}

62
app/Mail/ExportClaims.php Normal file
View file

@ -0,0 +1,62 @@
<?php
namespace App\Mail;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Mail\Mailable;
use Illuminate\Mail\Mailables\Attachment;
use Illuminate\Mail\Mailables\Content;
use Illuminate\Mail\Mailables\Envelope;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Storage;
class ExportClaims extends Mailable
{
use Queueable, SerializesModels;
/**
* Create a new message instance.
*/
public function __construct(private string $fileName, private string $brandName)
{
//
}
/**
* Get the message envelope.
*/
public function envelope(): Envelope
{
return new Envelope(
subject: sprintf('Export des réclamations - %s', $this->brandName),
);
}
/**
* Get the message content definition.
*/
public function content(): Content
{
return new Content(
markdown: 'mail.export-claims',
text: 'mail.export-claims-plain'
);
}
/**
* Get the attachments for the message.
*
* @return array<int, \Illuminate\Mail\Mailables\Attachment>
*/
public function attachments(): array
{
return [
Attachment::fromStorageDisk('export', "export_claims/{$this->fileName}")
->as(sprintf(
'export-reclas-%s.csv',
now()->format('Y-m-d')
))
];
}
}

View file

@ -68,6 +68,13 @@ return [
'throw' => false,
],
'export' => [
'driver' => 'local',
'root' => storage_path('app/export'),
'visibility' => 'private',
'throw' => true,
],
],
/*

View file

@ -14,6 +14,7 @@ import "./../modules/sweetalert";
import "./base/common";
// CUSTOM
import "./pages/claims";
import "./pages/customer.delete";
import "./pages/data.delete";
import "./pages/search-bar";

View file

@ -0,0 +1,17 @@
document.addEventListener("DOMContentLoaded", function () {
const exportForm = document.getElementById("claimExportForm");
const exportFormBtn = document.getElementById("claimExportFormBtn");
const exportFormBtnInside = document.getElementById("claimExportFormBtnInside");
if (!exportForm || !exportFormBtn || !exportFormBtnInside || !(exportForm instanceof HTMLFormElement)) {
return;
}
exportFormBtn.addEventListener("click", function (e) {
e.preventDefault();
exportFormBtnInside.click();
});
});

View file

@ -2,6 +2,7 @@ enum FilterKey {
Brand = "brand",
Question = "question",
Answer = "answer",
Subject = "subject",
}
function setupFilterListener(selectId: string, paramKey: FilterKey): void {
@ -25,6 +26,7 @@ const filterMap: Record<string, FilterKey> = {
brandSelect: FilterKey.Brand,
questionSelect: FilterKey.Question,
answerSelect: FilterKey.Answer,
subjectSelect: FilterKey.Subject,
};
Object.entries(filterMap).forEach(([selectId, paramKey]) => {

View file

@ -29,6 +29,7 @@ import {
faEraser,
faEye,
faEyeSlash,
faFile,
faFolderOpen,
faListUl,
faPaintRoller,
@ -57,6 +58,7 @@ library.add(
faTrash,
faEye,
faEyeSlash,
faFile,
faFolderOpen,
faCrop,
faQuestionCircle,

View file

@ -13,6 +13,20 @@
\App\Models\ClaimSubject::class,
\App\Models\ClaimMailTemplate::class,
];
$defaultFilters = [
'App\Models\Customer' => [],
'App\Models\Brand' => [],
'App\Models\Question' => [],
'App\Models\Service' => [],
'App\Models\SingleOptin' => [],
'App\Models\Claim' => [
'sort_col' => 'created_at',
'sort_way' => 'desc'
],
'App\Models\ClaimSubject' => [],
'App\Models\ClaimMailTemplate' => [],
]
@endphp
@foreach ($modelsClasses as $crudModel)
@can('viewAny', $crudModel)
@ -23,7 +37,10 @@
<ul class="nav flex-column mb-2">
<li class="nav-item">
<a class="nav-link w-fit" data-bs-tooltip="tooltip" data-bs-placement="right"
href="{{ route(sprintf('%s%s.index', $prefix ?? '', $crudModel->getTable())) }}"
href="{{ route(
sprintf('%s%s.index', $prefix ?? '', $crudModel->getTable()),
$defaultFilters[get_class($crudModel)]
) }}"
title="{{ __('Afficher la liste') }}">
{{ __('Liste') }}
</a>
@ -37,6 +54,18 @@
</a>
</li>
@endcan
@if ($crudModel instanceof \App\Models\Claim)
<li class="nav-item">
<a class="nav-link w-fit" data-bs-tooltip="tooltip" data-bs-placement="right"
href="{{ route(
sprintf('%s%s.index', $prefix ?? '', $crudModel->getTable()),
['status' => [\App\Enums\Claims\ClaimStatus::treated, \App\Enums\Claims\ClaimStatus::refused]]
) }}"
title="{{ __('Afficher l\'historique') }}">
{{ __('Historique') }}
</a>
</li>
@endif
</ul>
@if (!$loop->last)
<hr>

View file

@ -0,0 +1,61 @@
@php
$selectedSubject = request()->subject ?? (isset($modelTable) ? Session::get("crud.$modelTable.subject") : null);
@endphp
<div class="row align-items-center justify-content-between mb-3">
<div class="col-3">
<button class="btn btn-success d-flex flex-column" id="export-claim" data-bs-toggle="modal" data-bs-target="#exportModal">
<i class="fa-solid fa-file"></i>
{{ __('Export')}}
</button>
</div>
<div class="col-3">
<form action="{{ request()->fullUrlWithQuery(['rstFltrs' => null]) }}" class="row gx-2 mb-2">
{{-- SUBJECT SELECT --}}
<select class="form-select mb-1 mb-lg-0"
id="subjectSelect" role="button" name="subject">
<option value="0" @selected(!$selectedSubject)>{{ __('Sélectionnez un sujet...') }}</option>
@foreach ($claimSubjectModels as $claimSubjectModel)
<option value="{{ $claimSubjectModel->getKey() }}" @selected($selectedSubject == $claimSubjectModel->getKey())>
{{ $claimSubjectModel->label }}
</option>
@endforeach
</select>
</form>
</div>
</div>
{{-- EXPORT MODAL --}}
<div class="modal fade" id="exportModal" tabindex="-1" aria-labelledby="exportModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h2 class="modal-title fs-5" id="exportModalLabel">{{ __('Exporter les réclamations')}}</h2>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<form action="{{ route('bo.claims.export') }}" class="row gx-2 mb-2" method="POST" id="claimExportForm">
@csrf
{{-- EMAIL INPUT --}}
<label for="exportEmail" class="form-label">{{ __('Destinataire de l\'export') }}&nbsp;</label>
<input
type="email"
class="form-control"
name="email"
id="exportEmail"
required
pattern="^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$"
title="Veuillez saisir une adresse email valide">
<div id="emailHelp" class="form-text">{{ __('L\'export sera envoyé en .csv à cette adresse mail.')}}</div>
<button type="submit" class="d-none" id="claimExportFormBtnInside"></button>
<input hidden name="claimList" value="@json($claimModels->pluck('id')->toArray())">
</form>
</div>
<div class="modal-footer">
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">{{ __('Fermer')}}</button>
<button type="button" class="btn btn-primary" type="submit" id="claimExportFormBtn">{{ __('Exporter')}}</button>
</div>
</div>
</div>
</div>

View file

@ -67,7 +67,7 @@
@php
$parameters = ['rstFltrs' => 'true', 'search' => null, 'page' => null];
if ($routes) {
$parameters = array_merge($parameters, ['brand' => null, 'question' => null, 'answer' => null]);
$parameters = array_merge($parameters, ['brand' => null, 'question' => null, 'answer' => null, 'subject' => null]);
}
@endphp
<a class="btn btn-danger ms-2" data-bs-tooltip="tooltip"

View file

@ -11,7 +11,7 @@
<div class="d-flex align-items-start flex-row">
@can('viewAny', $claimModel)
<a class="btn btn-primary text-decoration-none me-2" data-bs-tooltip="tooltip" data-bs-placement="top"
data-bs-tooltip="tooltip" href="{{ route('bo.claims.index') }}"
data-bs-tooltip="tooltip" href="{{ route('bo.claims.index', ['sort_col' => 'created_at', 'sort_way' => 'desc']) }}"
title="{{ __('crud.helpers.list_all', ['model' => __('models.classes.claims')]) }}">
<i class="fa-solid fa-arrow-left"></i>
</a>

View file

@ -2,11 +2,13 @@
<thead class="border-top-0 border-start-0 border-end-0 border border-2">
@include('bo.modules.table-col-sorter', [
'cols' => [
'reference' => str(__('validation.custom.reference'))->ucfirst(),
'email' => str(__('models.classes.customers'))->ucfirst(),
'brand_id' => str(__('models.classes.brands'))->singular()->ucfirst(),
'type' => str(__('validation.custom.type'))->ucfirst(),
'status' => str(__('validation.custom.status'))->ucfirst(),
'reference' => str(__('validation.custom.reference'))->ucfirst(),
'created_at' => str(__('validation.attributes.created_at'))->ucfirst(),
'email' => str(__('models.classes.customers'))->ucfirst(),
'message' => str(__('validation.attributes.message'))->ucfirst(),
'brand_id' => str(__('models.classes.brands'))->singular()->ucfirst(),
'type' => str(__('validation.custom.type'))->ucfirst(),
'status' => str(__('validation.custom.status'))->ucfirst(),
'updated_at' => str(__('validation.attributes.updated_at'))->ucfirst(),
],
])
@ -16,12 +18,18 @@
@foreach ($claimModels as $claimModel)
<tr class="border-bottom list-item">
<td class="text-center align-middle">{{ $claimModel->reference }}</td>
<td class="text-center align-middle">
<span class="badge bg-secondary text-bg-secondary">
{{ $claimModel->created_at->isoFormat('LLLL') }}
</span>
</td>
<td class="text-center align-middle">
<div class="d-flex flex-column justify-content-center align-items-center">
<p class="m-0">{{ sprintf('%s %s', $claimModel->first_name, $claimModel->last_name) }}</p>
<p class="text-muted m-0">{{ e($claimModel->email) }}</p>
</div>
</td>
<td class="text-center align-middle">{{ $claimModel->message }}</td>
<td class="text-center align-middle">{{ $claimModel->brand->name }}</td>
<td class="text-center align-middle">
<x-bo.claims.enum-badge :claimModel="$claimModel" enum="type" />

View file

@ -16,6 +16,7 @@
</div>
</div>
<div class="card-body">
@include('bo.modules.claim-tools')
@include('bo.modules.search-bar')
<div class="row w-100 mx-auto mb-2">
<div class="col table-responsive p-0">

View file

@ -0,0 +1,5 @@
Bonjour,
Vous trouverez ci-joint l'export des réclamations du {{ now()->isoFormat('DD\/MM\/YYYY à HH:mm') }}
Ceci est un message automatique, ne pas répondre.

View file

@ -0,0 +1,10 @@
{{-- blade-formatter-disable --}}
@component('mail::layout')
# {{ __('Bonjour,') }}
{{ __('Vous trouverez ci-joint l\'export des réclamations du') }} {{ now()->isoFormat('DD\/MM\/YYYY à HH:mm') }}
{{ __('Ceci est un message automatique, ne pas répondre.') }}
@endcomponent

View file

@ -93,6 +93,7 @@ Route::middleware(['throttle:web', 'admin-secure'])->prefix('bo')->name('bo.')->
// * CLAIMS.
Route::resource('claims', ClaimController::class)->only(['index', 'edit', 'update']);
Route::post('claims/{claim}/answer', [ClaimController::class, 'answer'])->name('claims.answer');
Route::post('claims/export', [ClaimController::class, 'export'])->name('claims.export');
// * CLAIM SUBJECTS.
Route::get('/{brand}/claim_subjects/json/paginate', [ClaimController::class, 'jsonClaimPaginateModels'])