ldc-boutique-cnc-sable/app/Models/Slide.php

<?php

declare(strict_types=1);

namespace App\Models;

use App\Interfaces\ModelWithOrder;
use App\Interfaces\ModelWithStatus;
use App\Lib\Helpers\FileStorageHelper;
use App\Traits\Models\HasOrder;
use App\Traits\Models\HasStatus;
use Illuminate\Contracts\Session\Session;
use Illuminate\Database\Eloquent\Attributes\Fillable;
use Illuminate\Database\Eloquent\Attributes\Guarded;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Shared\Helpers\DatesHelper;

/**
 * @property int $id
 * @property string $title
 * @property string|null $text
 * @property string|null $picture
 * @property string|null $picture_alt
 * @property string|null $picture_title
 * @property string|null $link_label
 * @property string|null $link
 * @property bool $link_new_tab
 * @property bool $connected Slide visible only for connected customers.
 * @property int $order
 * @property bool $status
 * @property \Illuminate\Support\Carbon|null $date_start
 * @property \Illuminate\Support\Carbon|null $date_end
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @property-read bool $planificated_status
 *
 * @method static \Database\Factories\SlideFactory factory($count = null, $state = [])
 *
 * @mixin \Eloquent
 */
#[Fillable([
    'title',
    'text',
    'link',
    'link_label',
    'link_new_tab',
    'connected',
    'picture',
    'picture_alt',
    'picture_title',
    'status',
    'date_start',
    'date_end',
])]
#[Guarded([
    'status',
    'order',
])]
class Slide extends Model implements ModelWithOrder, ModelWithStatus
{
    /** @use HasFactory<\Database\Factories\SlideFactory> */
    use HasFactory;

    use HasOrder;
    use HasStatus;

    #[\Override]
    protected static function booted()
    {
        static::creating(function (self $model): void {
            self::manageFields($model);
            self::makeStatusSense($model);
        });
        static::updating(function (self $model): void {
            self::manageFields($model);
            self::makeStatusSense($model);
        });
        static::deleting(function (self $model): void {
            FileStorageHelper::removeFile($model, 'picture');
        });
    }

    public function isVisible(): bool
    {
        return DatesHelper::isIn($this->date_start, $this->date_end);
    }

    /** @return \Illuminate\Database\Eloquent\Casts\Attribute<bool,never> */
    protected function planificatedStatus(): Attribute
    {
        return Attribute::get(fn (): bool => $this->isVisible());
    }

    private static function manageFields(self $model): void
    {
        $model->picture = FileStorageHelper::storeFile($model, $model->picture, true);

        if ($model->order === null) {
            $max          = self::query()->max('order');
            $model->order = is_scalar($max) ? intval($max) + 1 : 1;
        }
    }

    private static function makeStatusSense(self $model): void
    {
        $actualStatus  = $model->status;
        $model->status = $model->planificatedStatus;

        if ($actualStatus !== $model->status) {
            resolve(Session::class)->flash('bo.info', \trans(
                'The publication status is updated according to the scheduled dates. '
                    . 'To change the publication status, please edit or remove the corresponding dates.'
            ));
        }
    }

    #[\Override]
    protected function casts(): array
    {
        return [
            'link_new_tab' => 'bool',
            'connected'    => 'bool',
            'status'       => 'bool',
            'order'        => 'int',
            'date_start'   => 'datetime',
            'date_end'     => 'datetime',
        ];
    }
}