ldc-crm/app/Models/Question.php

<?php

namespace App\Models;

use App\Enums\QuestionType;
use App\Traits\Models\ActivityLog;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\Cache;

/**
 * @property integer                 $id                 Id.
 * @property integer                 $brand_id           Foreign key Brand.
 * @property string                  $question           Question.
 * @property \App\Enums\QuestionType $type               Type de question.
 * @property-read \Illuminate\Support\Carbon $created_at Created date.
 * @property-read \Illuminate\Support\Carbon $updated_at Updated date.
 *
 * @property-read \Illuminate\Support\Collection $answers Answer hasMany relation.
 * @property-read \App\Models\Brand              $brand Brand BelongsTo relation.
 */
class Question extends Model
{
    use ActivityLog;
    use HasFactory;

    /**
     * The attributes that are mass assignable.
     *
     * @var array<int, string>
     */
    protected $fillable = [
        'question',
        'type',
        'brand_id',
    ];

    /**
     * The attributes that should be cast to native types.
     *
     * @var array<string, mixed>
     */
    protected $casts = [
        'type' => QuestionType::class,
    ];

    /**
     * Perform any actions required after the model boots.
     *
     * @return void
     */
    protected static function booted(): void
    {
        static::created(function (self $model) {
            self::resetCache($model->getKey());
        });
        static::updated(function (self $model) {
            self::resetCache($model->getKey());
        });
        static::deleted(function (self $model) {
            self::resetCache($model->getKey());
        });
    }

    // * METHODS

    /**
     * Get all questions associated to the band.
     *
     * @param integer $brandModelKey
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public static function getAllModelsFromBrand(int $brandModelKey): \Illuminate\Database\Eloquent\Collection
    {
        return self::getQuestions()->filter(
            fn($model) => $model->brand->getKey() === $brandModelKey
        )->values();
    }

    /**
     * Reset all cache elements related to this model.
     *
     * @param integer $modelKey
     * @return void
     */
    private static function resetCache(int $modelKey): void
    {
        Cache::forget('questions');
        Cache::forget("question-{$modelKey}-answers");
        self::getQuestions();
    }

    /**
     * Get all questions.
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public static function getQuestions(): \Illuminate\Database\Eloquent\Collection
    {
        return Cache::remember('questions', 86400, function () {
            return self::query()->orderBy('question', 'ASC')->get();
        });
    }

    // * RELATIONS

    /**
     * Brand belongs to relation.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function brand(): \Illuminate\Database\Eloquent\Relations\BelongsTo
    {
        return $this->belongsTo(Brand::class);
    }

    /**
     * Answer has many relation.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function answers(): \Illuminate\Database\Eloquent\Relations\HasMany
    {
        return $this->hasMany(Answer::class);
    }
}