WC_Abstract_Legacy_Order

Complexity

Total Complexity

53

Size/Duplication

Total Lines	300
Duplicated Lines	7 %

Coupling/Cohesion

Components	1
Dependencies	3

17 Methods

Rating	Name	Duplication	Size	Complexity
A	set_address()	0	8	3
C	set_total()	0	40	8
A	__isset()	0	5	3
C	__get()	0	71	21
A	get_item_meta()	0	4	1
A	get_item_meta_array()	0	5	1
A	expand_item_meta()	0	4	1
A	init()	10	10	4
A	get_order()	11	11	3
A	populate()	0	4	1
A	cancel_order()	0	5	1
A	record_product_sales()	0	4	1
A	increase_coupon_usage_counts()	0	4	1
A	decrease_coupon_usage_counts()	0	4	1
A	reduce_order_stock()	0	4	1
A	send_stock_notifications()	0	3	1
A	email_order_items_table()	0	3	1

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 18 and the first side effect is on line 3.

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Legacy Abstract Order
 *
 * Legacy and deprecated functions are here to keep the WC_Abstract_Order clean.
 * This class will be removed in future versions.
 *
 * @class       WC_Abstract_Order
 * @version     2.6.0
 * @package     WooCommerce/Classes
 * @category    Class
 * @author      WooThemes
 */
abstract class WC_Abstract_Legacy_Order {

    /**
     * Set the customer address.
     * @since 2.2.0
     * @param array $address Address data.
     * @param string $type billing or shipping.
     */
    public function set_address( $address, $type = 'billing' ) {
        foreach ( $address as $key => $value ) {
            update_post_meta( $this->get_id(), "_{$type}_" . $key, $value );
            if ( is_callable( array( $this, "set_{$type}_{$key}" ) ) ) {
                $this->{"set_{$type}_{$key}"}( $value );
            }
        }
    }

    /**
     * Set an order total.
     * @since 2.2.0
     * @param float $amount
     * @param string $total_type
     * @return bool
     */
    public function set_total( $amount, $total_type = 'total' ) {
        if ( ! in_array( $total_type, array( 'shipping', 'tax', 'shipping_tax', 'total', 'cart_discount', 'cart_discount_tax' ) ) ) {
            return false;
        }

        switch ( $total_type ) {
            case 'total' :
                $amount = wc_format_decimal( $amount, wc_get_price_decimals() );
                $this->set_order_total( $amount );
                update_post_meta( $this->get_id(), '_order_total', $amount );
                break;
            case 'cart_discount' :
                $amount = wc_format_decimal( $amount );
                $this->set_discount_total( $amount );
                update_post_meta( $this->get_id(), '_cart_discount', $amount );
                break;
            case 'cart_discount_tax' :
                $amount = wc_format_decimal( $amount );
                $this->set_discount_tax( $amount );
                update_post_meta( $this->get_id(), '_cart_discount_tax', $amount );
                break;
            case 'shipping' :
                $amount = wc_format_decimal( $amount );
                $this->set_shipping_total( $amount );
                update_post_meta( $this->get_id(), '_order_shipping', $amount );
                break;
            case 'shipping_tax' :
                $amount = wc_format_decimal( $amount );
                $this->set_shipping_tax( $amount );
                update_post_meta( $this->get_id(), '_order_shipping_tax', $amount );
                break;
            case 'tax' :
                $amount = wc_format_decimal( $amount );
                $this->set_cart_tax( $amount );
                update_post_meta( $this->get_id(), '_order_tax', $amount );
                break;
        }

        return true;
    }

    /**
     * Magic __isset method for backwards compatibility.
     * @param string $key
     * @return bool
     */
    public function __isset( $key ) {
        // Legacy properties which could be accessed directly in the past.
        $legacy_props = array( 'completed_date', 'id', 'order_type', 'post', 'status', 'post_status', 'customer_note', 'customer_message', 'user_id', 'customer_user', 'prices_include_tax', 'tax_display_cart', 'display_totals_ex_tax', 'display_cart_ex_tax', 'order_date', 'modified_date', 'cart_discount', 'cart_discount_tax', 'order_shipping', 'order_shipping_tax', 'order_total', 'order_tax', 'billing_first_name', 'billing_last_name', 'billing_company', 'billing_address_1', 'billing_address_2', 'billing_city', 'billing_state', 'billing_postcode', 'billing_country', 'billing_phone', 'billing_email', 'shipping_first_name', 'shipping_last_name', 'shipping_company', 'shipping_address_1', 'shipping_address_2', 'shipping_city', 'shipping_state', 'shipping_postcode', 'shipping_country', 'customer_ip_address', 'customer_user_agent', 'payment_method_title', 'payment_method', 'order_currency' );
        return $this->get_id() ? ( in_array( $key, $legacy_props ) || metadata_exists( 'post', $this->get_id(), '_' . $key ) ) : false;
    }

