<?php
namespace App\Komma\Shop\Orders\Models;

use App\Komma\Kms\Core\Attributes\Models\Traits\HasThumbnailInterface;
use App\Komma\Kms\Core\Attributes\Models\Traits\HasThumbnailTrait;
use App\Komma\Kms\Core\Entities\DisplayNameInterface;
use App\Komma\Kms\Core\Entities\DisplayNameTrait;
use App\Komma\Shop\Orders\Product\OrderedProduct;
use App\Komma\Shop\Orders\ProductComposite\OrderedProductComposite;
use App\Komma\Shop\Orders\ProductGroup\OrderedProductGroup;
use App\Komma\Shop\Payment\Transaction;
use App\Komma\Shop\Shipments\Shipment;
use App\Komma\Users\Models\SiteUser;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;


/**
 * App\Komma\Shop\Orders\Models\Order
 *
 * @property int $id
 * @property string $order_number
 * @property int $user_id
 * @property string $status
 * @property int $total_price
 * @property string $discount Discount info for the order (not its products) only.
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @property-read \App\Komma\Users\Models\KmsUser $customer
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Shop\Orders\ProductComposite\OrderedProductComposite[] $orderedProductComposites
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Shop\Orders\ProductGroup\OrderedProductGroup[] $orderedProductGroups
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Shop\Orders\Product\OrderedProduct[] $orderedProducts
 * @property-write mixed $customer_info
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Shop\Payment\Transaction[] $transactions
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order query()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereDiscount($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereInvoiceAddressId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereShippingAddressId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereStatus($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereTotalPrice($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereUserId($value)
 * @mixin \Eloquent
 * @property int $invoice_address_id
 * @property int $shipping_address_id
 * @property string $invoice_street
 * @property string $invoice_house_number
 * @property string $invoice_postal_code
 * @property string $invoice_city
 * @property string $invoice_telephone
 * @property string $invoice_country
 * @property string $shipping_street
 * @property string $shipping_house_number
 * @property string $shipping_postal_code
 * @property string $shipping_city
 * @property string $shipping_telephone
 * @property string $shipping_country
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Komma\Shop\Shipments\Shipment[] $shipments
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereInvoiceCity($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereInvoiceCountry($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereInvoiceHouseNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereInvoicePostalCode($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereInvoiceStreet($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereInvoiceTelephone($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereOrderNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereShippingCity($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereShippingCountry($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereShippingHouseNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereShippingPostalCode($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereShippingStreet($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Komma\Shop\Orders\Models\Order whereShippingTelephone($value)
 */
class Order extends Model implements HasThumbnailInterface, DisplayNameInterface
{
    protected $name = '';
    use DisplayNameTrait;
    use HasThumbnailTrait;

    public function __construct(array $attributes = [])
    {
        $this->name = __('shop/orders.order');
        parent::__construct($attributes);
    }

    /*
    * Transient properties on Eloquent models
    * These are not saved to database.
    */
    protected $class = Order::class;

    /**
     * Mutates the customer_info attribute
     * @param SiteUser $user
     */
    public function setCustomerInfoAttribute($user)
    {
        if(is_numeric($user)) {
            $user = SiteUser::find($user);
            if(!$user) return;
        }

        $formatted  = __('kms/site_users.first_name').': '.$user->first_name.PHP_EOL;
        $formatted .= __('kms/site_users.last_name').': '.$user->last_name.PHP_EOL;
        $formatted .= __('kms/site_users.email').': '.$user->email.PHP_EOL;
        $formatted .= ''.PHP_EOL;
        $formatted .= __('shop/orders.invoice_address').':'.PHP_EOL;
        $formatted .= $user->street.' '.$user->house_number.', '.$user->zip_code.', '.$user->city.', '.$user->country.PHP_EOL;

        $this->attributes['customer_info'] = $formatted;
    }

    public function customer(): BelongsTo
    {
        return $this->belongsTo(SiteUser::class, 'site_user_id');
    }

    /**
     * Get the products related to this category
     */
    public function orderedProducts():HasMany
        {
        return $this->HasMany(OrderedProduct::class);
    }

    /**
     * Get the products related to this category
     */
    public function orderedProductGroups():HasMany
    {
        return $this->HasMany(OrderedProductGroup::class);
    }

    /**
     * Get the products related to this category
     */
    public function orderedProductComposites():HasMany
    {
        return $this->HasMany(OrderedProductComposite::class);
    }

    /**
     * Returns all the shipping address attributes and their values
     *
     * @return array
     */
    public function getShippingAddressAttributes()
    {
        $attributeNames = ['shipping_street', 'shipping_house_number', 'shipping_postal_code', 'shipping_city', 'shipping_telephone', 'shipping_country'];
        $attributes = [];
        foreach($attributeNames as $attributeName) $attributes[$attributeName] = $this->getAttribute($attributeName);
        return $attributes;
    }

    /**
     * Returns all the invoice address attributes and their values
     *
     * @return array
     */
    public function getInvoiceAddressAttributes()
    {
        $attributeNames = ['invoice_street', 'invoice_house_number', 'invoice_postal_code', 'invoice_city', 'invoice_telephone', 'invoice_country'];
        $attributes = [];
        foreach($attributeNames as $attributeName) $attributes[$attributeName] = $this->getAttribute($attributeName);

        return $attributes;
    }

    /**
     * Returns the payment transactions for the order.
     * Like successful, canceled, refunded payments
     *
     * @return HasMany
     */
    public function transactions(): HasMany
    {
        return $this->hasMany(Transaction::class);
    }

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

    public function __get($key)
    {
        if($key == 'name' && isset($this->attributes['id'])) return ucfirst(__('shop/orders.order')).' '.$this->attributes['id'];
        return parent::__get($key);
    }
}