<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

/**
 * @property integer $id
 * @property integer $type_id
 * @property integer $region_id
 * @property string $state
 * @property string $street
 * @property string $zipcode
 * @property string $city
 * @property float $latitude
 * @property float $longitude
 * @property integer $order
 * @property string $created_at
 * @property string $updated_at
 * @property StoreType $storeType
 * @property StoreRegion $storeRegion
 */
class Store extends Model
{
    use HasFactory;

    /**
     * @var array
     */
    protected $fillable = [
        'type_id',
        'region_id',
        'state',
        'street',
        'zipcode',
        'city',
        'latitude',
        'longitude',
        'order',
        'created_at',
        'updated_at'
    ];

    // * EVENTS

    /**
     * Perform any actions required after the model boots.
     *
     * @return void
     */
    protected static function booted()
    {
        static::creating(function (self $model) {
            self::setOrder($model);
        });
    }

    // * METHODS

    /**
     * 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;
    }

    // * RELATIONSHIPS

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function storeType()
    {
        return $this->belongsTo('App\Models\StoreType', 'type_id');
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function storeRegion()
    {
        return $this->belongsTo('App\Models\StoreRegion', 'region_id');
    }
}