<?php

namespace App\KommaApp\Shop\Orders\ProductGroup;

use App\KommaApp\Shop\Orders\Models\Order;
use App\KommaApp\Shop\Orders\Product\OrderedProduct;
use App\KommaApp\Shop\Orders\ProductComposite\OrderedProductComposite;
use App\KommaApp\Shop\Products\Product\Product;
use App\KommaApp\Shop\Products\ProductComposite\ProductComposite;
use App\KommaApp\Shop\Products\ProductGroup\ProductGroup;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;

/**
 * Groups products together (not like a product category)
 * to link behaviour.
 * 
 * Class ProductGroup
 *
 * @package App
 * @property int $id
 * @property int $order_id
 * @property int $product_group_id
 * @property int $ordered_product_group_behaviour_id
 * @property int $active
 * @property string $title
 * @property int $quantity
 * @property string $discount Applied discount information. Example: 10% + 1 for free. Product group level only
 * @property \Carbon\Carbon|null $created_at
 * @property \Carbon\Carbon|null $updated_at
 * @property-read mixed $price
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\KommaApp\Shop\Products\ProductComposite\ProductComposite[] $composites
 * @property-read \App\KommaApp\Shop\Orders\Models\Order $order
 * @property-read \App\KommaApp\Shop\Products\ProductGroup\ProductGroup $productGroup
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\KommaApp\Shop\Orders\ProductComposite\OrderedProductComposite[] $orderedComposites
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\KommaApp\Shop\Orders\Product\OrderedProduct[] $orderedProducts
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\KommaApp\Shop\Products\Product\Product[] $products
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Shop\Orders\ProductGroup\OrderedProductGroup whereActive($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Shop\Orders\ProductGroup\OrderedProductGroup whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Shop\Orders\ProductGroup\OrderedProductGroup whereDiscount($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Shop\Orders\ProductGroup\OrderedProductGroup whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Shop\Orders\ProductGroup\OrderedProductGroup whereOrderId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Shop\Orders\ProductGroup\OrderedProductGroup whereOrderedProductGroupBehaviourId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Shop\Orders\ProductGroup\OrderedProductGroup whereProductGroupId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Shop\Orders\ProductGroup\OrderedProductGroup whereTitle($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Shop\Orders\ProductGroup\OrderedProductGroup whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\KommaApp\Shop\Orders\ProductGroup\OrderedProductGroup whereQuantity($value)
 * @mixin \Eloquent
 */
class OrderedProductGroup extends Model
{
    /*
    * Transient properties on Eloquent models
    * These are not saved to database.
    */
    public $thumbnail = false;

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

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

    public function orderedProducts()
    {
        return $this->belongsToMany(OrderedProduct::class);
    }

    public function products()
    {
        return $this->belongsToMany(Product::class);
    }

    public function orderedComposites()
    {
        return $this->belongsToMany(OrderedProductComposite::class);
    }

    public function composites()
    {
        return $this->belongsToMany(ProductComposite::class);
    }

    public function getPriceAttribute($value)
    {
        if($this->orderedProducts()->count() == 0) return 0;
        return $this->orderedProducts()->sum('price');
    }

    /**
     * Return the order
     *
     * @return BelongsTo
     */
    public function order():BelongsTo
    {
        return $this->belongsTo(Order::class);
    }
}