<?php


namespace App\Partners\Models;

use Komma\KMS\Core\AbstractTranslatableModel;
use Komma\KMS\Core\Attributes\Models\Traits\HasThumbnailInterface;
use Komma\KMS\Core\Attributes\Models\Traits\HasThumbnailTrait;
use Komma\KMS\Core\Tree\NestedSets\Nodes\TreeModelInterface;
use Komma\KMS\Core\Tree\NestedSets\Nodes\TreeModelLogicTrait;
use Komma\KMS\Documents\DocumentsTrait;
use Komma\KMS\Documents\Kms\DocumentableInterface;
use Komma\KMS\Core\Entities\DisplayNameInterface;
use Komma\KMS\Core\Entities\DisplayNameTrait;
use Komma\KMS\Globalization\Languages\Models\Language;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Komma\KMS\Sites\HasSiteInterface;
use Komma\KMS\Sites\SiteTrait;

/**
 * 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 \Illuminate\Database\Eloquent\Collection|\App\Languages\Models\Language[] $languages
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Site\Site[] $sites
 * @property-read \App\Partners\Models\PartnerTranslation $translation
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Partners\Models\PartnerTranslation[] $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\Partners\Models\Partner whereActive($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Partners\Models\Partner whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Partners\Models\Partner whereDate($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Partners\Models\Partner whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Partners\Models\Partner 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\Partners\Models\Partner newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Partners\Models\Partner newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Partners\Models\Partner query()
 */
final class Partner extends AbstractTranslatableModel implements DocumentableInterface, DisplayNameInterface, HasThumbnailInterface, HasSiteInterface, TreeModelInterface
{
    use DocumentsTrait;
    use DisplayNameTrait;
    use HasThumbnailTrait;
    use SiteTrait;
    use TreeModelLogicTrait;

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

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

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

    /**
     * Get the name for the sidebar
     *
     * @return string
     */
    public function getSidebarName():string
    {
        // If there is no name defined generate a generic name
        if(!$sidebarName = $this->getDisplayName()){
            return __('KMS::partners.entity') . ' '.$this->id;
        }
        return $sidebarName;
    }

}