ldc-agis/app/Models/News.php

<?php

namespace App\Models;

use App\Enums\News\CategoryEnum;
use App\Lib\Helpers\FileStorageHelper;
use App\Lib\Helpers\ToolboxHelper;
use App\Traits\Models\ActivityLog;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;
use Spatie\Sitemap\Contracts\Sitemapable;
use Spatie\Sitemap\Tags\Url;
use Uwil\Seo\Laravel\Interfaces\SeoInterface;
use Uwil\Seo\Laravel\Objects\SeoItem;
use Uwil\Seo\Laravel\Traits\SeoTrait;
use Uwil\SitemapGenerator\Lib\SitemapHelper;

/**
 * @property string                       $seo_title               SEO title.
 * @property string                       $seo_description         SEO description.
 * @property string                       $title                   Title.
 * @property string                       $slug                    Slug of the title.
 * @property \App\Enums\News\CategoryEnum $category                Category (\App\Enums\News\CategoryEnum).
 * @property string|null                  $picture_thumbnail       Path of the thumbnail (265px * 354px).
 * @property string|null                  $picture_thumbnail_alt   Thumbnail alt attribute.
 * @property string|null                  $picture_thumbnail_title Thumbnail title attribute.
 * @property string                       $picture                 Path of the picture (1002px*565px).
 * @property string                       $picture_alt             Picture alt attribute..
 * @property string                       $picture_title           Picture title attribute.
 * @property string                       $subtitle                Subtitle.
 * @property string                       $content                 WYSIWYG - Content.
 * @property boolean                      $published               Publication status.
 * @property \Carbon\Carbon|null          $publish_at              Publication status update date.
 * @property \Carbon\Carbon|null          $unpublish_at            Unpublication status update date.
 * @property integer                      $order                   Order.
 * @property-read \Carbon\Carbon          $created_at              Created date.
 * @property-read \Carbon\Carbon          $updated_at              Updated date.
 */
class News extends Model implements SeoInterface, Sitemapable
{
    use ActivityLog;
    use HasFactory;
    use SeoTrait;

    /**
     * The attributes that are mass assignable.
     *
     * @var array<int, string>
     */
    protected $fillable = [
        'seo_title',
        'seo_description',
        'title',
        'slug',
        'category',
        'picture_thumbnail',
        'picture_thumbnail_alt',
        'picture_thumbnail_title',
        'picture',
        'picture_alt',
        'picture_title',
        'subtitle',
        'content',
        'published',
        'publish_at',
        'unpublish_at',
        'order',
    ];

    /**
     * The attributes that should be cast.
     *
     * @var array<string, string>
     */
    protected $casts = [
        'category'     => CategoryEnum::class,
        'published'    => 'bool',
        'publish_at'   => 'datetime',
        'unpublish_at' => 'datetime',
    ];

    /**
     * Perform any actions required after the model boots.
     *
     * @return void
     */
    protected static function booted(): void
    {
        static::creating(function (self $model) {
            self::assertFieldIsUnique('title', $model->title);
            self::setOrder($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
    {
        self::setSlug($model, $model->title);
        self::makeStatusSense($model);
        $model->picture           = FileStorageHelper::storeFile($model, $model->picture, true);
        $model->picture_thumbnail = FileStorageHelper::storeFile($model, $model->picture_thumbnail, true);
    }

    /**
     * Set the slug.
     *
     * @param self   $model
     * @param string $original
     *
     * @return void
     */
    private static function setSlug(self $model, string $original): void
    {
        $model->slug = Str::slug($original);
    }

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

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

    /**
     * Adjusts model status using current status and publish dates
     *
     * @param self $model
     * @return void
     */
    private static function makeStatusSense(self $model): void
    {
        /** @var \Carbon\Carbon|null */
        $publish_at = $model->publish_at;
        /** @var \Carbon\Carbon|null */
        $unpublish_at = $model->unpublish_at;
        $wantedStatus = $model->published;
        if ($publish_at or $unpublish_at) {
            $model->published = $model->planificated_status;
        }
        if ($wantedStatus !== $model->published) {
            $previousMessage = session()->get('bo.info', '');
            session()->flash('bo.info', \trans(
                'La publication est modifiée en concordance avec les dates enregistrées.
                Pour modifier l\'état de publication, veuillez modifier ou enlever les dates correspondantes.'
            ) . " \n{$previousMessage}");
        }
    }

    /**
     * Getter the current status following planification dates planificated_status
     *
     * @return boolean
     */
    public function getPlanificatedStatusAttribute(): bool
    {
        /** @var \Carbon\Carbon|null */
        $publish_at = $this->publish_at;
        /** @var \Carbon\Carbon|null */
        $unpublish_at = $this->unpublish_at;
        if ($publish_at and $unpublish_at) {
            return $unpublish_at->greaterThanOrEqualTo(now()) and $publish_at->lessThan(now());
        }
        if ($publish_at) {
            return $publish_at->lessThan(now());
        }
        if ($unpublish_at) {
            return $unpublish_at->greaterThanOrEqualTo(now());
        }
        return false;
    }

    // * SEO TRAIT OVERLOAD
    /**
     * Transform to seoModel
     *
     * @return \Uwil\Seo\Laravel\Objects\SeoItem
     */
    public function toSeoItem(): SeoItem
    {
        return new SeoItem(
            \trans('models.classes.' . Str::singular($this->getTable())),
            $this->seo_title,
            $this->seo_description,
            $this->published ?? false,
            \route(\config('seo.bo_route_prefix') . $this->getTable() . '.edit', $this),
            $this->published ? \route('fo.' . $this->getTable() . '.show', $this) : ''
        );
    }

    /**
     * toSitemapTag method
     *
     * @return Url|string|array
     */
    public function toSitemapTag(): Url | string | array
    {
        $model  = $this;
        $route  = 'fo.news.show';
        $params = ['slug' => $model->slug];
        return SitemapHelper::generateUrl($route, $params, $model);
    }
}