<?php

namespace App\Vat\Models;

use Komma\KMS\Core\Attributes\Models\Traits\HasThumbnailInterface;
use Komma\KMS\Core\Attributes\Models\Traits\HasThumbnailTrait;
use Komma\KMS\Core\Entities\DisplayNameInterface;
use Komma\KMS\Core\Entities\DisplayNameTrait;
use Komma\KMS\Sites\HasSitesInterface;
use Komma\KMS\Sites\Models\Site;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;

/**
 * Class Rate
 *
 * @property int $percentage
 * @property string $description
 * @property string $name
 * @property boolean $default
 * @package App\Vat\Models
 * @property-read \Illuminate\Database\Eloquent\Collection|Site[] $sites
 * @property-read int|null $sites_count
 * @method static \Illuminate\Database\Eloquent\Builder|Rate newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|Rate newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|Rate query()
 * @mixin \Eloquent
 */
final class Rate extends Model implements DisplayNameInterface, HasThumbnailInterface, HasSitesInterface {
    use DisplayNameTrait;
    use HasThumbnailTrait;

    protected $table = 'vatrates';

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = ['name', 'description', 'percentage', 'default'];

    /**
     * Get the site or sites for this model
     *
     * @return BelongsToMany
     */
    public function sites(): BelongsToMany
    {
        return $this->belongsToMany(Site::class, 'vatrate_site', 'vatrate_id');
    }
}