<?php

namespace App\Products\Product;

use App\Products\AbstractProductable;
use App\Products\ProductableEnum;
use App\Properties\Models\PropertizableInterface;
use App\Properties\Models\PropertizableTrait;
use Komma\KMS\Documents\DocumentsTrait;
use Komma\KMS\Documents\Kms\DocumentableInterface;
use Komma\KMS\Core\Entities\DisplayNameInterface;
use Komma\KMS\Core\Entities\HasSearchableAttributesForSidebarInterface;
use App\Categories\Kms\CategorizableInterface;
use App\Discounts\DiscountableInterface;
use App\Discounts\Discount;
use App\Products\ProductGroup\ProductGroup;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Laravel\Scout\Searchable;

/**
 * App\Products\Product\Product
 *
 * @property int $id
 * @property int $active
 * @property int $price Price is either inc or ex vat.
 * @property string $vat_scenario_enum See vat enum
 * @property string $stock_keeping_unit
 * @property int $stock
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Categories\Models\Category[] $categories
 * @property-read int|null $categories_count
 * @property-read \Illuminate\Database\Eloquent\Collection|\Komma\KMS\Documents\Models\Document[] $documents
 * @property-read int|null $documents_count
 * @property-read \Illuminate\Database\Eloquent\Collection|ProductGroup[] $groups
 * @property-read int|null $groups_count
 * @property-read \Illuminate\Database\Eloquent\Collection|\Komma\KMS\Documents\Models\Document[] $images
 * @property-read int|null $images_count
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Properties\Models\Property[] $properties
 * @property-read int|null $properties_count
 * @property-read \Illuminate\Database\Eloquent\Collection|\Komma\KMS\Sites\Models\Site[] $sites
 * @property-read int|null $sites_count
 * @property-read \App\Products\Product\ProductTranslation|null $translation
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Products\Product\ProductTranslation[] $translations
 * @property-read int|null $translations_count
 * @method static \Illuminate\Database\Eloquent\Builder|Product newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|Product newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|Product query()
 * @method static \Illuminate\Database\Eloquent\Builder|Product whereActive($value)
 * @method static \Illuminate\Database\Eloquent\Builder|Product whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|Product whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|Product wherePrice($value)
 * @method static \Illuminate\Database\Eloquent\Builder|Product whereStock($value)
 * @method static \Illuminate\Database\Eloquent\Builder|Product whereStockKeepingUnit($value)
 * @method static \Illuminate\Database\Eloquent\Builder|Product whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|Product whereVatScenarioEnum($value)
 * @mixin \Eloquent
 */
class Product extends AbstractProductable implements CategorizableInterface, DocumentableInterface, DisplayNameInterface, HasSearchableAttributesForSidebarInterface, PropertizableInterface
{
    use Searchable;
    use DocumentsTrait;
    use PropertizableTrait;

    public function searchableAs()
    {
        return 'products_index';
    }

    public function toSearchableArray()
    {
        return [
            'id' => $this->id,
            'stock_keeping_unit' => $this->stock_keeping_unit
        ];
    }

    /**
     * Returns an array containing model attributes with their values,
     * that will be used to search trough in the sidebar.
     *
     * @return array
     */
    public function searchableAttributesForSidebar(): array
    {
        return [
            'stock_keeping_unit' => $this->stock_keeping_unit
        ];
    }

    /** @var Discount[] $discounts  */
    private $discounts = [];

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = ['active', 'price', 'stock_keeping_unit', 'vat_scenario_enum', 'stock'];

    public function groups()
    {
        return $this->belongsToMany(ProductGroup::class);
    }

    /**
     * @return HasMany
     */
    public function translations(): HasMany
    {
        return $this->hasMany(ProductTranslation::class);
    }

    /**
     * Price is in cents
     *
     * @return float
     */
    public function getTotal(): float
    {
        return $this->price;
    }

    /**
     * Applies the discount to itself
     *
     * @param Discount $discount
     * @return DiscountableInterface
     */
    public function applyDiscount(Discount $discount): DiscountableInterface
    {
        $this->discounts = [];
    }

    /**
     * Returns the price of the product
     *
     * @return float
     */
    public function getPrice(): float
    {
        return $this->price;
    }

    /**
     * @return int
     */
    public function enum(): int
    {
        return ProductableEnum::PRODUCT;
    }
}