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

namespace App\KommaApp\Courses\Models;

use App\KommaApp\Images\Models\Image;
use App\KommaApp\Kms\Core\AbstractTranslatableModel;
use App\KommaApp\Languages\Models\Language;
use App\KommaApp\Sites\Models\Site;
use App\KommaApp\Subscriptions\Models\Subscription;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasMany;

/**
 * Class Course
 *
 * @package App\KommaApp\Courses\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 \Illuminate\Database\Eloquent\Collection|\App\KommaApp\Courses\Models\CourseTranslation[] $translations
 * @mixin \Eloquent
 * @property int $id
 * @property int $site_id
 * @property int $active
 * @property string|null $code_name
 * @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\KommaApp\Courses\Models\Course whereActive($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Courses\Models\Course whereCodeName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Courses\Models\Course whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Courses\Models\Course whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Courses\Models\Course whereLft($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Courses\Models\Course whereRgt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Courses\Models\Course whereSiteId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Courses\Models\Course whereTree($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Courses\Models\Course whereUpdatedAt($value)
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\KommaApp\Documents\Models\Document[] $documents
 * @property string $name
 * @property string $description
 * @property-read \App\KommaApp\Courses\Models\CourseTranslation $translation
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Courses\Models\Course newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Courses\Models\Course newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Courses\Models\Course query()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Courses\Models\Course whereDescription($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Courses\Models\Course whereName($value)
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\KommaApp\Subscriptions\Models\Subscription[] $subscriptions
 */
class Course extends AbstractTranslatableModel
{
    protected $table = 'courses';
    protected $class = Course::class;
    /*
    * Transient properties on Eloquent models
    * These are not saved to database.
    */
    public $thumbnail = false;
//    public $parent_id;


    protected $fillable = ['name', 'description'];

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

    public function site(): BelongsTo
    {
        return $this->belongsTo(Site::class);
    }

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

    public function subscriptions(): BelongsToMany {
        return $this->belongsToMany(Subscription::class)->withTimestamps();
    }

    /**
     * Get the images from the current user
     *
     * @return \Illuminate\Database\Eloquent\Relations\hasMany
     */
    public function images(): HasMany
    {
        /**
         *
         * On the Image model is an MorphTo relation
         * By using a hasMany relation:
         * where the imageable_type is filled in with the KmsClass
         * And the imageable_id is set as the foreign_id,
         * we can collect the images of the given model directly.
         *
         */
        return $this->hasMany(Image::class, 'imageable_id')
            ->where('imageable_type', '=', $this->class);
    }

    public function __get($key)
    {
        if($key == "title") {
            if($this->translation) {
                return $this->translation->name;
            }
        }

        return parent::__get($key);
    }
}