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

namespace App\Komma\Categories\Models;

use App\Komma\Courses\Models\Course;
use App\Komma\Globalization\Languages\Models\Language;
use App\Komma\Kms\Core\AbstractTranslatableModel;
use App\Komma\Kms\Core\Attributes\Models\Traits\HasThumbnailInterface;
use App\Komma\Kms\Core\Attributes\Models\Traits\HasThumbnailTrait;
use App\Komma\Kms\Core\Entities\DisplayNameInterface;
use App\Komma\Kms\Core\Entities\DisplayNameTrait;
use App\Komma\MonthlyMustHaves\Models\MonthlyMustHave;
use App\Komma\Posts\Models\Post;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasMany;

/**
 * Class Page
 *
 * @package App\Komma\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\Komma\Languages\Models\Language[] $languages
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Sites\Models\Site[] $sites
 * @property-read \App\Komma\Categories\Models\CategoryTranslation $translation
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Categories\Models\CategoryTranslation[] $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\Komma\Categories\Models\Category whereActive($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Categories\Models\Category whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Categories\Models\Category whereDate($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Categories\Models\Category whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Categories\Models\Category whereUpdatedAt($value)
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Documents\Models\Document[] $documents
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Documents\Models\Document[] $images
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Categories\Models\Category newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Categories\Models\Category newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Categories\Models\Category query()
 */
final class Category extends AbstractTranslatableModel implements DisplayNameInterface, HasThumbnailInterface
{
    use HasThumbnailTrait;
    use DisplayNameTrait;

    protected $table = 'categories';
    protected $class = Category::class;

    public function posts()
    {
        return $this->morphedByMany(Post::class, 'categorable');
    }

    public function monthlyMustHaves()
    {
        return $this->morphedByMany(MonthlyMustHave::class, 'categorable');
    }

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

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