<?php
/**
 *
 *
 * @author      Komma <info@komma.pro>
 * @copyright   (c) 2012-2016, Komma
 */

namespace App\References\Models;

use App\Components\Component\ComponentableInterface;
use App\Components\Component\ComponentableTrait;
use Illuminate\Support\Str;
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\Core\Tree\NestedSets\Nodes\AbstractTranslatableTreeModel;
use Komma\KMS\Helpers\KommaHelpers;

/**
 * Class Reference
 *
 * @package App\References\Models
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Globalization\Languages\Models\Language[] $languages
 * @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 int|null $lft
 * @property int|null $rgt
 * @property int|null $tree
 * @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 whereCodeName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\References\Models\Reference whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\References\Models\Reference whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\References\Models\Reference whereLft($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\References\Models\Reference whereRgt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\References\Models\Reference whereSiteId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\References\Models\Reference whereTree($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
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Components\Component\Component[] $components
 * @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()
 * @property int|null $site_id
 * @property string $name
 * @property-read int|null $documents_count
 * @property-read int|null $images_count
 * @property-read int|null $languages_count
 * @property-read \App\Site\Site|null $site
 * @property-read int|null $translations_count
 * @method static \Illuminate\Database\Eloquent\Builder|Reference whereName($value)
 */
final class Reference extends AbstractTranslatableTreeModel implements DisplayNameInterface, DocumentableInterface
{
    use DocumentsTrait;
    use DisplayNameTrait;

    protected $class = Reference::class;

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

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

    public function __get($key)
    {
        if($key == "parent_id") {
            if($this::find($this->id))
                return $this->getParentId();
        }

        return parent::__get($key);
    }

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