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

namespace App\KommaApp\Magazines\Models;

use App\KommaApp\Documents\DocumentsTrait;
use App\KommaApp\Kms\Core\Entities\DisplayNameTrait;
use App\KommaApp\Documents\Kms\DocumentableInterface;
use App\KommaApp\Documents\Models\Document;
use App\KommaApp\Images\Models\Image;
use App\KommaApp\Kms\Core\AbstractTranslatableModel;
use App\KommaApp\Kms\Core\HasImagesInterface;
use App\KommaApp\Languages\Models\Language;
use App\KommaApp\MagazineArticles\Models\MagazineArticle;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\MorphMany;
use Illuminate\Support\Str;

/**
 * Class Magazine
 *
 * @package App\KommaApp\Magazines\Models
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\KommaApp\Images\Models\Image[] $images
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\KommaApp\Languages\Models\Language[] $languages
 * @property-read \App\KommaApp\Sites\Models\Site $site
 * @property-read \App\KommaApp\Magazines\Models\MagazineTranslation $translation
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\KommaApp\Magazines\Models\MagazineTranslation[] $translations
 * @mixin \Eloquent
 * @property int $id
 * @property int $site_id
 * @property int $active
 * @property int $preview
 * @property \Carbon\Carbon|null $date
 * @property \Carbon\Carbon|null $created_at
 * @property \Carbon\Carbon|null $updated_at
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Magazines\Models\Magazine whereActive($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Magazines\Models\Magazine wherePreview($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Magazines\Models\Magazine whereDate($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Magazines\Models\Magazine whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Magazines\Models\Magazine whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Magazines\Models\Magazine whereSiteId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Magazines\Models\Magazine whereUpdatedAt($value)
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\KommaApp\Documents\Models\Document[] $documents
 */
class Magazine extends AbstractTranslatableModel implements DocumentableInterface
{
    use DocumentsTrait;
    use DisplayNameTrait;

    protected $table = 'magazines';
    protected $class = Magazine::class;
    /*
    * Transient properties on Eloquent models
    * These are not saved to database.
    */
    public $thumbnail = false;
//    public $parent_id;

    protected $dates = ['date'];

    protected $fillable = ['site_id', 'active', 'preview', 'date'];

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

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

    public function magazineArticles(): BelongsToMany
    {
        return $this->belongsToMany(MagazineArticle::class, 'magazine_magazine_articles');
    }

    public function getSideBarName(): ?string
    {
        // If there is no name defined generate a generic name
        if(!$sideBarName = $this->getDisplayName()){
            $sideBarName = trans( 'kms/'.Str::camel($this->table).'.entity') . ' ' . $this->id;
        }

        $sideBarName .= '<br/><sub>' . $this->date->format('d-m-Y') . '</sub>';

        return $sideBarName;
    }
}