    /**
     * Magic __get method for backwards compatibility.
     * @param string $key
     * @return mixed
     */
    public function __get( $key ) {
        /**
         * Maps legacy vars to new getters.
         */
        if ( 'completed_date' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
            return $this->get_date_completed();
		} elseif ( 'paid_date' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
            return $this->get_date_paid();
        } elseif ( 'modified_date' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
            return $this->get_date_modified();
        } elseif ( 'order_date' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
            return $this->get_date_created();
        } elseif ( 'id' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
            return $this->get_id();
		} elseif ( 'post' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
            return get_post( $this->get_id() );
		} elseif ( 'status' === $key || 'post_status' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
            return $this->get_status();
		} elseif ( 'customer_message' === $key || 'customer_note' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
            return $this->get_customer_note();
		} elseif ( in_array( $key, array( 'user_id', 'customer_user' ) ) ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
            return $this->get_customer_id();
		} elseif ( 'tax_display_cart' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
			return get_option( 'woocommerce_tax_display_cart' );
		} elseif ( 'display_totals_ex_tax' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
			return 'excl' === get_option( 'woocommerce_tax_display_cart' );
		} elseif ( 'display_cart_ex_tax' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
			return 'excl' === get_option( 'woocommerce_tax_display_cart' );
        } elseif ( 'cart_discount' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
			return $this->get_discount();

The method get_discount() does not seem to exist on object<WC_Abstract_Legacy_Order>.

        } elseif ( 'cart_discount_tax' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
			return $this->get_discount_tax();
        } elseif ( 'order_tax' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
			return $this->get_cart_tax();
        } elseif ( 'order_shipping_tax' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
            return $this->get_shipping_tax();
        } elseif ( 'order_shipping' === $key ) {
            _doing_it_wrong( $key, 'Order properties should not be accessed directly.', '2.6' );
            return $this->get_shipping();

The method get_shipping() does not seem to exist on object<WC_Abstract_Legacy_Order>.

        /**
         * Map vars to getters with warning.
         */
	 	} elseif ( is_callable( array( $this, "get_{$key}" ) ) ) {
			_doing_it_wrong( $key, 'Order properties should not be accessed directly Use get_' . $key . '().', '2.6' );
            return $this->{"get_{$key}"}();
        /**
         * Handle post meta
         */
        } else {
            _doing_it_wrong( $key, 'Meta should not be accessed directly. Use WC_Order::get_order_meta( $key )', '2.6' );
			$value = get_post_meta( $this->get_id(), '_' . $key, true );
		}

        return $value;
    }

    /**
     * Get order item meta.
     * @deprecated 2.6.0
     * @param mixed $order_item_id
     * @param string $key (default: '')
     * @param bool $single (default: false)
     * @return array|string
     */
    public function get_item_meta( $order_item_id, $key = '', $single = false ) {
        _deprecated_function( 'get_item_meta', '2.6', 'wc_get_order_item_meta' );
        return get_metadata( 'order_item', $order_item_id, $key, $single );
    }

    /**
     * Get all item meta data in array format in the order it was saved. Does not group meta by key like get_item_meta().
     *
     * @param mixed $order_item_id
     * @return array of objects
     */
    public function get_item_meta_array( $order_item_id ) {
        _deprecated_function( 'get_item_meta_array', '2.6', 'WC_Order_Item::get_meta_data()' );
        $item = $this->get_item( $order_item_id );

The method get_item() does not exist on WC_Abstract_Legacy_Order. Did you maybe mean get_item_meta()?

        return $item->get_meta_data();
    }

