# woo-postnl/4.0.0/includes/compatibility/class-wc-order-compatibility.php

PostNL for WooCommerce, version 4.0.0. 399 lines.

- Page: https://pluginprobe.com/plugins/woo-postnl/4.0.0/code/includes/compatibility/class-wc-order-compatibility.php
- Raw: https://pluginprobe.com/plugins/woo-postnl/4.0.0/raw/includes/compatibility/class-wc-order-compatibility.php
- Modified: 2021-01-04T09:21:08+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/woo-postnl/4.0.0/code/includes/compatibility/class-wc-order-compatibility.php#L10-L20`.

```php
<?php
/**
 * Derived from SkyVerge WooCommerce Plugin Framework https://github.com/skyverge/wc-plugin-framework/
 */

namespace WPO\WC\PostNL\Compatibility;

use DateTimeZone;
use WC_Order;
use WC_Order_Item;
use WC_Order_Item_Coupon;
use WC_Order_Item_Fee;

if (!defined('ABSPATH')) {
    exit;
} // Exit if accessed directly

if (class_exists('\\WPO\\WC\\PostNL\\Compatibility\\Order')) {
    return;
}

/**
 * WooCommerce order compatibility class.
 *
 * @since 4.6.0-dev
 */
class Order extends Data
{

    /** @var array mapped compatibility properties, as `$new_prop => $old_prop` */
    protected static $compat_props = [
        'date_completed' => 'completed_date',
        'date_paid'      => 'paid_date',
        'date_modified'  => 'modified_date',
        'date_created'   => 'order_date',
        'customer_id'    => 'customer_user',
        'discount'       => 'cart_discount',
        'discount_tax'   => 'cart_discount_tax',
        'shipping_total' => 'total_shipping',
        'type'           => 'order_type',
        'currency'       => 'order_currency',
        'version'        => 'order_version',
    ];

    /**
     * Backports WC_Order::get_id() method to pre-2.6.0
     *
     * @param WC_Order $order order object
     *
     * @return string|int order ID
     * @since 4.2.0
     */
    public static function get_id($order)
    {
        if (method_exists($order, 'get_id')) {
            return $order->get_id();
        } else {
            return isset($order->id) ? $order->id : false;
        }
    }

    /**
     * Gets an order property.
     *
     * @param WC_Order $object  the order object
     * @param string   $prop    the property name
     * @param string   $context if 'view' then the value will be filtered
     *
     * @return mixed
     * @throws \Exception
     * @throws \Exception
     * @since 4.6.0-dev
     */
    public static function get_prop($object, $prop, $context = 'edit', $compat_props = [])
    {
        // backport a few specific properties to pre-3.0
        if (WC_Core::is_wc_version_lt_3_0()) {
            // converge the shipping total prop for the raw context
            if ('shipping_total' === $prop && 'view' !== $context) {
                $prop = 'order_shipping';
                // get the post_parent and bail early
            } elseif ('parent_id' === $prop) {
                return $object->post->post_parent;
            }
        }

        $value = parent::get_prop($object, $prop, $context, self::$compat_props);

        // 3.0+ date getters return a DateTime object, where previously MySQL date strings were returned
        if (WC_Core::is_wc_version_lt_3_0() && in_array($prop,
                                                        [
                                                            'date_completed',
                                                            'date_paid',
                                                            'date_modified',
                                                            'date_created',
                                                        ],
                                                        true
            )
            && !empty($value)) {
            if (is_numeric($value)) {
                $value = new WC_DateTime("@{$value}", new DateTimeZone('UTC'));
                $value->setTimezone(new DateTimeZone(wc_timezone_string()));
            } else {
                $value = new WC_DateTime($value, new DateTimeZone(wc_timezone_string()));
                $value->setTimezone(new DateTimeZone(wc_timezone_string()));
            }
        }

        return $value;
    }

    /**
     * Sets an order's properties.
     * Note that this does not save any data to the database.
     *
     * @param WC_Order $object the order object
     * @param array    $props  the new properties as $key => $value
     *
     * @return WC_Order
     * @since 4.6.0-dev
     */
    public static function set_props($object, $props, $compat_props = [])
    {
        return parent::set_props($object, $props, self::$compat_props);
    }

    /**
     * Backports WC_Order::set_address_prop() to pre-3.0
     * Saves by default.
     *
     * @param WC_Order $order   the order object
     * @param string   $prop    Name of prop to set.
     * @param string   $address Name of address to set. billing or shipping.
     * @param mixed    $value   Value of the prop.
     * @param bool     $save    whether to save the order/property
     *
     * @return WC_Order
     * @since 4.6.0-dev
     */
    public static function set_address_prop(WC_Order $order, $prop, $address = 'billing', $value, $save = true)
    {
        if (WC_Core::is_wc_version_gte_3_0()) {
            if (is_callable([$order, "set_{$address}_{$prop}"])) {
                $order->{"set_{$address}_{$prop}"}($value);
                if ($save === true) {
                    $order->save();
                }
            }
        } else {
            // wc 2.6 or older
            if ($save === true) {
                // store directly in postmeta
                update_post_meta($order->id, "_{$address}_{$prop}", $value);
            } else {
                // only change property in the order
                $order->$prop = $value;
            }
        }

        return $order;
    }

    /**
     * Implements WC_Order::get_item_meta for 3.0+
     *
     * @param        $object
     * @param int    $item_id the item id
     * @param string $key     the meta key
     * @param bool   $single  single or multiple
     *
     * @return mixed            item meta
     * @throws \Exception
     * @throws \Exception
     */
    public static function get_item_meta($object, $item_id, $key = '', $single = false)
    {
        if (function_exists('wc_get_order_item_meta')) {
            $item_meta = wc_get_order_item_meta($item_id, $key, $single);
        } else {
            $item_meta = $object->get_item_meta($item_id, $key, $single);
        }
        return $item_meta;
    }

    /**
     * Backports WC_Order::get_status() to pre-3.0.0
     *
     * @param WC_Order $order the order object
     *
     * @return string order status
     * @since 4.6.0-dev
     */
    public static function get_status(WC_Order $order)
    {
        if (method_exists($order, 'get_status')) {
            return $order->get_status();
        } else {
            return $order->status;
        }
    }

    /**
     * Order item CRUD compatibility method to add a coupon to an order.
     *
     * @param WC_Order $order        the order object
     * @param array    $code         the coupon code
     * @param int      $discount     the discount amount.
     * @param int      $discount_tax the discount tax amount.
     *
     * @return int the order item ID
     * @throws \WC_Data_Exception
     * @since 4.6.0-dev
     */
    public static function add_coupon(WC_Order $order, $code = [], $discount = 0, $discount_tax = 0)
    {
        if (WC_Core::is_wc_version_gte_3_0()) {
            $item = new WC_Order_Item_Coupon();

            $item->set_props(
                [
                    'code'         => $code,
                    'discount'     => $discount,
                    'discount_tax' => $discount_tax,
                    'order_id'     => $order->get_id(),
                ]
            );

            $item->save();

            $order->add_item($item);

            return $item->get_id();
        } else {
            return $order->add_coupon($code, $discount, $discount_tax);
        }
    }

    /**
     * Order item CRUD compatibility method to add a fee to an order.
     *
     * @param WC_Order $order the order object
     * @param object   $fee   the fee to add
     *
     * @return int|WC_Order_Item the order item ID
     * @throws \WC_Data_Exception
     * @since 4.6.0-dev
     */
    public static function add_fee(WC_Order $order, $fee)
    {
        if (WC_Core::is_wc_version_gte_3_0()) {
            $item = new WC_Order_Item_Fee();

            $item->set_props(
                [
                    'name'      => $fee->name,
                    'tax_class' => $fee->taxable ? $fee->tax_class : 0,
                    'total'     => $fee->amount,
                    'total_tax' => $fee->tax,
                    'taxes'     => [
                        'total' => $fee->tax_data,
                    ],
                    'order_id'  => $order->get_id(),
                ]
            );

            $item->save();

            $order->add_item($item);

            return $item->get_id();
        } else {
            return $order->add_fee($fee);
        }
    }

    /**
     * Order item CRUD compatibility method to update an order coupon.
     *
     * @param WC_Order          $order        the order object
     * @param int|WC_Order_Item $item         the order item ID
     * @param array             $args         {
     *                                        The coupon item args.
     *
     * @type string             $code         the coupon code
     * @type float              $discount     the coupon discount amount
     * @type float              $discount_tax the coupon discount tax amount
     * }
     * @return int|bool the order item ID or false on failure
     * @throws \WC_Data_Exception
     * @since 4.6.0-dev
     */
    public static function update_coupon(WC_Order $order, $item, $args)
    {
        if (WC_Core::is_wc_version_gte_3_0()) {
            if (is_numeric($item)) {
                $item = $order->get_item($item);
            }

            if (!is_object($item) || !$item->is_type('coupon')) {
                return false;
            }

            if (!$order->get_id()) {
                $order->save();
            }

            $item->set_order_id($order->get_id());
            $item->set_props($args);
            $item->save();

            return $item->get_id();
        } else {
            // convert 3.0+ args for backwards compatibility
            if (isset($args['discount'])) {
                $args['discount_amount'] = $args['discount'];
            }
            if (isset($args['discount_tax'])) {
                $args['discount_amount_tax'] = $args['discount_tax'];
            }

            return $order->update_coupon($item, $args);
        }
    }

    /**
     * Order item CRUD compatibility method to update an order fee.
     *
     * @param WC_Order $order      the order object
     * @param int      $item       the order item ID
     * @param array    $args       {
     *                             The fee item args.
     *
     * @type string    $name       the fee name
     * @type string    $tax_class  the fee's tax class
     * @type float     $line_total the fee total amount
     * @type float     $line_tax   the fee tax amount
     * }
     * @return int|bool the order item ID or false on failure
     * @throws \WC_Data_Exception
     * @since 4.6.0-dev
     */
    public static function update_fee(WC_Order $order, $item, $args)
    {
        if (WC_Core::is_wc_version_gte_3_0()) {
            if (is_numeric($item)) {
                $item = $order->get_item($item);
            }

            if (!is_object($item) || !$item->is_type('fee')) {
                return false;
            }

            if (!$order->get_id()) {
                $order->save();
            }

            $item->set_order_id($order->get_id());
            $item->set_props($args);
            $item->save();

            return $item->get_id();
        } else {
            return $order->update_fee($item, $args);
        }
    }

    /**
     * Backports wc_reduce_stock_levels() to pre-3.0.0
     *
     * @param WC_Order $order the order object
     *
     * @since 4.6.0-dev
     */
    public static function reduce_stock_levels(WC_Order $order)
    {
        if (WC_Core::is_wc_version_gte_3_0()) {
            wc_reduce_stock_levels($order->get_id());
        } else {
            $order->reduce_order_stock();
        }
    }

    /**
     * Backports wc_update_total_sales_counts() to pre-3.0.0
     *
     * @param WC_Order $order the order object
     *
     * @since 4.6.0-dev
     */
    public static function update_total_sales_counts(WC_Order $order)
    {
        if (WC_Core::is_wc_version_gte_3_0()) {
            wc_update_total_sales_counts($order->get_id());
        } else {
            $order->record_product_sales();
        }
    }
}

```