nshop/packages/Webkul/BagistoApi/src/Models/CustomerOrderItem.php

<?php

namespace Webkul\BagistoApi\Models;

use ApiPlatform\Metadata\ApiProperty;
use ApiPlatform\Metadata\ApiResource;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\HasOne;
use Illuminate\Database\Eloquent\Relations\MorphTo;

/**
 * Customer Order Item — nested API resource (no standalone endpoints).
 *
 * Exposed only as a relationship of CustomerOrder.
 * Points to the `order_items` table with explicit field casts.
 */
#[ApiResource(
    shortName: 'CustomerOrderItem',
    operations: [],
    graphQlOperations: [],
    normalizationContext: ['attributes' => ['id','qty_ordered', 'qty_shipped', 'qty_invoiced', 'qty_canceled', 'qty_refunded', 'sku', 'name', 'price', 'base_price', 'total', 'base_total', 'type', 'product', 'children']],
)]
class CustomerOrderItem extends Model
{
    /** @var string */
    protected $table = 'order_items';

    /** @var array */
    protected $appends = ['qtyOrdered', 'qtyShipped', 'qtyInvoiced', 'qtyCanceled', 'qtyRefunded'];

    /** @var array */
    protected $casts = [
        'id'                        => 'int',
        'sku'                       => 'string',
        'type'                      => 'string',
        'name'                      => 'string',
        'coupon_code'               => 'string',
        'weight'                    => 'float',
        'total_weight'              => 'float',
        'qty_ordered'               => 'int',
        'qty_shipped'               => 'int',
        'qty_invoiced'              => 'int',
        'qty_canceled'              => 'int',
        'qty_refunded'              => 'int',
        'price'                     => 'float',
        'base_price'                => 'float',
        'total'                     => 'float',
        'base_total'                => 'float',
        'total_invoiced'            => 'float',
        'base_total_invoiced'       => 'float',
        'amount_refunded'           => 'float',
        'base_amount_refunded'      => 'float',
        'discount_percent'          => 'float',
        'discount_amount'           => 'float',
        'base_discount_amount'      => 'float',
        'discount_invoiced'         => 'float',
        'base_discount_invoiced'    => 'float',
        'discount_refunded'         => 'float',
        'base_discount_refunded'    => 'float',
        'tax_percent'               => 'float',
        'tax_amount'                => 'float',
        'base_tax_amount'           => 'float',
        'tax_amount_invoiced'       => 'float',
        'base_tax_amount_invoiced'  => 'float',
        'tax_amount_refunded'       => 'float',
        'base_tax_amount_refunded'  => 'float',
        'price_incl_tax'            => 'float',
        'base_price_incl_tax'       => 'float',
        'total_incl_tax'            => 'float',
        'base_total_incl_tax'       => 'float',
        'product_id'                => 'int',
        'product_type'              => 'string',
        'order_id'                  => 'int',
        'tax_category_id'           => 'int',
        'parent_id'                 => 'int',
        'created_at'                => 'datetime',
        'updated_at'                => 'datetime',
    ];

    /**
     * API Platform identifier
     */
    #[ApiProperty(identifier: true, writable: false)]
    public function getId(): int
    {
        return $this->id;
    }

    #[ApiProperty(writable: false)]
    public function getSku(): ?string
    {
        return $this->sku;
    }

    #[ApiProperty(writable: false)]
    public function getName(): ?string
    {
        return $this->name;
    }

    #[ApiProperty(writable: false)]
    public function getQtyOrdered(): ?int
    {
        return $this->qty_ordered;
    }

    #[ApiProperty(writable: false)]
    public function getQtyShipped(): ?int
    {
        return $this->qty_shipped;
    }

    #[ApiProperty(writable: false)]
    public function getQtyInvoiced(): ?int
    {
        return $this->qty_invoiced;
    }

    #[ApiProperty(writable: false)]
    public function getQtyCanceled(): ?int
    {
        return $this->qty_canceled;
    }

    #[ApiProperty(writable: false)]
    public function getQtyRefunded(): ?int
    {
        return $this->qty_refunded;
    }

    #[ApiProperty(writable: false)]
    public function getType(): ?string
    {
        return $this->type;
    }

    #[ApiProperty(writable: false)]
    public function getPrice(): ?float
    {
        return $this->price;
    }

    #[ApiProperty(writable: false)]
    public function getBasePrice(): ?float
    {
        return $this->base_price;
    }

    #[ApiProperty(writable: false)]
    public function getTotal(): ?float
    {
        return $this->total;
    }

    #[ApiProperty(writable: false)]
    public function getBaseTotal(): ?float
    {
        return $this->base_total;
    }

    /**
     * Polymorphic product relationship.
     *
     * Mirrors OrderItem::product() — uses the order_items table's
     * product_id and product_type columns. The BagistoApi Product model
     * overrides getMorphClass() to return the base class name so that
     * MorphTo resolution works seamlessly.
     */
    public function product(): MorphTo
    {
        return $this->morphTo();
    }

    /**
     * Get the child item record associated with the order item.
     */
    public function child(): HasOne
    {
        return $this->hasOne(static::class, 'parent_id');
    }

    /**
     * Get the parent item record associated with the order item.
     */
    public function parent(): BelongsTo
    {
        return $this->belongsTo(static::class, 'parent_id');
    }

    /**
     * Get the children items (configurable product variants).
     */
    public function children(): HasMany
    {
        return $this->hasMany(static::class, 'parent_id');
    }

    /**
     * Override toArray to ensure qty fields are always included in serialization
     */
    public function toArray(): array
    {
        $array = parent::toArray();

        // Ensure qty fields are always present
        $array['qty_ordered'] = $this->qty_ordered;
        $array['qty_shipped'] = $this->qty_shipped;
        $array['qty_invoiced'] = $this->qty_invoiced;
        $array['qty_canceled'] = $this->qty_canceled;
        $array['qty_refunded'] = $this->qty_refunded;

        return $array;
    }
}