    /**
     * Expand item meta into the $item array.
     * @deprecated 2.6.0 Item meta no longer expanded due to new order item
     *        classes. This function now does nothing to avoid data breakage.
     * @since 2.4.0
     * @param array $item before expansion.
     * @return array
     */
    public function expand_item_meta( $item ) {
        _deprecated_function( 'expand_item_meta', '2.6', '' );
        return $item;
    }

	/**
     * Load the order object. Called from the constructor.
     * @deprecated 2.6.0 Logic moved to constructor
     * @param int|object|WC_Order $order Order to init.
     */
    protected function init( $order ) {

This method seems to be duplicated in your project.

		_deprecated_function( 'init', '2.6', 'Logic moved to constructor' );
        if ( is_numeric( $order ) ) {
            $this->read( $order );
        } elseif ( $order instanceof WC_Order ) {
            $this->read( absint( $order->get_id() ) );
        } elseif ( isset( $order->ID ) ) {
            $this->read( absint( $order->ID ) );
        }
    }

    /**
     * Gets an order from the database.
     * @deprecated 2.6
     * @param int $id (default: 0).
     * @return bool
     */
    public function get_order( $id = 0 ) {

This method seems to be duplicated in your project.

        _deprecated_function( 'get_order', '2.6', 'read' );
        if ( ! $id ) {
            return false;
        }
        if ( $result = get_post( $id ) ) {
            $this->populate( $result );

The method WC_Abstract_Legacy_Order::populate() has been deprecated with message: 2.6

            return true;
        }
        return false;
    }

    /**
     * Populates an order from the loaded post data.
     * @deprecated 2.6
     * @param mixed $result
     */
    public function populate( $result ) {
        _deprecated_function( 'populate', '2.6', 'read' );
        $this->read( $result->ID );
    }

	/**
     * Cancel the order and restore the cart (before payment).
     * @deprecated 2.6.0 Moved to event handler.
     * @param string $note (default: '') Optional note to add.
     */
    public function cancel_order( $note = '' ) {
		_deprecated_function( 'cancel_order', '2.6', 'update_status' );
        WC()->session->set( 'order_awaiting_payment', false );
        $this->update_status( 'cancelled', $note );
    }

	/**
     * Record sales.
     * @deprecated 2.6.0
     */
    public function record_product_sales() {
		_deprecated_function( 'record_product_sales', '2.6', 'wc_update_total_sales_counts' );
		wc_update_total_sales_counts( $this->get_id() );
    }

	/**
     * Increase applied coupon counts.
     * @deprecated 2.6.0
     */
    public function increase_coupon_usage_counts() {
		_deprecated_function( 'increase_coupon_usage_counts', '2.6', 'wc_update_coupon_usage_counts' );
		wc_update_coupon_usage_counts( $this->get_id() );
    }

    /**
     * Decrease applied coupon counts.
     * @deprecated 2.6.0
     */
    public function decrease_coupon_usage_counts() {
		_deprecated_function( 'decrease_coupon_usage_counts', '2.6', 'wc_update_coupon_usage_counts' );
		wc_update_coupon_usage_counts( $this->get_id() );
    }

	/**
     * Reduce stock levels for all line items in the order.
	 * @deprecated 2.6.0
     */
    public function reduce_order_stock() {
        _deprecated_function( 'reduce_order_stock', '2.6', 'wc_reduce_stock_levels' );
		wc_reduce_stock_levels( $this->get_id() );
    }

	/**
     * Send the stock notifications.
	 * @deprecated 2.6.0 No longer needs to be called directly.
     */
    public function send_stock_notifications( $product, $new_stock, $qty_ordered ) {

The parameter $product is not used and could be removed.

The parameter $new_stock is not used and could be removed.

The parameter $qty_ordered is not used and could be removed.

        _deprecated_function( 'send_stock_notifications', '2.6' );
    }

	/**
	 * Output items for display in html emails.
	 * @deprecated 2.6.0 Moved to template functions.
	 * @param array $args Items args.
	 * @return string
	 */
	public function email_order_items_table( $args = array() ) {
		return wc_get_email_order_items( $this, $args );

$this of type object<WC_Abstract_Legacy_Order> is not a sub-type of object<WC_Order>. It seems like you assume a child class of the class WC_Abstract_Legacy_Order to be always present.

	}
}