refactor ClientProgramController; replace caching logic with action classes for educational program retrieval and enhance code clarity

2025-07-18 15:57:58 +05:00
parent 839d8edfcd
commit 18d1501b67
13 changed files with 404 additions and 155 deletions
@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Containers\Education\Actions;
+
+use App\Containers\Education\UI\WEB\Transformers\EducationalProgramResource;
+use App\Ship\Contracts\SeoServiceInterface;
+use App\Containers\Education\Tasks\GetEducationalProgramBySlugTask;
+use App\Containers\Education\Tasks\GetEducationalFormsTask;
+use App\Containers\Education\Tasks\GetSeoForModelTask;
+
+class GetEducationalProgramAction
+{
+    public function __construct(
+        private readonly GetEducationalProgramBySlugTask $getEducationalProgramBySlugTask,
+        private readonly GetEducationalFormsTask $getEducationalFormsTask,
+        private readonly GetSeoForModelTask $getSeoForModelTask,
+        private readonly SeoServiceInterface $seoPageProvider,
+    ) {}
+
+    public function run(string $slug)
+    {
+        $programModel = $this->getEducationalProgramBySlugTask->run($slug);
+        $formsEdu = $this->getEducationalFormsTask->run();
+        $seo = $this->getSeoForModelTask->run($this->seoPageProvider, $programModel);
+
+        $program = new EducationalProgramResource($programModel);
+
+        return compact('program', 'formsEdu', 'seo');
+    }
+}
@@ -0,0 +1,76 @@
+<?php
+
+namespace App\Containers\Education\Actions;
+
+use App\Containers\Education\Models\AdmissionCampaign;
+use App\Containers\Education\Models\AdmissionPlan;
+use App\Containers\Education\Models\EducationalProgram;
+use App\Containers\Education\UI\WEB\Transformers\DirectionStudyResource;
+use App\Ship\Contracts\SeoServiceInterface;
+use App\Ship\Enums\CacheKeys;
+use App\Ship\Enums\Education\BudgetEducation;
+use App\Ship\Enums\Education\FormEducation;
+use App\Ship\Enums\Education\LevelEducational;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Str;
+use App\Containers\Education\Tasks\GetActiveAdmissionCampaignTask;
+use App\Containers\Education\Tasks\GetEducationalLevelsTask;
+use App\Containers\Education\Tasks\GetEducationalFormsTask;
+use App\Containers\Education\Tasks\GetEducationalBudgetsTask;
+use App\Containers\Education\Tasks\GetSeoForCurrentPageTask;
+use App\Containers\Education\Tasks\ListDirectionStudiesTask;
+use App\Containers\Education\Tasks\GetAdmissionCampaignNameTask;
+use App\Containers\Education\Tasks\BuildFiltersTask;
+use App\Containers\Education\Models\DirectionStudy;
+
+class ListEducationalProgramsAction
+{
+    public function __construct(
+        private readonly SeoServiceInterface $seoPageProvider,
+        private readonly GetActiveAdmissionCampaignTask $getActiveAdmissionCampaignTask,
+        private readonly GetEducationalLevelsTask $getEducationalLevelsTask,
+        private readonly GetEducationalFormsTask $getEducationalFormsTask,
+        private readonly GetEducationalBudgetsTask $getEducationalBudgetsTask,
+        private readonly GetSeoForCurrentPageTask $getSeoForCurrentPageTask,
+        private readonly ListDirectionStudiesTask $listDirectionStudiesTask,
+        private readonly GetAdmissionCampaignNameTask $getAdmissionCampaignNameTask,
+        private readonly BuildFiltersTask $buildFiltersTask,
+    ) {}
+
+    public function run(array $filters)
+    {
+        $request = Request::capture(); // This is a temporary solution, will refine later
+
+        $cacheKey = CacheKeys::EDUCATION_PROGRAMS_PREFIX->value . md5(serialize($filters));
+
+        $activeCampaign = $this->getActiveAdmissionCampaignTask->run();
+        $levelsEducational = $this->getEducationalLevelsTask->run();
+        $formsEdu = $this->getEducationalFormsTask->run();
+        $budgetEdu = $this->getEducationalBudgetsTask->run();
+        $seo = $this->getSeoForCurrentPageTask->run($this->seoPageProvider);
+        $filtersData = $this->buildFiltersTask->run($filters);
+
+        $naprs = Cache::remember($cacheKey, now()->addHours(), function () use ($request, $activeCampaign, $filters) {
+            return DirectionStudyResource::collection(
+                $this->listDirectionStudiesTask->run($activeCampaign, $filters)
+            );
+        });
+
+        $data = [
+            'naprs' => $naprs,
+            'campaignName' => $this->getAdmissionCampaignNameTask->run(),
+            'levelsEducational' => $levelsEducational,
+            'filters' => $filtersData,
+            'formsEdu' => $formsEdu,
+            'budgetEdu' => $budgetEdu,
+            'direction_studies' => DirectionStudy::query()
+                ->withAdmissionCampaignByYear($activeCampaign->academic_year)
+                ->withActivePrograms()
+                ->get(),
+            'seo' => $seo
+        ];
+
+        return $data;
+    }
+}
@@ -0,0 +1,53 @@
+<?php
+
+namespace App\Containers\Education\Tasks;
+
+use App\Ship\Builders\FilterBuilder;
+use Illuminate\Support\Arr;
+
+class BuildFiltersTask
+{
+    public function __construct(
+        private readonly FilterBuilder $filterBuilder
+    ) {}
+
+    public function run(array $filters): array
+    {
+        // Сброс фильтров перед новым запуском
+        $this->filterBuilder->reset();
+
+        // Уровень образования
+        $this->filterBuilder->add(
+            key: 'level_filter',
+            type: 'level',
+            value: $filters['level'] ?? null,
+            param: 'level'
+        );
+
+        // Форма обучения
+        $this->filterBuilder->add(
+            key: 'formEdu_filter',
+            type: 'form',
+            value: $filters['form'] ?? null,
+            param: 'form'
+        );
+
+        // Бюджет
+        $this->filterBuilder->add(
+            key: 'budget_filter',
+            type: 'budget',
+            value: $filters['budget'] ?? null,
+            param: 'budget'
+        );
+
+        // Направление
+        $this->filterBuilder->add(
+            key: 'direction_filter',
+            type: 'direction',
+            value: $filters['direction'] ?? null,
+            param: 'direction'
+        );
+
+        return $this->filterBuilder->get();
+    }
+}
@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Containers\Education\Tasks;
+
+use App\Containers\Education\Models\AdmissionCampaign;
+use App\Ship\Enums\CacheKeys;
+use Illuminate\Support\Facades\Cache;
+
+class GetActiveAdmissionCampaignTask
+{
+    public function run()
+    {
+        return Cache::remember(CacheKeys::ADMISSION_CAMPAIGNS_PREFIX->value, now()->addDay(), function () {
+            return AdmissionCampaign::where('status', 1)->first();
+        });
+    }
+}
@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Containers\Education\Tasks;
+
+use App\Containers\Education\Models\AdmissionCampaign;
+use App\Ship\Enums\CacheKeys;
+use Illuminate\Support\Facades\Cache;
+
+class GetAdmissionCampaignNameTask
+{
+    public function run(): string
+    {
+        $cacheKey = CacheKeys::EDUCATION_PROGRAM_PREFIX->value . 'active_campaign_name';
+
+        return Cache::remember($cacheKey, now()->addHours(1), function () {
+            $campaign = AdmissionCampaign::query()->where('status', 1)->first();
+            return $campaign->name;
+        });
+    }
+}
@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Containers\Education\Tasks;
+
+use App\Containers\Education\Models\AdmissionPlan;
+use App\Ship\Enums\Education\BudgetEducation;
+use Illuminate\Support\Facades\Cache;
+
+class GetEducationalBudgetsTask
+{
+    public function run()
+    {
+        $cacheKeyBudgets = 'education_budgets_list';
+        return Cache::remember($cacheKeyBudgets, now()->addDay(), function () {
+            return AdmissionPlan::distinct()
+                ->pluck('contests')
+                ->flatten(1)
+                ->filter(fn ($item) => isset($item['places']['form_budget']))
+                ->pluck('places.form_budget')
+                ->unique()
+                ->map(fn ($item) => BudgetEducation::tryFrom($item))
+                ->filter()
+                ->mapWithKeys(fn ($form) => [$form->name => $form->getLabel()]);
+        });
+    }
+}
@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Containers\Education\Tasks;
+
+use App\Containers\Education\Models\AdmissionPlan;
+use App\Ship\Enums\Education\FormEducation;
+use Illuminate\Support\Facades\Cache;
+
+class GetEducationalFormsTask
+{
+    public function run()
+    {
+        $cacheKeyForms = 'education_forms_list';
+        return Cache::remember($cacheKeyForms, now()->addDay(), function () {
+            return AdmissionPlan::distinct()
+                ->pluck('contests')
+                ->flatten(1)
+                ->filter(fn ($item) => isset($item['form_education']))
+                ->pluck('form_education')
+                ->unique()
+                ->map(fn ($item) => FormEducation::tryFrom((int)$item))
+                ->filter()
+                ->mapWithKeys(fn ($form) => [$form->name => $form->getLabel()]);
+        });
+    }
+}
@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Containers\Education\Tasks;
+
+use App\Containers\Education\Models\EducationalProgram;
+use Illuminate\Support\Facades\Cache;
+
+class GetEducationalLevelsTask
+{
+    public function run()
+    {
+        $cacheKeyLevels = 'education_levels_list';
+        return Cache::remember($cacheKeyLevels, now()->addDay(), function () {
+            return EducationalProgram::distinct()->pluck('lvl_edu')
+                ->mapWithKeys(fn($level) => [$level->name => $level->getLabel()]);
+        });
+    }
+}
@@ -0,0 +1,22 @@
+<?php
+
+namespace App\Containers\Education\Tasks;
+
+use App\Containers\Education\Models\EducationalProgram;
+use App\Ship\Enums\CacheKeys;
+use Illuminate\Support\Facades\Cache;
+
+class GetEducationalProgramBySlugTask
+{
+    public function run(string $slug)
+    {
+        $cacheKeyProgram = CacheKeys::EDUCATION_PROGRAM_PREFIX->value . md5($slug);
+
+        return Cache::remember($cacheKeyProgram, now()->addHours(1), function () use ($slug) {
+            return EducationalProgram::query()
+                ->where('slug', $slug)
+                ->with(['admission_plans', 'directionStudy', 'seo'])
+                ->firstOrFail();
+        });
+    }
+}
@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Containers\Education\Tasks;
+
+use App\Ship\Contracts\SeoServiceInterface;
+use Illuminate\Support\Facades\Cache;
+
+class GetSeoForCurrentPageTask
+{
+    public function run(SeoServiceInterface $seoPageProvider)
+    {
+        $cacheKeySeo = 'education_programs_seo';
+        return Cache::remember($cacheKeySeo, now()->addDay(), function () use ($seoPageProvider) {
+            return $seoPageProvider->getSeoForCurrentPage();
+        });
+    }
+}
@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Containers\Education\Tasks;
+
+use App\Ship\Contracts\SeoServiceInterface;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\Cache;
+
+class GetSeoForModelTask
+{
+    public function run(SeoServiceInterface $seoPageProvider, Model $model)
+    {
+        $cacheKeySeo = 'education_program_seo_' . md5($model->slug);
+        return Cache::remember($cacheKeySeo, now()->addHours(1), function () use ($seoPageProvider, $model) {
+            return $seoPageProvider->getSeoForModel($model);
+        });
+    }
+}
@@ -0,0 +1,69 @@
+<?php
+
+namespace App\Containers\Education\Tasks;
+
+use App\Containers\Education\Models\AdmissionCampaign;
+use App\Containers\Education\Models\DirectionStudy;
+use App\Ship\Enums\Education\BudgetEducation;
+use App\Ship\Enums\Education\FormEducation;
+use App\Ship\Enums\Education\LevelEducational;
+use Illuminate\Support\Str;
+
+class ListDirectionStudiesTask
+{
+    public function run(AdmissionCampaign $activeCampaign, array $filters)
+    {
+        $query = DirectionStudy::query()
+            ->withAdmissionCampaignByYear($activeCampaign->academic_year)
+            ->withActivePrograms();
+
+        if (isset($filters['level'])) {
+            $query->where('lvl_edu', LevelEducational::fromName($filters['level'])->value);
+        }
+
+        if (isset($filters['form'])) {
+            $this->applyFormFilter($query, $filters['form']);
+        }
+
+        if (isset($filters['budget'])) {
+            $this->applyBudgetFilter($query, $filters['budget']);
+        }
+
+        if (isset($filters['direction'])) {
+            $slugs = $filters['direction'];
+            if (is_array($slugs)) {
+                $query->whereIn('slug', $slugs);
+            }
+        }
+
+        return $query->get();
+    }
+
+    private function applyFormFilter($query, $form)
+    {
+        $formValue = Str::of(FormEducation::fromName($form)->value)->toString();
+
+        $query->whereHas('programs.admission_plans', function ($query) use ($formValue) {
+            $query->whereJsonContains('contests', ['form_education' => $formValue]);
+        })
+            ->with(['programs' => function ($query) use ($formValue) {
+                $query->whereHas('admission_plans', function ($q) use ($formValue) {
+                    $q->whereJsonContains('contests', ['form_education' => $formValue]);
+                });
+            }]);
+    }
+
+    private function applyBudgetFilter($query, $budget): void
+    {
+        $budgetValue = Str::of(BudgetEducation::fromName($budget)->value)->toString();
+
+        $query->whereHas('programs.admission_plans', function ($query) use ($budgetValue) {
+            $query->where('contests', 'like', '%"form_budget":"'.$budgetValue.'"%');
+        })
+            ->with(['programs' => function ($query) use ($budgetValue) {
+                $query->whereHas('admission_plans', function ($query) use ($budgetValue) {
+                    $query->where('contests', 'like', '%"form_budget":"'.$budgetValue.'"%');
+                });
+            }]);
+    }
+}
@@ -2,175 +2,32 @@

 namespace App\Containers\Education\UI\WEB\Controllers;

