<?php


namespace App\Komma\Dynamic\Component;


use App\Komma\Documents\DocumentsTrait;
use App\Komma\Documents\Kms\DocumentableInterface;
use App\Komma\Dynamic\ComponentArea\ComponentArea;
use App\Komma\Dynamic\ComponentType\ComponentType;
use App\Komma\Kms\Core\Attributes\Attribute;
use App\Komma\Pages\Models\Page;
use App\Komma\References\Models\Reference;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\MorphToMany;
use Illuminate\Support\Collection;

/**
 * App\Komma\Dynamic\Component\Component
 *
 * @property int $id
 * @property int $component_type_id
 * @property int $component_area_id
 * @property int $sort_order
 * @property string $version
 * @property string $data
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @property-read \App\Komma\Dynamic\ComponentArea\ComponentArea $componentArea
 * @property-read \App\Komma\Dynamic\ComponentType\ComponentType $componentType
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Dynamic\Component\Component whereComponentAreaId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Dynamic\Component\Component whereComponentTypeId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Dynamic\Component\Component whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Dynamic\Component\Component whereData($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Dynamic\Component\Component whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Dynamic\Component\Component whereSortOrder($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Dynamic\Component\Component whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Dynamic\Component\Component whereVersion($value)
 * @mixin \Eloquent
 * @property int|null $linkable_id
 * @property string|null $linkable_type
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Documents\Models\Document[] $documents
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Documents\Models\Document[] $images
 * @property-read \Illuminate\Database\Eloquent\Model|\Eloquent $linkable
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Dynamic\Component\Component whereLinkableId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Dynamic\Component\Component whereLinkableType($value)
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Pages\Models\Page[] $pages
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Users\Models\User[] $users
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Dynamic\Component\Component newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Dynamic\Component\Component newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Dynamic\Component\Component query()
 */
class Component extends Model implements DocumentableInterface
{
    use DocumentsTrait;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = ['component_area_id', 'component_type_id', 'sort_order', 'version', 'data'];

    /**
     * @return BelongsTo
     */
    public function componentArea(): BelongsTo {
        return $this->belongsTo(ComponentArea::class);
    }

    /**
     * @return BelongsTo
     */
    public function componentType(): BelongsTo
    {
        return $this->belongsTo(ComponentType::class);
    }

    public function references(): MorphToMany
    {
        return $this->morphedByMany(Reference::class, 'componentable');
    }

    public function pages(): MorphToMany
    {
        return $this->morphedByMany(Page::class, 'componentable');
    }

    /**
     * Helper function which we call on site views
     * Attribute reference is the name of the attribute within the component
     * The method is usually getValue() but f.e. Documents uses a getValueForCollection()
     *
     * @param string $attributeKeyReference
     * @param string $attributeMethod
     * @return string|Collection
     */
    public function getValueFromAttribute(string $attributeKeyReference, string $attributeMethod = 'getValue')
    {
        // We're expecting a collection with Attributes
        if( ! is_a($this->data, Collection::class)) return '';

        /** @var Collection $collection */
        $collection = $this->data;

        /** @var Attribute $attribute */
        $attribute = $collection->get($attributeKeyReference);

        // Make sure the attribute method exists
        if( ! method_exists($attribute,$attributeMethod)) return '';

        // Return value by calling the method
        return $attribute->{$attributeMethod}();

    }
}