ldc-legaulois/app/Models/StaticPage.php

<?php

namespace App\Models;

use App\Enums\StaticPageType;
use App\Lib\Helpers\FileStorageHelper;
use App\Lib\Helpers\ToolboxHelper;
use App\Traits\Models\ActivityLog;
use App\Traits\Models\MiniCrudModel;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Str;

/**
 * @property \App\Enums\StaticPageType           $type            Page type (StaticPageEnum).
 * @property string                              $seo_title       Seo title about 70 chars as recommended.
 * @property string                              $seo_description Seo description about 160 chars as recommended.
 * @property string|null                         $title           Title for the page.
 * @property string|null                         $subtitle        The subtitle for the static page.
 * @property string                              $slug            Slug of the title for the page.
 * @property string|null                         $content         WYSIWYG text content using ckeditor.
 * @property string|null                         $picture         Picture path.
 * @property string|null                         $picture_alt     Picture alt.
 * @property string|null                         $picture_title   Picture title.
 * @property array<string, array<string, mixed>> $data            Static page json data.
 * @property-read \Illuminate\Support\Carbon $created_at          Created date.
 * @property-read \Illuminate\Support\Carbon $updated_at          Updated date.
 */
class StaticPage extends Model
{
    use ActivityLog;
    use HasFactory;
    use MiniCrudModel;

    /**
     * The attributes that are mass assignable.
     *
     * @var array<int, string>
     */
    protected $fillable = [
        'type',
        'seo_title',
        'seo_description',
        'title',
        'subtitle',
        'content',
        'picture',
        'picture_alt',
        'picture_title',
        'data',
    ];

    /**
     * The attributes that should be cast.
     *
     * @var array<string, string>
     */
    protected $casts = [
        'type' => StaticPageType::class,
        'data' => 'object',
    ];

    /**
     * Perform any actions required after the model boots.
     *
     * @return void
     */
    protected static function booted(): void
    {
        static::creating(function () {
            throw new \RuntimeException("Creating a new page is not authorized");
        });
        static::updating(function (self $model) {
            self::assertSeoTitleIsUnique($model->seo_title, $model->getKey());
            self::assertTitleIsUnique($model->title, $model->getKey());
            $model->slug = Str::slug($model->title ?? $model->seo_title ?? str()->random(20));
            if (!is_null($model->picture)) {
                $model->picture = FileStorageHelper::storeFile($model, $model->picture, true);
            }
        });
        static::updated(function (self $model) {
            FileStorageHelper::removeOldFile($model, 'picture');

            self::resetCache($model->type);
        });
        static::deleted(function () {
            throw new \RuntimeException('Deleting a page is not authorized');
        });
    }

    // * ROUTABLE

    /**
     * Get the value of the model's route key.
     *
     * @return mixed
     */
    public function getRouteKey(): mixed
    {
        /** @var \App\Enums\StaticPageType */
        $enum = $this->getAttribute($this->getRouteKeyName());
        return $enum->value();
    }

    /**
     * Get the route key for the model.
     *
     * ! Type is the routable parameter
     *
     * @return string
     */
    public function getRouteKeyName(): string
    {
        return 'type';
    }

    // * METHODS

    /**
     * Asserts using validation that the title is unique
     *
     * @param string|null  $seo_title
     * @param integer|null $id
     * @return void
     * @throws \Illuminate\Validation\ValidationException If an actu seo_title already exists.
     */
    private static function assertSeoTitleIsUnique(string|null $seo_title, ?int $id = null): void
    {
        if (!is_null($seo_title)) {
            $table = (new self())->getTable();
            ToolboxHelper::assertFieldIsUnique($table, 'seo_title', $seo_title, $id);
            ToolboxHelper::assertFieldIsUnique($table, 'slug', Str::slug($seo_title), $id);
        }
    }

    /**
     * Asserts using validation that the title is unique
     *
     * @param string|null  $title
     * @param integer|null $id
     * @return void
     * @throws \Illuminate\Validation\ValidationException If an actu seo_title already exists.
     */
    private static function assertTitleIsUnique(string|null $title, ?int $id = null): void
    {
        if (!is_null($title)) {
            $table = (new self())->getTable();
            ToolboxHelper::assertFieldIsUnique($table, 'title', $title, $id);
            ToolboxHelper::assertFieldIsUnique($table, 'slug', Str::slug($title), $id);
        }
    }

    /**
     * Reset all cache elements related to this model.
     *
     * @param \App\Enums\StaticPageType $type
     * @return void
     */
    private static function resetCache(StaticPageType $type): void
    {
        Cache::forget(sprintf('%sStaticPage', $type->name));
        self::getCachedStaticPage($type);

        // Breeding pages.
        Cache::forget('breedingStaticPages');
        self::getCachedBreedingStaticPages();
    }

    /**
     * Get cached static page associated to a given type.
     *
     * @param \App\Enums\StaticPageType $type
     * @return \App\Models\StaticPage
     */
    public static function getCachedStaticPage(StaticPageType $type): \App\Models\StaticPage
    {
        return Cache::rememberForever(
            sprintf('%sStaticPage', $type->name),
            fn() => self::query()->where('type', $type)->first()
        );
    }

    /**
     * Get cached static pages associated to all breeding types.
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public static function getCachedBreedingStaticPages(): \Illuminate\Database\Eloquent\Collection
    {
        return Cache::rememberForever(
            'breedingStaticPages',
            fn() => self::query()->whereIn('type', StaticPageType::getBreedingPages())->get()
        );
    }
}