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

<?php

declare(strict_types=1);

namespace App\Models;

use App\Casts\DeliveryAddressCast;
use App\Casts\MoneyCast;
use App\Casts\OrderEmployeeCast;
use App\Casts\OrderReferenceCast;
use App\Traits\Models\HasUuidV7AsPrimaryKey;
use Carbon\CarbonInterface;
use Domain\Enums\OrderStatus;
use Domain\Models\ValueObjects\Entities\OrderId;
use Illuminate\Database\Eloquent\Attributes\Fillable;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Ramsey\Uuid\Uuid;

/**
 * @property string $id
 * @property string|null $shop_id
 * @property \Domain\Models\ValueObjects\OrderReference $reference
 * @property \Domain\Models\ValueObjects\OrderEmployee $employee
 * @property \Domain\Models\ValueObjects\DeliveryAddress $delivery_address
 * @property \Illuminate\Support\Carbon|null $pickup_day
 * @property \Money\Money $total
 * @property OrderStatus $status
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @property string|null $employee_matricule
 * @property-read \Carbon\CarbonInterface|null $created_at
 * @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\OrderLine> $lines
 * @property-read \App\Models\Shop|null $shop
 *
 * @method static Builder<static>|Order whereCreatedAtBetween(\Carbon\CarbonInterface $start, \Carbon\CarbonInterface $end)
 *
 * @mixin \Eloquent
 */
#[Fillable([])]
class Order extends Model
{
    use HasUuidV7AsPrimaryKey;

    public const CREATED_AT = null;

    public function getId(): OrderId
    {
        return new OrderId(Uuid::fromString($this->id));
    }

    /** @return \Illuminate\Database\Eloquent\Relations\HasMany<\App\Models\OrderLine,$this> */
    public function lines(): HasMany
    {
        return $this->hasMany(OrderLine::class);
    }

    /** @return \Illuminate\Database\Eloquent\Relations\BelongsTo<\App\Models\Shop,$this> */
    public function shop(): BelongsTo
    {
        return $this->belongsTo(Shop::class);
    }

    /** @param Builder<static> $query */
    protected function scopeWhereCreatedAtBetween(Builder $query, CarbonInterface $start, CarbonInterface $end): void
    {
        $minUuid = (string) Uuid::uuid7($start->copy()->startOfDay());
        $maxUuid = (string) Uuid::uuid7($end->copy()->endOfDay());

        $query->whereBetween('id', [$minUuid, $maxUuid]);
    }

    #[\Override]
    protected function casts(): array
    {
        return [
            'pickup_day'       => 'date',
            'employee'         => OrderEmployeeCast::class,
            'total'            => MoneyCast::class,
            'status'           => OrderStatus::class,
            'delivery_address' => DeliveryAddressCast::class,
            'reference'        => OrderReferenceCast::class,
        ];
    }
}