<?php

namespace App\Traits\Models;

use Illuminate\Database\Eloquent\Model;

trait Orderable
{
    /**
     * Returns the grouping field used for ordering.
     * Returns null if the order is global
     *
     * @return string|null
     */
    public function getOrderGroupField(): ?string
    {
        return null;
    }

    /**
     * Set order after the last element of the list.
     *
     * @param Model $model
     * @param bool  $isDeletion
     * @return void
     */
    public static function setOrder(Model $model, bool $isDeletion = false): void
    {
        $groupField    = $model->getOrderGroupField();
        $maxOrderQuery = $model::query();

        if ($groupField) {
            $maxOrderQuery->where($groupField, $model->{$groupField});
        }

        $maxOrder = \intval($maxOrderQuery->max('order'));

        if ($isDeletion) {
            $query = $model::query()
                ->whereKeyNot($model)
                ->whereBetween('order', [$model->order, $maxOrder]);

            if ($groupField) {
                $query->where($groupField, $model->{$groupField});
            }

            $query->decrement('order', 1);
            return;
        }

        $model->order = $maxOrder + 1;
    }
}