<?php

namespace App\Models;

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

/**
 * @property string              $label         Label du pictogramme.
 * @property string              $picture       Path du visuel du pictogramme (85px * 85px).
 * @property string              $picture_alt   Attribut alt du visuel du pictogramme.
 * @property string              $picture_title Attribut title du visuel du pictogramme.
 * @property boolean             $published     Le picto est-il visble ?
 * @property-read \Carbon\Carbon $created_at    Created date.
 * @property-read \Carbon\Carbon $updated_at    Updated date.
 *
 * @property-read \App\Models\CommitmentPage $commitmentPages Commitment Pages Many-to-many relationship.
 * @property-read \App\Models\Product        $products        Products Many-to-many relationship.
 */
class Picto extends Model
{
    use ActivityLog;
    use HasFactory;

    /**
     * The attributes that are mass assignable.
     *
     * @var array<int, string>
     */
    protected $fillable = [
        'label',
        'picture',
        'picture_alt',
        'picture_title',
        'published',
    ];

    /**
     * The attributes that should be cast.
     *
     * @var array<string, string>
     */
    protected $casts = [
        'published'    => 'boolean',
    ];

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

        static::deleted(function (self $model) {
            FileStorageHelper::removeFile($model, 'picture');
        });
    }

    // * METHODS

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

    // * RELATIONS

    /**
     * The pages that belong to the picto.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function commitmentPages(): \Illuminate\Database\Eloquent\Relations\BelongsToMany
    {
        return $this->belongsToMany(CommitmentPage::class);
    }

    /**
     * The products that belong to the picto.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function products(): \Illuminate\Database\Eloquent\Relations\BelongsToMany
    {
        return $this->belongsToMany(Product::class);
    }
}