<?php
namespace App\References\Models;

use Komma\KMS\Core\Tree\NestedSets\Nodes\AbstractTranslatableTreeModel;
use Komma\KMS\Documents\DocumentsTrait;
use Komma\KMS\Documents\Kms\DocumentableInterface;
use Komma\KMS\Globalization\Languages\Models\Language;
use Komma\KMS\Core\AbstractTranslatableModel;
use Komma\KMS\Core\Entities\DisplayNameInterface;
use Komma\KMS\Core\Entities\DisplayNameTrait;
use Komma\KMS\Sites\HasSiteInterface;
use Komma\KMS\Sites\HasSitesInterface;
use Komma\KMS\Sites\Models\Site;
use App\Users\Models\SiteUser;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\HasOne;
use Illuminate\Support\Carbon;
use Illuminate\Support\Str;

/**
 * Class Page
 *
 * @package App\Pages\Models
 * @property int site_id
 * @property int lft
 * @property int rgt
 * @property int tree
 * @property-read Carbon $date
 * @property-read \App\Globalization\Languages\Models\Language[] $languages
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Sites\Models\Site $site
 * @property-read \App\References\Models\ReferenceTranslation $translation
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\References\Models\ReferenceTranslation[] $translations
 * @mixin \Eloquent
 * @property int $id
 * @property int $active
 * @property \Carbon\Carbon|null $created_at
 * @property \Carbon\Carbon|null $updated_at
 * @method static \Illuminate\Database\Eloquent\Builder|\App\References\Models\Reference whereActive($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\References\Models\Reference whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\References\Models\Reference whereDate($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\References\Models\Reference whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\References\Models\Reference whereUpdatedAt($value)
 * @property-read \Illuminate\Database\Eloquent\Collection|\Komma\KMS\Documents\Models\Document[] $documents
 * @property-read \Illuminate\Database\Eloquent\Collection|\Komma\KMS\Documents\Models\Document[] $images
 * @method static \Illuminate\Database\Eloquent\Builder|\App\References\Models\Reference newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\References\Models\Reference newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\References\Models\Reference query()
 */
final class Reference extends AbstractTranslatableTreeModel implements HasSiteInterface, DocumentableInterface, DisplayNameInterface
{
    use DocumentsTrait;
    use DisplayNameTrait;

    protected $table = 'references';
    protected $class = Reference::class;

    protected $fillable = ['active', 'site_id', 'lft', 'rgt', 'tree'];

    /**
     * Gets the translation models for this model
     *
     * @return HasMany that resolves to AbstractTranslationModel instances
     */
    public function translations(): HasMany
    {
        return $this->hasMany(ReferenceTranslation::class);
    }

    public function languages(): BelongsToMany
    {
        return $this->belongsToMany(Language::class, 'reference_translations')
            ->withPivot('slug', 'name', 'description')
            ->withTimestamps();
    }

}