<?php


namespace App\Komma\Company\Models;


use App\Komma\Addresses\AddressableInterface;
use App\Komma\Addresses\Models\Address;
use App\Komma\Users\Models\SiteUser;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;

/**
 * Class Company
 *
 * @package App\Komma\Company\Models
 * @property int $id
 * @property string $name
 * @property string $vat_number
 * @property string $chamber_of_commerce
 * @property string $vat_number_validated
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Addresses\Models\Address[] $addresses
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Users\Models\KmsUser[] $users
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Company\Models\Company newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Company\Models\Company newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Company\Models\Company query()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Company\Models\Company whereChamberOfCommerce($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Company\Models\Company whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Company\Models\Company whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Company\Models\Company whereName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Company\Models\Company whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Company\Models\Company whereVatNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Company\Models\Company whereVatNumberValidated($value)
 * @mixin \Eloquent
 */
class Company extends Model implements AddressableInterface
{
    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name',
        'vat_number',
        'chamber_of_commerce',
        'vat_number_validated',
    ];

    /**
     * Returns the users this company belongs to
     *
     * @return BelongsToMany
     */
    public function users(): BelongsToMany
    {
        return $this->belongsToMany(SiteUser::class);
    }

    /**
     * Returns the users this company belongs to
     *
     * @return BelongsToMany
     */
    public function addresses(): BelongsToMany
    {
        return $this->belongsToMany(Address::class);
    }
}