diff --git a/app/Enums/BreedingPageType.php b/app/Enums/BreedingPageType.php index d9dc861a..b2dd9255 100644 --- a/app/Enums/BreedingPageType.php +++ b/app/Enums/BreedingPageType.php @@ -13,6 +13,11 @@ use Kwaadpepper\Enum\BaseEnumRoutable; */ final class BreedingPageType extends BaseEnumRoutable { + /** + * Enum values + * + * @return array + */ protected static function values(): array { $labels = self::labels(); diff --git a/app/Http/Controllers/BreedingPageController.php b/app/Http/Controllers/BreedingPageController.php index f3af7f6a..6f34cbda 100644 --- a/app/Http/Controllers/BreedingPageController.php +++ b/app/Http/Controllers/BreedingPageController.php @@ -6,60 +6,79 @@ use App\Enums\BreedingPageType; use App\Enums\GeneralConfigType; use App\Enums\InputType; use App\Models\BreedingPage; +use App\Models\GeneralConfig; use Illuminate\Support\Facades\View; class BreedingPageController extends Controller { + /** + * BreedingPageController + */ public function __construct() { - $generalConfig = app()->view->getShared()['GeneralConfigGlobal'] ?? null; - if ($generalConfig) { - View::share('generalConfig', $generalConfig - ->where('type', GeneralConfigType::breedingPage()) - ->first()); - } + $this->middleware(function ($request, $next) { + View::share('generalConfig', GeneralConfig::getCachedConfig( + GeneralConfigType::breedingPage() + )); + return $next($request); + }); } + /** + * Show Breeding Page index + * + * @return \Illuminate\Contracts\View\View|\Illuminate\Contracts\View\Factory + */ public function index() { return view('front.breeding-page.index'); } - public function list(BreedingPageType $pagesType) + /** + * Show Breeding Pages within a type + * + * @param BreedingPageType $pageType + * @return \Illuminate\Contracts\View\View|\Illuminate\Contracts\View\Factory + */ + public function list(BreedingPageType $pageType) { - $pages = BreedingPage::where('type', $pagesType)->whereStatus(true)->get(); - $generalConfig = app()->view->getShared()['GeneralConfigGlobal'] ?? null; - $generalConfig = $generalConfig ? $generalConfig->where('type', GeneralConfigType::breedingPage())->first() : null; - $breederPageTypes = collect($generalConfig->data)->filter(function($v, $key) { - return strpos($key, 'breeding_page_') === 0 and isset($v['type']) and $v['inputType']['value'] === InputType::string()->value; - }); - $array = []; - - foreach($breederPageTypes as $key => $pageType){ - $array[$pageType['type']['value']] = $generalConfig->data[str_replace('_text', '_img2', $key)]; - } + $pages = BreedingPage::where('type', $pageType)->whereStatus(true)->get(); + $bannerUrl = $this->getBannerUrlFromGeneralConfig($pageType); - $bannerUrl = $array[$pagesType->value]["value"]; - - return view('front.breeding-page.list', compact('pages', 'pagesType', 'bannerUrl')); + return view('front.breeding-page.list', compact('pages', 'pageType', 'bannerUrl')); } - // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassAfterLastUsed - public function show(BreedingPageType $pagesType, BreedingPage $page) + /** + * Show specific breeder page + * + * @param BreedingPageType $pageType + * @param BreedingPage $page + * @return \Illuminate\Contracts\View\View|\Illuminate\Contracts\View\Factory + * @phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassAfterLastUsed + */ + public function show(BreedingPageType $pageType, BreedingPage $page) { - $generalConfig = app()->view->getShared()['GeneralConfigGlobal'] ?? null; - $generalConfig = $generalConfig ? $generalConfig->where('type', GeneralConfigType::breedingPage())->first() : null; - $breederPageTypes = collect($generalConfig->data)->filter(function($v, $key) { - return strpos($key, 'breeding_page_') === 0 and isset($v['type']) and $v['inputType']['value'] === InputType::string()->value; - }); - $array = []; - - foreach($breederPageTypes as $key => $pageType){ - $array[$pageType['type']['value']] = $generalConfig->data[str_replace('_text', '_img2', $key)]; - } + $bannerUrl = $this->getBannerUrlFromGeneralConfig($pageType); + return view('front.breeding-page.show', compact('page', 'pageType', 'bannerUrl')); + } - $bannerUrl = $array[$pagesType->value]["value"]; + /** + * Get banner url from general config + * + * @param BreedingPageType $pageType + * @return string + */ + private function getBannerUrlFromGeneralConfig(BreedingPageType $pageType): string + { + $generalConfig = GeneralConfig::getCachedConfig(GeneralConfigType::breedingPage()); + /** @var string */ + $key = \strval(collect($generalConfig->data)->filter(function (array $input) use ($pageType) { + return $input['inputType']['value'] === InputType::string()->value and + isset($input['type']) and + $input['type']['value'] === $pageType->value; + })->keys()->first()); - return view('front.breeding-page.show', compact('page', 'pagesType', 'bannerUrl')); + /** @var string banner url or empty */ + return collect($generalConfig->data)->get(str_replace('_text', '_img2', $key))['value'] ?? ''; } } diff --git a/app/Http/Middleware/XssSanitizer.php b/app/Http/Middleware/XssSanitizer.php index 87c9b1b8..e36c2627 100644 --- a/app/Http/Middleware/XssSanitizer.php +++ b/app/Http/Middleware/XssSanitizer.php @@ -4,6 +4,7 @@ namespace App\Http\Middleware; use App\Lib\Utils; use Closure; +use Illuminate\Http\Request; class XssSanitizer { @@ -12,9 +13,10 @@ class XssSanitizer * * @param \Illuminate\Http\Request $request * @param \Closure $next + * @param mixed ...$params * @return mixed */ - public function handle($request, Closure $next, ...$params) + public function handle(Request $request, Closure $next, ...$params) { $inputs = $request->all(); array_walk_recursive($inputs, function (&$input, $name) use ($params) { diff --git a/app/Models/GeneralConfig.php b/app/Models/GeneralConfig.php index 97a96108..5c621212 100644 --- a/app/Models/GeneralConfig.php +++ b/app/Models/GeneralConfig.php @@ -4,6 +4,7 @@ namespace App\Models; use App\Enums\GeneralConfigType; use App\Traits\MiniCrudModel; +use Illuminate\Database\Eloquent\Collection; use Illuminate\Database\Eloquent\Model; use Illuminate\Support\Facades\Cache; use Kwaadpepper\Enum\Traits\CastsEnums; @@ -13,22 +14,52 @@ class GeneralConfig extends Model use CastsEnums; use MiniCrudModel; - protected $enumCasts = [ - 'type' => GeneralConfigType::class - ]; - - protected $casts = [ - 'data' => 'array' - ]; - + /** + * The primary key for the model. + * + * @var string + */ protected $primaryKey = 'type'; + /** + * Indicates if the IDs are auto-incrementing. + * + * @var boolean + */ public $incrementing = false; + /** + * The attributes that are mass assignable. + * + * @var array + */ protected $fillable = [ 'type', 'data' ]; + /** + * The attributes that should be cast to Enums. + * + * @var array + */ + protected $enumCasts = [ + 'type' => GeneralConfigType::class + ]; + + /** + * The attributes that should be cast. + * + * @var array + */ + protected $casts = [ + 'data' => 'array' + ]; + + /** + * Perform any actions required after the model boots. + * + * @return void + */ protected static function booted() { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass @@ -45,7 +76,12 @@ class GeneralConfig extends Model }); } - public static function getCachedConfigs() + /** + * Get all cached configs + * + * @return \Illuminate\Database\Eloquent\Collection + */ + public static function getCachedConfigs(): Collection { if (!Cache::has('GeneralConfigGlobal')) { self::setCachedConfigs(); @@ -53,9 +89,28 @@ class GeneralConfig extends Model return Cache::get('GeneralConfigGlobal'); } + /** + * Put configs into cache + * + * @return void + */ protected static function setCachedConfigs() { $configs = GeneralConfig::all(); Cache::put('GeneralConfigGlobal', $configs); } + + /** + * Get specific config, + * Every config is mandatory + * + * @param GeneralConfigType $type + * @return GeneralConfig + */ + public static function getCachedConfig(GeneralConfigType $type): GeneralConfig + { + return self::getCachedConfigs()->first(function (GeneralConfig $config) use ($type) { + return $config->type->equals($type); + }); + } } diff --git a/app/Policies/BreedingPagePolicy.php b/app/Policies/BreedingPagePolicy.php index 24281089..0634514c 100644 --- a/app/Policies/BreedingPagePolicy.php +++ b/app/Policies/BreedingPagePolicy.php @@ -6,6 +6,10 @@ use App\Models\BreedingPage; use App\User; use Illuminate\Auth\Access\HandlesAuthorization; +/** + * @phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter.Found + * @phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed + */ class BreedingPagePolicy { use HandlesAuthorization; @@ -13,10 +17,9 @@ class BreedingPagePolicy /** * Determine whether the user can view any models. * - * @param \App\Models\User $user + * @param \App\Models\User $user * @return mixed */ - // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found public function viewAny(User $user) { return auth()->check(); @@ -25,12 +28,10 @@ class BreedingPagePolicy /** * Determine whether the user can view the model. * - * @param \App\Models\User $user - * @param \App\Models\BreedingPage $page + * @param \App\Models\User $user + * @param \App\Models\BreedingPage $page * @return mixed */ - // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found - // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed public function view(User $user, BreedingPage $page) { return auth()->check(); @@ -39,10 +40,9 @@ class BreedingPagePolicy /** * Determine whether the user can create models. * - * @param \App\Models\User $user + * @param \App\Models\User $user * @return mixed */ - // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found public function create(User $user) { if ( @@ -59,12 +59,10 @@ class BreedingPagePolicy /** * Determine whether the user can update the model. * - * @param \App\Models\User $user - * @param \App\Models\BreedingPage $page + * @param \App\Models\User $user + * @param \App\Models\BreedingPage $page * @return mixed */ - // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundBeforeLastUsed - // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed public function update(User $user, BreedingPage $page) { return auth()->check(); @@ -73,12 +71,10 @@ class BreedingPagePolicy /** * Determine whether the user can delete the model. * - * @param \App\Models\User $user - * @param \App\Models\BreedingPage $page + * @param \App\Models\User $user + * @param \App\Models\BreedingPage $page * @return mixed */ - // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundBeforeLastUsed - // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed public function delete(User $user, BreedingPage $page) { return auth()->check(); diff --git a/app/Providers/AppServiceProvider.php b/app/Providers/AppServiceProvider.php index 4464d94b..da868696 100644 --- a/app/Providers/AppServiceProvider.php +++ b/app/Providers/AppServiceProvider.php @@ -50,7 +50,8 @@ class AppServiceProvider extends ServiceProvider foreach ([\LC_TIME, \LC_MESSAGES, \LC_COLLATE, \LC_CTYPE, \LC_MONETARY] as $category) { setlocale( // * remove numeric to prevent float seperator to breaking numeric transactions - $category, \sprintf('%s_%s.UTF-8', config('app.locale'), \strtoupper(config('app.locale'))) + $category, + \sprintf('%s_%s.UTF-8', config('app.locale'), \strtoupper(config('app.locale'))) ); } Carbon::setLocale(config('app.locale')); diff --git a/resources/views/front/breeding-page/list.blade.php b/resources/views/front/breeding-page/list.blade.php index 10945ca6..9d78cc3f 100644 --- a/resources/views/front/breeding-page/list.blade.php +++ b/resources/views/front/breeding-page/list.blade.php @@ -1,13 +1,13 @@ -@extends('layouts.app', ['brParam' => $pagesType]) +@extends('layouts.app', ['brParam' => $pageType]) @section('title', $generalConfig->data['breeding_header_title']['value']) -@section('description', $generalConfig->data['breeding_header_title']['value'] . ' - ' . $pagesType->label) +@section('description', $generalConfig->data['breeding_header_title']['value'] . ' - ' . $pageType->label) @section('breadcrumb', request()->route()->getName()) @section('sub_header')