ldc-nature-and-respect/app/Models/StoreRegion.php

<?php

namespace App\Models;

use App\Lib\Helpers\FileStorageHelper;
use App\Lib\Helpers\ToolboxHelper;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

/**
 * @property integer $id
 * @property integer $group_id
 * @property string $name
 * @property string $picture
 * @property integer $order
 * @property string $created_at
 * @property string $updated_at
 * @property Store[] $stores
 * @property StoreGroup $storeGroup
 */
class StoreRegion extends Model
{
    use HasFactory;

    /**
     * @var array
     */
    protected $fillable = [
        'group_id',
        'name',
        'picture',
        'created_at',
        'updated_at'
    ];

    // * EVENTS

    /**
     * Perform any actions required after the model boots.
     *
     * @return void
     */
    protected static function booted()
    {
        static::creating(function (self $model) {
            self::manageFields($model);
            self::assertFieldIsUnique('name', $model->name);
            self::setOrder($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

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

    /**
     * Set order after the last element of the list.
     *
     * @param \Illuminate\Database\Eloquent\Model $model
     * @return void
     */
    private static function setOrder(Model $model): void
    {
        $model->order = \intval(self::query()->max('order')) + 1;
    }

    /**
     * Asserts using validation that the field is unique.
     *
     * @param string       $nameField
     * @param mixed        $valueField
     * @param integer|null $id
     * @return void
     */
    private static function assertFieldIsUnique(string $nameField, string $valueField, ?int $id = null)
    {
        $table = (new self())->getTable();
        ToolboxHelper::assertFieldIsUnique($table, $nameField, $valueField, $id);
    }

    // * RELATIONSHIPS

    /**
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function stores()
    {
        return $this->hasMany('App\Models\Store', 'region_id');
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function storeGroup()
    {
        return $this->belongsTo('App\Models\StoreGroup', 'group_id');
    }
}