<?php
namespace App\QuestionCategories\Models;

use App\Questions\Models\Question;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Komma\KMS\Core\AbstractTranslatableModel;
use Komma\KMS\Core\Entities\DisplayNameInterface;
use Komma\KMS\Core\Entities\DisplayNameTrait;
use Komma\KMS\Core\Tree\NestedSets\Nodes\AbstractTranslatableTreeModel;
use Komma\KMS\Core\Tree\NestedSets\Nodes\TreeModelInterface;
use Komma\KMS\Core\Tree\NestedSets\Nodes\TreeModelLogicTrait;
use Komma\KMS\Globalization\Language;

/**
 * Class QuestionCategory
 *
 * @package App\QuestionCategories\Models
 * @property-read \App\QuestionCategories\Models\QuestionCategoryTranslation $translation
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\QuestionCategories\Models\QuestionCategoryTranslation[] $translations
 * @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\QuestionCategories\Models\QuestionCategory whereActive($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\QuestionCategories\Models\QuestionCategory whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\QuestionCategories\Models\QuestionCategory whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\QuestionCategories\Models\QuestionCategory whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\QuestionCategories\Models\QuestionCategory newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\QuestionCategories\Models\QuestionCategory newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\QuestionCategories\Models\QuestionCategory query()
 */
final class QuestionCategory extends AbstractTranslatableModel implements DisplayNameInterface, TreeModelInterface
{
    use DisplayNameTrait;
    use TreeModelLogicTrait;

    protected $class = QuestionCategory::class;

    protected $protected = ['id', 'created_at', 'updated_at', 'site_id'];

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

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

    public function questions(): BelongsToMany
    {
        return $this->belongsToMany(Question::class, 'question_category_questions')
            ->where('active', '=', 1)
            ->withPivot('sort_order')
            ->orderBy('sort_order');
    }

    /**
     * Return a number, representing some color that represents
     * the status if the TreeModel. Used at the frontend
     *
     * @return mixed
     */
    public function getColorStatusNumber(): int
    {
        return $this->active ?: 0;
    }
}