-use App\Containers\Education\Models\AdmissionCampaign;
-use App\Containers\Education\Models\AdmissionPlan;
-use App\Containers\Education\Models\DirectionStudy;
-use App\Containers\Education\Models\EducationalProgram;
-use App\Containers\Education\UI\WEB\Transformers\DirectionStudyResource;
-use App\Containers\Education\UI\WEB\Transformers\EducationalProgramResource;
-use App\Ship\Contracts\SeoServiceInterface;
+use App\Containers\Education\Actions\ListEducationalProgramsAction;
+use App\Containers\Education\Actions\GetEducationalProgramAction;
 use App\Ship\Controllers\Controller;
-use App\Ship\Enums\CacheKeys;
-use App\Ship\Enums\Education\BudgetEducation;
-use App\Ship\Enums\Education\FormEducation;
-use App\Ship\Enums\Education\LevelEducational;
 use Illuminate\Http\Request;
-use Illuminate\Support\Facades\Cache;
-use Illuminate\Support\Str;
 use Inertia\Inertia;

 class ClientProgramController extends Controller
 {
-    public function __construct(readonly SeoServiceInterface $seoPageProvider){}
+    public function __construct(
+        private readonly ListEducationalProgramsAction $listEducationalProgramsAction,
+        private readonly GetEducationalProgramAction $getEducationalProgramAction,
+    ) {}

    public function index(Request $request): \Inertia\Response
    {
-        $cacheKey = CacheKeys::EDUCATION_PROGRAMS_PREFIX->value . md5(serialize($request->all()));
-        $cacheKeyLevels = 'education_levels_list';
-        $cacheKeyForms = 'education_forms_list';
-        $cacheKeyBudgets = 'education_budgets_list';
-        $cacheKeySeo = 'education_programs_seo';
+        $filters = $request->only(['search', 'category', 'tag', 'sort', 'page', 'date', 'level', 'form', 'budget', 'direction']);

-        $activeCampaign = Cache::remember(CacheKeys::ADMISSION_CAMPAIGNS_PREFIX->value, now()->addDay(), function () {
-            return AdmissionCampaign::where('status', 1)->first();
-        });
-
-        $levelsEducational = Cache::remember($cacheKeyLevels, now()->addDay(), function () {
-            return EducationalProgram::distinct()->pluck('lvl_edu')
-                ->mapWithKeys(fn($level) => [$level->name => $level->getLabel()]);
-        });
-
-        $formsEdu = Cache::remember($cacheKeyForms, now()->addDay(), function () {
-            return AdmissionPlan::distinct()
-                ->pluck('contests')
-                ->flatten(1)
-                ->filter(fn ($item) => isset($item['form_education']))
-                ->pluck('form_education')
-                ->unique()
-                ->map(fn ($item) => FormEducation::tryFrom((int)$item))
-                ->filter()
-                ->mapWithKeys(fn ($form) => [$form->name => $form->getLabel()]);
-        });
-
-
-        $budgetEdu = Cache::remember($cacheKeyBudgets, now()->addDay(), function () {
-            return AdmissionPlan::distinct()
-                ->pluck('contests')
-                ->flatten(1)
-                ->filter(fn ($item) => isset($item['places']['form_budget']))
-                ->pluck('places.form_budget')
-                ->unique()
-                ->map(fn ($item) => BudgetEducation::tryFrom($item))
-                ->filter()
-                ->mapWithKeys(fn ($form) => [$form->name => $form->getLabel()]);
-        });
-
-        $seo = Cache::remember($cacheKeySeo, now()->addDay(), function () {
-            return $this->seoPageProvider->getSeoForCurrentPage();
-        });
-
-        $naprs = Cache::remember($cacheKey, now()->addHours(), function () use ($request, $activeCampaign) {
-            return DirectionStudyResource::collection(
-                DirectionStudy::query()
-                    ->withAdmissionCampaignByYear($activeCampaign->academic_year)
-                    ->withActivePrograms()
-//                    ->with('programs.admission_plans')
-                    ->when($request->input('level'), fn($q, $level) =>
-                    $q->where('lvl_edu', LevelEducational::fromName($level)->value))
-                    ->when($request->input('form'), fn($q, $form) =>
-                    $this->applyFormFilter($q, $form))
-                    ->when($request->input('budget'), fn($q, $budget) =>
-                    $this->applyBudgetFilter($q, $budget))
-                    ->when($request->input('direction'), fn($q, $slugs) =>
-                        is_array($slugs) ? $q->whereIn('slug', $slugs) : $q)
-                    ->get()
-            );
-        });
-
-
-        $data = [
-            'naprs' => $naprs,
-            'campaignName' => $this->getAdmissionCampaignName(),
-            'levelsEducational' => $levelsEducational,
-            'filters' => [
-                'level_filter' => ['type' => 'level', 'value' => $request->input('level'), 'param' => 'level'],
-                'budget_filter' => ['type' => 'budget', 'value' => $request->input('budget'), 'param' => 'budget'],
-                'formEdu_filter' => ['type' => 'form', 'value' => $request->input('form'), 'param' => 'form'],
-                'direction_filter' => ['type' => 'direction', 'value' => $request->input('direction'), 'param' => 'direction'],
-            ],
-            'formsEdu' => $formsEdu,
-            'budgetEdu' => $budgetEdu,
-            'direction_studies' => DirectionStudy::query()
-                ->withAdmissionCampaignByYear($activeCampaign->academic_year)
-                ->withActivePrograms()
-                ->get(),
-            'seo' => $seo
-        ];
+        $data = $this->listEducationalProgramsAction->run($filters);

        return Inertia::render('Client/Programs/Index', $data);
    }
+
    public function show(string $slug): \Inertia\Response
    {
-        $cacheKeyProgram = CacheKeys::EDUCATION_PROGRAM_PREFIX->value . md5($slug);
-        $cacheKeySeo = CacheKeys::EDUCATION_PROGRAM_PREFIX->value . 'seo_' . md5($slug);
-        $cacheKeyForms = 'education_forms_list';
+        $data = $this->getEducationalProgramAction->run($slug);

-        $programModel = Cache::remember($cacheKeyProgram, now()->addHours(1), function () use ($slug) {
-            return EducationalProgram::query()
-                ->where('slug', $slug)
-                ->with(['admission_plans', 'directionStudy', 'seo'])
-                ->firstOrFail();
-        });
-
-        $formsEdu = Cache::remember($cacheKeyForms, now()->addDay(), function () {
-            return collect(BudgetEducation::cases())
-                ->mapWithKeys(fn($form) => [$form->value => $form->getLabel()]);
-        });
-
-        $seo = Cache::remember($cacheKeySeo, now()->addHours(1), function () use ($programModel) {
-            return $this->seoPageProvider->getSeoForModel($programModel);
-        });
-
-        $program = new EducationalProgramResource($programModel);
-
-        return Inertia::render('Client/Programs/Show', compact('program', 'formsEdu', 'seo'));
+        return Inertia::render('Client/Programs/Show', $data);
    }
-
-    private function getAdmissionCampaignName(): string
-    {
-        $cacheKey = CacheKeys::EDUCATION_PROGRAM_PREFIX->value . 'active_campaign_name';
-
-        return Cache::remember($cacheKey, now()->addHours(1), function () {
-            $campaign = AdmissionCampaign::query()->where('status', 1)->first();
-            return $campaign->name;
-        });
-    }
-
-    private function applyFormFilter($query, $form)
-    {
-        $formValue = Str::of(FormEducation::fromName($form)->value)->toString();
-
-        $query->whereHas('programs.admission_plans', function ($query) use ($formValue) {
-            $query->whereJsonContains('contests', ['form_education' => $formValue]);
-        })
-            ->with(['programs' => function ($query) use ($formValue) {
-                $query->whereHas('admission_plans', function ($q) use ($formValue) {
-                    $q->whereJsonContains('contests', ['form_education' => $formValue]);
-                });
-            }]);
-    }
-
-    private function applyBudgetFilter($query, $budget): void
-    {
-        $budgetValue = Str::of(BudgetEducation::fromName($budget)->value)->toString();
-
-        $query->whereHas('programs.admission_plans', function ($query) use ($budgetValue) {
-            $query->where('contests', 'like', '%"form_budget":"'.$budgetValue.'"%');
-        })
-            ->with(['programs' => function ($query) use ($budgetValue) {
-                $query->whereHas('admission_plans', function ($query) use ($budgetValue) {
-                    $query->where('contests', 'like', '%"form_budget":"'.$budgetValue.'"%');
-                });
-            }]);
-    }
-}
+}