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

<?php

namespace App\Models;

use App\Enums\Sliders\TypeEnum;
use App\Lib\Helpers\FileStorageHelper;
use App\Lib\Helpers\ToolboxHelper;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Spatie\Translatable\HasTranslations;

/**
 * @property integer $id
 * @property boolean $type
 * @property string $title
 * @property string $subtitle
 * @property string $description
 * @property string $link
 * @property string $link_title
 * @property boolean $link_new_tab
 * @property string $picture
 * @property boolean $status
 * @property integer $order
 * @property string $unpublish_at
 * @property string $publish_at
 * @property string $created_at
 * @property string $updated_at
 */
class Slider extends Model
{
    use HasFactory;
    use HasTranslations;

    /**
     * @var array
     */
    protected $fillable = [
        'type',
        'title',
        'subtitle',
        'description',
        'link',
        'link_title',
        'link_new_tab',
        'picture',
        'picture_alt',
        'picture_title',
        'status',
        'order',
        'unpublish_at',
        'publish_at',
        'created_at',
        'updated_at'
    ];

    /**
     * The translatable columns.
     *
     * @var array
     */
    public $translatable = [
        'title',
        'subtitle',
        'description',
        'link',
        'link_title',
        'picture_alt',
        'picture_title'
    ];

    /**
     * The attributes that should be cast.
     *
     * @var array
     */
    protected $casts = [
        'type' => TypeEnum::class,
        'status' => 'bool',
        'publish_at' => 'datetime',
        'unpublish_at' => 'datetime'
    ];

    // * EVENTS

    /**
     * Perform any actions required after the model boots.
     *
     * @return void
     */
    protected static function booted()
    {
        static::creating(function (self $model) {
            self::assertFieldIsUnique('title', $model->title);
            self::manageFields($model);
            self::setOrder($model);
            if (!$model->status) {
                $model->publish_at = null;
            } else {
                $model->unpublish_at = null;
            }
        });
        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

    /**
     * Common methods function.
     *
     * @param Model $model
     * @return void
     */
    private static function manageFields(Model $model)
    {
        if ($model->link) {
            ToolboxHelper::assertNoInternalBoUrls('link', $model->link);
        }
        ToolboxHelper::assertNoInternalBoUrls('description', $model->description);
        $model->description = clean($model->description);
        $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);
    }
}