<?php

namespace App\Komma\Shop\Orders;

use App\Komma\Base\Enum;

final class OrderStatus extends Enum
{

    // TODO: Should we delete the not needed statuses ???

    const NEW = 0;                   // A freshly created order
    const PENDING = 1;               // Customer started the checkout process but did not complete it
    const AWAITING_PAYMENT = 2;      // customer has completed the checkout process, but payment has yet to be confirmed
    const AWAITING_FULFILLMENT = 3;  // customer has completed the checkout process and payment has been confirmed
    const AWAITING_SHIPMENT = 4;     // Order has been picked and packaged and is awaiting collection from a shipping provider
    const AWAITING_PICKUP = 5;       // Order has been packaged and is awaiting customer pickup from a seller-specified location
    const PARTIALLY_SHIPPED = 6;     // Only some items in the order have been shipped, due to some products being pre-order only or other reasons
    const COMPLETED = 7;             // The order has been shipped/picked up. And receipt is confirmed. An Authorize only transaction has been captured. client has paid for their digital product, and their file(s) are available for download.
    const SHIPPED = 8;               // Order has been shipped, but receipt has not been confirmed
    const CANCELED = 9;              // Seller has canceled an order, due to a stock inconsistency or other reasons
    const DECLINED = 10;             // Seller has marked the order as declined for lack of manual payment, or other reasons
    const REFUNDED = 11;             // Seller has refunded the order.
    const PARTIALLY_REFUNDED = 12;   // Seller has partially refunded the order.
    const DISPUTED = 13;             // Customer has initiated a dispute resolution process for the transaction.
    const VERIFICATION = 14;         // Order on hold while some aspect (e.g. tax-exempt documentation) needs to be manually confirmed
    const TESTING = 15;         // Order on hold while some aspect (e.g. tax-exempt documentation) needs to be manually confirmed
    const DEPOSIT_PAYMENT_SEND = 16;         // Order on hold while some aspect (e.g. tax-exempt documentation) needs to be manually confirmed

    public static function getOrderFilters()
    {
        return [
            self::AWAITING_FULFILLMENT,
            self::SHIPPED,
            self::VERIFICATION,
            self::DEPOSIT_PAYMENT_SEND,
            self::COMPLETED,
        ];
    }
}

//const NEW                       = 'new';                   //A freshly created order
//const PENDING                   = 'pending';               //Customer started the checkout process but did not complete it
//const AWAITING_PAYMENT          = 'awaiting_payment';      //customer has completed the checkout process, but payment has yet to be confirmed
//const AWAITING_FULFILLMENT      = 'awaiting_fulfillment';  //customer has completed the checkout process and payment has been confirmed
//const AWAITING_SHIPMENT         = 'awaiting_shipment';     //Order has been picked and packaged and is awaiting collection from a shipping provider
//const AWAITING_PICKUP           = 'awaiting_pickup';       //Order has been packaged and is awaiting customer pickup from a seller-specified location
//const PARTIALLY_SHIPPED         = 'partially_shipped';     //Only some items in the order have been shipped, due to some products being pre-order only or other reasons
//const COMPLETED                 = 'completed';             //The order has been shipped/picked up. And receipt is confirmed. An Authorize only transaction has been captured. client has paid for their digital product, and their file(s) are available for download.
//const SHIPPED                   = 'shipped';               //Order has been shipped, but receipt has not been confirmed
//const CANCELED                  = 'canceled';              //Seller has canceled an order, due to a stock inconsistency or other reasons
//const DECLINED                  = 'declined';              //Seller has marked the order as declined for lack of manual payment, or other reasons
//const REFUNDED                  = 'refunded';              //Seller has refunded the order.
//const PARTIALLY_REFUNDED        = 'partially_refunded';    //Seller has partially refunded the order.
//const DISPUTED                  = 'disputed';              //Customer has initiated a dispute resolution process for the transaction.
//const VERIFICATION              = 'verification';          //Order on hold while some aspect (e.g. tax-exempt documentation) needs to be manually confirmed