<?php

namespace App\Models;

use App\Lib\Helpers\FileStorageHelper;
use App\Traits\Models\IsCachedAsCollection;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

/**
 * Product.
 *
 * @property      string                     $name       Name
 * @property      string                     $picture    Path of the picture
 * @property      integer                    $code_ean   Ean code
 * @property-read \Illuminate\Support\Carbon $created_at Creation Date.
 * @property-read \Illuminate\Support\Carbon $updated_at Last update Date.
 *
 * @method protected static function booted()           The "booted" method of the model.
 * @method private static function manageFields($model) Manage model fields.
 *
 * @property-read \App\Models\Range[] $range Associated range.
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Participation[] $participations
 * Associated participations.
 */
class Product extends Model
{
    use HasFactory;
    use IsCachedAsCollection;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name',
        'picture',
        'picture_alt',
        'picture_title',
        'code_ean',
        'range_id',
    ];

    // * EVENTS

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

    // * METHODS

    /**
     * Undocumented function
     *
     * @param Model $model
     * @return void
     */
    private static function manageFields(Model $model)
    {
        $model->picture = FileStorageHelper::storeFile($model, $model->picture, true);
    }

    /**
     * Range relation
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function range()
    {
        return $this->belongsTo(Range::class);
    }

    /**
     * Participations relation
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function participations()
    {
        return $this->hasMany(Participation::class);
    }
}