ldc-gen-game-web/app/Models/Range.php

<?php

declare(strict_types=1);

namespace App\Models;

use App\Lib\Helpers\FileStorageHelper;
use App\Traits\Models\HasActivityLog;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Support\Carbon;

/**
 * Range.
 *
 * @property string $name Name
 * @property string $picture Path of the picture
 * @property string $picture_alt Alt text for the picture
 * @property string $picture_title Title text for the picture
 * @property-read Carbon $created_at Creation Date.
 * @property-read Carbon $updated_at Last update Date.
 * @property-read Collection|Product[] $products
 * Associated products.
 * @property-read \App\Models\ActivityLog $activityLogs Activities logs One-to-many relationship.
 */
class Range extends Model
{
    use HasActivityLog;
    use HasFactory;

    /**
     * The attributes that are mass assignable.
     *
     * @var list<string>
     */
    #[\Override]
    protected $fillable = [
        'name',
        'picture',
        'picture_alt',
        'picture_title',
    ];

    // * EVENTS

    /**
     * Perform any actions required after the model boots.
     */
    protected static function booted(): void
    {
        static::creating(function (self $model): void {
            self::manageFields($model);
        });
        static::updating(function (self $model): void {
            self::manageFields($model);
        });
        static::updated(function (self $model): void {
            FileStorageHelper::removeOldFile($model, 'picture');
        });
        static::deleted(function (self $model): void {
            FileStorageHelper::removeFile($model, 'picture');
        });
    }

    // * METHODS

    /**
     * Common methods function.
     */
    private static function manageFields(self $model): void
    {
        $model->picture = FileStorageHelper::storeFile($model, $model->picture, true);
    }

    // * RELATIONSHIPS
    /**
     * Product relation.
     *
     * @return HasMany<Product, $this>
     */
    public function products(): HasMany
    {
        return $this->hasMany(Product::class);
    }

    /**
     * Activities logs One-to-many relationship.
     *
     * @return HasMany<ActivityLog, $this>
     */
    public function activityLogs(): HasMany
    {
        return $this->hasMany(ActivityLog::class);
    }
}