WC_Abstract_Order

Abstract Order.

Defined (1)

The class is defined in the following location(s).

/includes/abstracts/abstract-wc-order.php  
  1. abstract class WC_Abstract_Order extends WC_Abstract_Legacy_Order { 
  2.  
  3.     /** 
  4.      * Order Data array. This is the core order data exposed in APIs since 3.0.0. 
  5.      * 
  6.      * Notes: cart_tax = cart_tax is the new name for the legacy 'order_tax' 
  7.      * which is the tax for items only, not shipping. 
  8.      * 
  9.      * @since 3.0.0 
  10.      * @var array 
  11.      */ 
  12.     protected $data = array( 
  13.         'parent_id' => 0,  
  14.         'status' => '',  
  15.         'currency' => '',  
  16.         'version' => '',  
  17.         'prices_include_tax' => false,  
  18.         'date_created' => null,  
  19.         'date_modified' => null,  
  20.         'discount_total' => 0,  
  21.         'discount_tax' => 0,  
  22.         'shipping_total' => 0,  
  23.         'shipping_tax' => 0,  
  24.         'cart_tax' => 0,  
  25.         'total' => 0,  
  26.         'total_tax' => 0,  
  27.  ); 
  28.  
  29.     /** 
  30.      * Order items will be stored here, sometimes before they persist in the DB. 
  31.      * 
  32.      * @since 3.0.0 
  33.      * @var array 
  34.      */ 
  35.     protected $items = array(); 
  36.  
  37.     /** 
  38.      * Order items that need deleting are stored here. 
  39.      * 
  40.      * @since 3.0.0 
  41.      * @var array 
  42.      */ 
  43.     protected $items_to_delete = array(); 
  44.  
  45.     /** 
  46.      * Stores meta in cache for future reads. 
  47.      * 
  48.      * A group must be set to to enable caching. 
  49.      * @var string 
  50.      */ 
  51.     protected $cache_group = 'orders'; 
  52.  
  53.     /** 
  54.      * Which data store to load. 
  55.      * 
  56.      * @var string 
  57.      */ 
  58.     protected $data_store_name = 'order'; 
  59.  
  60.     /** 
  61.      * This is the name of this object type. 
  62.      * @var string 
  63.      */ 
  64.     protected $object_type = 'order'; 
  65.  
  66.     /** 
  67.      * Get the order if ID is passed, otherwise the order is new and empty. 
  68.      * This class should NOT be instantiated, but the get_order function or new WC_Order_Factory. 
  69.      * should be used. It is possible, but the aforementioned are preferred and are the only. 
  70.      * methods that will be maintained going forward. 
  71.      * 
  72.      * @param  int|object|WC_Order $order Order to read. 
  73.      */ 
  74.     public function __construct( $order = 0 ) { 
  75.         parent::__construct( $order ); 
  76.  
  77.         if ( is_numeric( $order ) && $order > 0 ) { 
  78.             $this->set_id( $order ); 
  79.         } elseif ( $order instanceof self ) { 
  80.             $this->set_id( $order->get_id() ); 
  81.         } elseif ( ! empty( $order->ID ) ) { 
  82.             $this->set_id( $order->ID ); 
  83.         } else { 
  84.             $this->set_object_read( true ); 
  85.         } 
  86.  
  87.         $this->data_store = WC_Data_Store::load( $this->data_store_name ); 
  88.  
  89.         if ( $this->get_id() > 0 ) { 
  90.             $this->data_store->read( $this ); 
  91.         } 
  92.     } 
  93.  
  94.     /** 
  95.      * Get internal type. 
  96.      * 
  97.      * @return string 
  98.      */ 
  99.     public function get_type() { 
  100.         return 'shop_order'; 
  101.     } 
  102.  
  103.     /** 
  104.      * Get all class data in array format. 
  105.      * 
  106.      * @since 3.0.0 
  107.      * @return array 
  108.      */ 
  109.     public function get_data() { 
  110.         return array_merge( 
  111.             array( 
  112.                 'id' => $this->get_id(),  
  113.  ),  
  114.             $this->data,  
  115.             array( 
  116.                 'meta_data' => $this->get_meta_data(),  
  117.                 'line_items' => $this->get_items( 'line_item' ),  
  118.                 'tax_lines' => $this->get_items( 'tax' ),  
  119.                 'shipping_lines' => $this->get_items( 'shipping' ),  
  120.                 'fee_lines' => $this->get_items( 'fee' ),  
  121.                 'coupon_lines' => $this->get_items( 'coupon' ),  
  122.  ) 
  123.  ); 
  124.     } 
  125.  
  126.     /** 
  127.     |-------------------------------------------------------------------------- 
  128.     | CRUD methods 
  129.     |-------------------------------------------------------------------------- 
  130.     | 
  131.     | Methods which create, read, update and delete orders from the database. 
  132.     | Written in abstract fashion so that the way orders are stored can be 
  133.     | changed more easily in the future. 
  134.     | 
  135.     | A save method is included for convenience (chooses update or create based 
  136.     | on if the order exists yet). 
  137.     | 
  138.     */ 
  139.  
  140.     /** 
  141.      * Save data to the database. 
  142.      * 
  143.      * @since 3.0.0 
  144.      * @return int order ID 
  145.      */ 
  146.     public function save() { 
  147.         if ( $this->data_store ) { 
  148.             // Trigger action before saving to the DB. Allows you to adjust object props before save. 
  149.             do_action( 'woocommerce_before_' . $this->object_type . '_object_save', $this, $this->data_store ); 
  150.  
  151.             if ( $this->get_id() ) { 
  152.                 $this->data_store->update( $this ); 
  153.             } else { 
  154.                 $this->data_store->create( $this ); 
  155.             } 
  156.         } 
  157.         $this->save_items(); 
  158.         return $this->get_id(); 
  159.     } 
  160.  
  161.     /** 
  162.      * Save all order items which are part of this order. 
  163.      */ 
  164.     protected function save_items() { 
  165.         foreach ( $this->items_to_delete as $item ) { 
  166.             $item->delete(); 
  167.         } 
  168.         $this->items_to_delete = array(); 
  169.  
  170.         // Add/save items. 
  171.         foreach ( $this->items as $item_group => $items ) { 
  172.             if ( is_array( $items ) ) { 
  173.                 foreach ( array_filter( $items ) as $item_key => $item ) { 
  174.                     $item->set_order_id( $this->get_id() ); 
  175.                     $item_id = $item->save(); 
  176.  
  177.                     // If ID changed (new item saved to DB)... 
  178.                     if ( $item_id !== $item_key ) { 
  179.                         $this->items[ $item_group ][ $item_id ] = $item; 
  180.  
  181.                         unset( $this->items[ $item_group ][ $item_key ] ); 
  182.                     } 
  183.                 } 
  184.             } 
  185.         } 
  186.     } 
  187.  
  188.     /** 
  189.     |-------------------------------------------------------------------------- 
  190.     | Getters 
  191.     |-------------------------------------------------------------------------- 
  192.     */ 
  193.  
  194.     /** 
  195.      * Get parent order ID. 
  196.      * 
  197.      * @since 3.0.0 
  198.      * @param  string $context 
  199.      * @return integer 
  200.      */ 
  201.     public function get_parent_id( $context = 'view' ) { 
  202.         return $this->get_prop( 'parent_id', $context ); 
  203.     } 
  204.  
  205.     /** 
  206.      * Gets order currency. 
  207.      * 
  208.      * @param  string $context 
  209.      * @return string 
  210.      */ 
  211.     public function get_currency( $context = 'view' ) { 
  212.         return $this->get_prop( 'currency', $context ); 
  213.     } 
  214.  
  215.     /** 
  216.      * Get order_version. 
  217.      * 
  218.      * @param  string $context 
  219.      * @return string 
  220.      */ 
  221.     public function get_version( $context = 'view' ) { 
  222.         return $this->get_prop( 'version', $context ); 
  223.     } 
  224.  
  225.     /** 
  226.      * Get prices_include_tax. 
  227.      * 
  228.      * @param  string $context 
  229.      * @return bool 
  230.      */ 
  231.     public function get_prices_include_tax( $context = 'view' ) { 
  232.         return $this->get_prop( 'prices_include_tax', $context ); 
  233.     } 
  234.  
  235.     /** 
  236.      * Get date_created. 
  237.      * 
  238.      * @param  string $context 
  239.      * @return WC_DateTime|NULL object if the date is set or null if there is no date. 
  240.      */ 
  241.     public function get_date_created( $context = 'view' ) { 
  242.         return $this->get_prop( 'date_created', $context ); 
  243.     } 
  244.  
  245.     /** 
  246.      * Get date_modified. 
  247.      * 
  248.      * @param  string $context 
  249.      * @return WC_DateTime|NULL object if the date is set or null if there is no date. 
  250.      */ 
  251.     public function get_date_modified( $context = 'view' ) { 
  252.         return $this->get_prop( 'date_modified', $context ); 
  253.     } 
  254.  
  255.     /** 
  256.      * Return the order statuses without wc- internal prefix. 
  257.      * 
  258.      * @param  string $context 
  259.      * @return string 
  260.      */ 
  261.     public function get_status( $context = 'view' ) { 
  262.         $status = $this->get_prop( 'status', $context ); 
  263.  
  264.         if ( empty( $status ) && 'view' === $context ) { 
  265.             // In view context, return the default status if no status has been set. 
  266.             $status = apply_filters( 'woocommerce_default_order_status', 'pending' ); 
  267.         } 
  268.         return $status; 
  269.     } 
  270.  
  271.     /** 
  272.      * Get discount_total. 
  273.      * 
  274.      * @param  string $context 
  275.      * @return string 
  276.      */ 
  277.     public function get_discount_total( $context = 'view' ) { 
  278.         return $this->get_prop( 'discount_total', $context ); 
  279.     } 
  280.  
  281.     /** 
  282.      * Get discount_tax. 
  283.      * 
  284.      * @param  string $context 
  285.      * @return string 
  286.      */ 
  287.     public function get_discount_tax( $context = 'view' ) { 
  288.         return $this->get_prop( 'discount_tax', $context ); 
  289.     } 
  290.  
  291.     /** 
  292.      * Get shipping_total. 
  293.      * 
  294.      * @param  string $context 
  295.      * @return string 
  296.      */ 
  297.     public function get_shipping_total( $context = 'view' ) { 
  298.         return $this->get_prop( 'shipping_total', $context ); 
  299.     } 
  300.  
  301.     /** 
  302.      * Get shipping_tax. 
  303.      * 
  304.      * @param  string $context 
  305.      * @return string 
  306.      */ 
  307.     public function get_shipping_tax( $context = 'view' ) { 
  308.         return $this->get_prop( 'shipping_tax', $context ); 
  309.     } 
  310.  
  311.     /** 
  312.      * Gets cart tax amount. 
  313.      * 
  314.      * @param  string $context 
  315.      * @return float 
  316.      */ 
  317.     public function get_cart_tax( $context = 'view' ) { 
  318.         return $this->get_prop( 'cart_tax', $context ); 
  319.     } 
  320.  
  321.     /** 
  322.      * Gets order grand total. incl. taxes. Used in gateways. 
  323.      * 
  324.      * @param  string $context 
  325.      * @return float 
  326.      */ 
  327.     public function get_total( $context = 'view' ) { 
  328.         return $this->get_prop( 'total', $context ); 
  329.     } 
  330.  
  331.     /** 
  332.      * Get total tax amount. Alias for get_order_tax(). 
  333.      * 
  334.      * @param  string $context 
  335.      * @return float 
  336.      */ 
  337.     public function get_total_tax( $context = 'view' ) { 
  338.         return $this->get_prop( 'total_tax', $context ); 
  339.     } 
  340.  
  341.     /** 
  342.     |-------------------------------------------------------------------------- 
  343.     | Non-CRUD Getters 
  344.     |-------------------------------------------------------------------------- 
  345.     */ 
  346.  
  347.     /** 
  348.      * Gets the total discount amount. 
  349.      * 
  350.      * @param  bool $ex_tax Show discount excl any tax. 
  351.      * @return float 
  352.      */ 
  353.     public function get_total_discount( $ex_tax = true ) { 
  354.         if ( $ex_tax ) { 
  355.             $total_discount = $this->get_discount_total(); 
  356.         } else { 
  357.             $total_discount = $this->get_discount_total() + $this->get_discount_tax(); 
  358.         } 
  359.         return apply_filters( 'woocommerce_order_get_total_discount', round( $total_discount, WC_ROUNDING_PRECISION ), $this ); 
  360.     } 
  361.  
  362.     /** 
  363.      * Gets order subtotal. 
  364.      * @return float 
  365.      */ 
  366.     public function get_subtotal() { 
  367.         $subtotal = 0; 
  368.  
  369.         foreach ( $this->get_items() as $item ) { 
  370.             $subtotal += $item->get_subtotal(); 
  371.         } 
  372.  
  373.         return apply_filters( 'woocommerce_order_get_subtotal', (double) $subtotal, $this ); 
  374.     } 
  375.  
  376.     /** 
  377.      * Get taxes, merged by code, formatted ready for output. 
  378.      * 
  379.      * @return array 
  380.      */ 
  381.     public function get_tax_totals() { 
  382.         $tax_totals = array(); 
  383.  
  384.         foreach ( $this->get_items( 'tax' ) as $key => $tax ) { 
  385.             $code = $tax->get_rate_code(); 
  386.  
  387.             if ( ! isset( $tax_totals[ $code ] ) ) { 
  388.                 $tax_totals[ $code ] = new stdClass(); 
  389.                 $tax_totals[ $code ]->amount = 0; 
  390.             } 
  391.  
  392.             $tax_totals[ $code ]->id = $key; 
  393.             $tax_totals[ $code ]->rate_id = $tax->get_rate_id(); 
  394.             $tax_totals[ $code ]->is_compound = $tax->is_compound(); 
  395.             $tax_totals[ $code ]->label = $tax->get_label(); 
  396.             $tax_totals[ $code ]->amount           += (float) $tax->get_tax_total() + (float) $tax->get_shipping_tax_total(); 
  397.             $tax_totals[ $code ]->formatted_amount = wc_price( wc_round_tax_total( $tax_totals[ $code ]->amount ), array( 'currency' => $this->get_currency() ) ); 
  398.         } 
  399.  
  400.         if ( apply_filters( 'woocommerce_order_hide_zero_taxes', true ) ) { 
  401.             $amounts = array_filter( wp_list_pluck( $tax_totals, 'amount' ) ); 
  402.             $tax_totals = array_intersect_key( $tax_totals, $amounts ); 
  403.         } 
  404.  
  405.         return apply_filters( 'woocommerce_order_get_tax_totals', $tax_totals, $this ); 
  406.     } 
  407.  
  408.     /** 
  409.      * Get all valid statuses for this order 
  410.      * 
  411.      * @since 3.0.0 
  412.      * @return array Internal status keys e.g. 'wc-processing' 
  413.      */ 
  414.     protected function get_valid_statuses() { 
  415.         return array_keys( wc_get_order_statuses() ); 
  416.     } 
  417.  
  418.     /** 
  419.      * Get user ID. Used by orders, not other order types like refunds. 
  420.      * 
  421.      * @param  string $context 
  422.      * @return int 
  423.      */ 
  424.     public function get_user_id( $context = 'view' ) { 
  425.         return 0; 
  426.     } 
  427.  
  428.     /** 
  429.      * Get user. Used by orders, not other order types like refunds. 
  430.      * 
  431.      * @return WP_User|false 
  432.      */ 
  433.     public function get_user() { 
  434.         return false; 
  435.     } 
  436.  
  437.     /** 
  438.     |-------------------------------------------------------------------------- 
  439.     | Setters 
  440.     |-------------------------------------------------------------------------- 
  441.     | 
  442.     | Functions for setting order data. These should not update anything in the 
  443.     | database itself and should only change what is stored in the class 
  444.     | object. However, for backwards compatibility pre 3.0.0 some of these 
  445.     | setters may handle both. 
  446.     */ 
  447.  
  448.     /** 
  449.      * Set parent order ID. 
  450.      * 
  451.      * @since 3.0.0 
  452.      * @param int $value 
  453.      * @throws WC_Data_Exception 
  454.      */ 
  455.     public function set_parent_id( $value ) { 
  456.         if ( $value && ( $value === $this->get_id() || ! wc_get_order( $value ) ) ) { 
  457.             $this->error( 'order_invalid_parent_id', __( 'Invalid parent ID', 'woocommerce' ) ); 
  458.         } 
  459.         $this->set_prop( 'parent_id', absint( $value ) ); 
  460.     } 
  461.  
  462.     /** 
  463.      * Set order status. 
  464.      * 
  465.      * @since 3.0.0 
  466.      * @param string $new_status Status to change the order to. No internal wc- prefix is required. 
  467.      * @return array details of change 
  468.      */ 
  469.     public function set_status( $new_status ) { 
  470.         $old_status = $this->get_status(); 
  471.         $new_status = 'wc-' === substr( $new_status, 0, 3 ) ? substr( $new_status, 3 ) : $new_status; 
  472.  
  473.         // If setting the status, ensure it's set to a valid status. 
  474.         if ( true === $this->object_read ) { 
  475.             // Only allow valid new status 
  476.             if ( ! in_array( 'wc-' . $new_status, $this->get_valid_statuses() ) && 'trash' !== $new_status ) { 
  477.                 $new_status = 'pending'; 
  478.             } 
  479.  
  480.             // If the old status is set but unknown (e.g. draft) assume its pending for action usage. 
  481.             if ( $old_status && ! in_array( 'wc-' . $old_status, $this->get_valid_statuses() ) && 'trash' !== $old_status ) { 
  482.                 $old_status = 'pending'; 
  483.             } 
  484.         } 
  485.  
  486.         $this->set_prop( 'status', $new_status ); 
  487.  
  488.         return array( 
  489.             'from' => $old_status,  
  490.             'to' => $new_status,  
  491.  ); 
  492.     } 
  493.  
  494.     /** 
  495.      * Set order_version. 
  496.      * 
  497.      * @param string $value 
  498.      * @throws WC_Data_Exception 
  499.      */ 
  500.     public function set_version( $value ) { 
  501.         $this->set_prop( 'version', $value ); 
  502.     } 
  503.  
  504.     /** 
  505.      * Set order_currency. 
  506.      * 
  507.      * @param string $value 
  508.      * @throws WC_Data_Exception 
  509.      */ 
  510.     public function set_currency( $value ) { 
  511.         if ( $value && ! in_array( $value, array_keys( get_woocommerce_currencies() ) ) ) { 
  512.             $this->error( 'order_invalid_currency', __( 'Invalid currency code', 'woocommerce' ) ); 
  513.         } 
  514.         $this->set_prop( 'currency', $value ? $value : get_woocommerce_currency() ); 
  515.     } 
  516.  
  517.     /** 
  518.      * Set prices_include_tax. 
  519.      * 
  520.      * @param bool $value 
  521.      * @throws WC_Data_Exception 
  522.      */ 
  523.     public function set_prices_include_tax( $value ) { 
  524.         $this->set_prop( 'prices_include_tax', (bool) $value ); 
  525.     } 
  526.  
  527.     /** 
  528.      * Set date_created. 
  529.      * 
  530.      * @param  string|integer|null $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date. 
  531.      * @throws WC_Data_Exception 
  532.      */ 
  533.     public function set_date_created( $date = null ) { 
  534.         $this->set_date_prop( 'date_created', $date ); 
  535.     } 
  536.  
  537.     /** 
  538.      * Set date_modified. 
  539.      * 
  540.      * @param  string|integer|null $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date. 
  541.      * @throws WC_Data_Exception 
  542.      */ 
  543.     public function set_date_modified( $date = null ) { 
  544.         $this->set_date_prop( 'date_modified', $date ); 
  545.     } 
  546.  
  547.     /** 
  548.      * Set discount_total. 
  549.      * 
  550.      * @param string $value 
  551.      * @throws WC_Data_Exception 
  552.      */ 
  553.     public function set_discount_total( $value ) { 
  554.         $this->set_prop( 'discount_total', wc_format_decimal( $value ) ); 
  555.     } 
  556.  
  557.     /** 
  558.      * Set discount_tax. 
  559.      * 
  560.      * @param string $value 
  561.      * @throws WC_Data_Exception 
  562.      */ 
  563.     public function set_discount_tax( $value ) { 
  564.         $this->set_prop( 'discount_tax', wc_format_decimal( $value ) ); 
  565.     } 
  566.  
  567.     /** 
  568.      * Set shipping_total. 
  569.      * 
  570.      * @param string $value 
  571.      * @throws WC_Data_Exception 
  572.      */ 
  573.     public function set_shipping_total( $value ) { 
  574.         $this->set_prop( 'shipping_total', wc_format_decimal( $value ) ); 
  575.     } 
  576.  
  577.     /** 
  578.      * Set shipping_tax. 
  579.      * 
  580.      * @param string $value 
  581.      * @throws WC_Data_Exception 
  582.      */ 
  583.     public function set_shipping_tax( $value ) { 
  584.         $this->set_prop( 'shipping_tax', wc_format_decimal( $value ) ); 
  585.         $this->set_total_tax( (float) $this->get_cart_tax() + (float) $this->get_shipping_tax() ); 
  586.     } 
  587.  
  588.     /** 
  589.      * Set cart tax. 
  590.      * 
  591.      * @param string $value 
  592.      * @throws WC_Data_Exception 
  593.      */ 
  594.     public function set_cart_tax( $value ) { 
  595.         $this->set_prop( 'cart_tax', wc_format_decimal( $value ) ); 
  596.         $this->set_total_tax( (float) $this->get_cart_tax() + (float) $this->get_shipping_tax() ); 
  597.     } 
  598.  
  599.     /** 
  600.      * Sets order tax (sum of cart and shipping tax). Used internaly only. 
  601.      * 
  602.      * @param string $value 
  603.      * @throws WC_Data_Exception 
  604.      */ 
  605.     protected function set_total_tax( $value ) { 
  606.         $this->set_prop( 'total_tax', wc_format_decimal( $value ) ); 
  607.     } 
  608.  
  609.     /** 
  610.      * Set total. 
  611.      * 
  612.      * @param string $value 
  613.      * @param string $deprecated Function used to set different totals based on this. 
  614.      * @throws WC_Data_Exception 
  615.      */ 
  616.     public function set_total( $value, $deprecated = '' ) { 
  617.         if ( $deprecated ) { 
  618.             wc_deprecated_argument( 'total_type', '3.0', 'Use dedicated total setter methods instead.' ); 
  619.             return $this->legacy_set_total( $value, $deprecated ); 
  620.         } 
  621.         $this->set_prop( 'total', wc_format_decimal( $value, wc_get_price_decimals() ) ); 
  622.     } 
  623.  
  624.     /** 
  625.     |-------------------------------------------------------------------------- 
  626.     | Order Item Handling 
  627.     |-------------------------------------------------------------------------- 
  628.     | 
  629.     | Order items are used for products, taxes, shipping, and fees within 
  630.     | each order. 
  631.     */ 
  632.  
  633.     /** 
  634.      * Remove all line items (products, coupons, shipping, taxes) from the order. 
  635.      * 
  636.      * @param string $type Order item type. Default null. 
  637.      */ 
  638.     public function remove_order_items( $type = null ) { 
  639.         if ( ! empty( $type ) ) { 
  640.             $this->data_store->delete_items( $this, $type ); 
  641.  
  642.             if ( $group = $this->type_to_group( $type ) ) { 
  643.                 unset( $this->items[ $group ] ); 
  644.             } 
  645.         } else { 
  646.             $this->data_store->delete_items( $this ); 
  647.             $this->items = array(); 
  648.         } 
  649.     } 
  650.  
  651.     /** 
  652.      * Convert a type to a types group. 
  653.      * 
  654.      * @param string $type 
  655.      * @return string group 
  656.      */ 
  657.     protected function type_to_group( $type ) { 
  658.         $type_to_group = apply_filters( 'woocommerce_order_type_to_group', array( 
  659.             'line_item' => 'line_items',  
  660.             'tax' => 'tax_lines',  
  661.             'shipping' => 'shipping_lines',  
  662.             'fee' => 'fee_lines',  
  663.             'coupon' => 'coupon_lines',  
  664.  ) ); 
  665.         return isset( $type_to_group[ $type ] ) ? $type_to_group[ $type ] : ''; 
  666.     } 
  667.  
  668.     /** 
  669.      * Return an array of items/products within this order. 
  670.      * 
  671.      * @param string|array $types Types of line items to get (array or string). 
  672.      * @return Array of WC_Order_item 
  673.      */ 
  674.     public function get_items( $types = 'line_item' ) { 
  675.         $items = array(); 
  676.         $types = array_filter( (array) $types ); 
  677.  
  678.         foreach ( $types as $type ) { 
  679.             if ( $group = $this->type_to_group( $type ) ) { 
  680.                 if ( ! isset( $this->items[ $group ] ) ) { 
  681.                     $this->items[ $group ] = $this->data_store->read_items( $this, $type ); 
  682.                 } 
  683.                 // Don't use array_merge here because keys are numeric 
  684.                 $items = array_filter( $items + $this->items[ $group ] ); 
  685.             } 
  686.         } 
  687.  
  688.         return apply_filters( 'woocommerce_order_get_items', $items, $this ); 
  689.     } 
  690.  
  691.     /** 
  692.      * Return an array of fees within this order. 
  693.      * 
  694.      * @return array 
  695.      */ 
  696.     public function get_fees() { 
  697.         return $this->get_items( 'fee' ); 
  698.     } 
  699.  
  700.     /** 
  701.      * Return an array of taxes within this order. 
  702.      * 
  703.      * @return array 
  704.      */ 
  705.     public function get_taxes() { 
  706.         return $this->get_items( 'tax' ); 
  707.     } 
  708.  
  709.     /** 
  710.      * Return an array of shipping costs within this order. 
  711.      * 
  712.      * @return array 
  713.      */ 
  714.     public function get_shipping_methods() { 
  715.         return $this->get_items( 'shipping' ); 
  716.     } 
  717.  
  718.     /** 
  719.      * Gets formatted shipping method title. 
  720.      * 
  721.      * @return string 
  722.      */ 
  723.     public function get_shipping_method() { 
  724.         $names = array(); 
  725.         foreach ( $this->get_shipping_methods() as $shipping_method ) { 
  726.             $names[] = $shipping_method->get_name(); 
  727.         } 
  728.         return apply_filters( 'woocommerce_order_shipping_method', implode( ', ', $names ), $this ); 
  729.     } 
  730.  
  731.     /** 
  732.      * Get coupon codes only. 
  733.      * 
  734.      * @return array 
  735.      */ 
  736.     public function get_used_coupons() { 
  737.         $coupon_codes = array(); 
  738.         if ( $coupons = $this->get_items( 'coupon' ) ) { 
  739.             foreach ( $coupons as $coupon ) { 
  740.                 $coupon_codes[] = $coupon->get_code(); 
  741.             } 
  742.         } 
  743.         return $coupon_codes; 
  744.     } 
  745.  
  746.     /** 
  747.      * Gets the count of order items of a certain type. 
  748.      * 
  749.      * @param string $item_type 
  750.      * @return string 
  751.      */ 
  752.     public function get_item_count( $item_type = '' ) { 
  753.         $items = $this->get_items( empty( $item_type ) ? 'line_item' : $item_type ); 
  754.         $count = 0; 
  755.  
  756.         foreach ( $items as $item ) { 
  757.             $count += $item->get_quantity(); 
  758.         } 
  759.  
  760.         return apply_filters( 'woocommerce_get_item_count', $count, $item_type, $this ); 
  761.     } 
  762.  
  763.     /** 
  764.      * Get an order item object, based on it's type. 
  765.      * 
  766.      * @since  3.0.0 
  767.      * @param  int $item_id 
  768.      * @return WC_Order_Item 
  769.      */ 
  770.     public function get_item( $item_id ) { 
  771.         return WC_Order_Factory::get_order_item( $item_id ); 
  772.     } 
  773.  
  774.     /** 
  775.      * Get key for where a certain item type is stored in _items. 
  776.      * 
  777.      * @since  3.0.0 
  778.      * @param  $item object Order item (product, shipping, fee, coupon, tax) 
  779.      * @return string 
  780.      */ 
  781.     protected function get_items_key( $item ) { 
  782.         if ( is_a( $item, 'WC_Order_Item_Product' ) ) { 
  783.             return 'line_items'; 
  784.         } elseif ( is_a( $item, 'WC_Order_Item_Fee' ) ) { 
  785.             return 'fee_lines'; 
  786.         } elseif ( is_a( $item, 'WC_Order_Item_Shipping' ) ) { 
  787.             return 'shipping_lines'; 
  788.         } elseif ( is_a( $item, 'WC_Order_Item_Tax' ) ) { 
  789.             return 'tax_lines'; 
  790.         } elseif ( is_a( $item, 'WC_Order_Item_Coupon' ) ) { 
  791.             return 'coupon_lines'; 
  792.         } else { 
  793.             return ''; 
  794.         } 
  795.     } 
  796.  
  797.     /** 
  798.      * Remove item from the order. 
  799.      * 
  800.      * @param int $item_id 
  801.      */ 
  802.     public function remove_item( $item_id ) { 
  803.         $item = $this->get_item( $item_id ); 
  804.  
  805.         if ( ! $item || ! ( $items_key = $this->get_items_key( $item ) ) ) { 
  806.             return false; 
  807.         } 
  808.  
  809.         // Unset and remove later 
  810.         $this->items_to_delete[] = $item; 
  811.         unset( $this->items[ $items_key ][ $item->get_id() ] ); 
  812.     } 
  813.  
  814.     /** 
  815.      * Adds an order item to this order. The order item will not persist until save. 
  816.      * 
  817.      * @since 3.0.0 
  818.      * @param WC_Order_Item Order item object (product, shipping, fee, coupon, tax) 
  819.      */ 
  820.     public function add_item( $item ) { 
  821.         if ( ! $items_key = $this->get_items_key( $item ) ) { 
  822.             return false; 
  823.         } 
  824.  
  825.         // Make sure existing items are loaded so we can append this new one. 
  826.         if ( ! isset( $this->items[ $items_key ] ) ) { 
  827.             $this->items[ $items_key ] = $this->get_items( $item->get_type() ); 
  828.         } 
  829.  
  830.         // Set parent. 
  831.         $item->set_order_id( $this->get_id() ); 
  832.  
  833.         // Append new row with generated temporary ID 
  834.         if ( $item_id = $item->get_id() ) { 
  835.             $this->items[ $items_key ][ $item_id ] = $item; 
  836.         } else { 
  837.             $this->items[ $items_key ][ 'new:' . $items_key . sizeof( $this->items[ $items_key ] ) ] = $item; 
  838.         } 
  839.     } 
  840.  
  841.     /** 
  842.      * Add a product line item to the order. This is the only line item type with 
  843.      * it's own method because it saves looking up order amounts (costs are added up for you). 
  844.      * 
  845.      * @param  \WC_Product $product 
  846.      * @param  int $qty 
  847.      * @param  array $args 
  848.      * @return int order item ID 
  849.      * @throws WC_Data_Exception 
  850.      */ 
  851.     public function add_product( $product, $qty = 1, $args = array() ) { 
  852.         if ( $product ) { 
  853.             $default_args = array( 
  854.                 'name' => $product->get_name(),  
  855.                 'tax_class' => $product->get_tax_class(),  
  856.                 'product_id' => $product->is_type( 'variation' ) ? $product->get_parent_id() : $product->get_id(),  
  857.                 'variation_id' => $product->is_type( 'variation' ) ? $product->get_id() : 0,  
  858.                 'variation' => $product->is_type( 'variation' ) ? $product->get_attributes() : array(),  
  859.                 'subtotal' => wc_get_price_excluding_tax( $product, array( 'qty' => $qty ) ),  
  860.                 'total' => wc_get_price_excluding_tax( $product, array( 'qty' => $qty ) ),  
  861.                 'quantity' => $qty,  
  862.  ); 
  863.         } else { 
  864.             $default_args = array( 
  865.                 'quantity' => $qty,  
  866.  ); 
  867.         } 
  868.  
  869.         $args = wp_parse_args( $args, $default_args ); 
  870.  
  871.         // BW compatibility with old args 
  872.         if ( isset( $args['totals'] ) ) { 
  873.             foreach ( $args['totals'] as $key => $value ) { 
  874.                 if ( 'tax' === $key ) { 
  875.                     $args['total_tax'] = $value; 
  876.                 } elseif ( 'tax_data' === $key ) { 
  877.                     $args['taxes'] = $value; 
  878.                 } else { 
  879.                     $args[ $key ] = $value; 
  880.                 } 
  881.             } 
  882.         } 
  883.  
  884.         $item = new WC_Order_Item_Product(); 
  885.         $item->set_props( $args ); 
  886.         $item->set_backorder_meta(); 
  887.         $item->set_order_id( $this->get_id() ); 
  888.         $item->save(); 
  889.         $this->add_item( $item ); 
  890.         wc_do_deprecated_action( 'woocommerce_order_add_product', array( $this->get_id(), $item->get_id(), $product, $qty, $args ), '3.0', 'woocommerce_new_order_item action instead' ); 
  891.         return $item->get_id(); 
  892.     } 
  893.  
  894.     /** 
  895.     |-------------------------------------------------------------------------- 
  896.     | Payment Token Handling 
  897.     |-------------------------------------------------------------------------- 
  898.     | 
  899.     | Payment tokens are hashes used to take payments by certain gateways. 
  900.     | 
  901.     */ 
  902.  
  903.     /** 
  904.      * Add a payment token to an order 
  905.      * 
  906.      * @since 2.6 
  907.      * @param  WC_Payment_Token   $token     Payment token object 
  908.      * @return boolean|int The new token ID or false if it failed. 
  909.      */ 
  910.     public function add_payment_token( $token ) { 
  911.         if ( empty( $token ) || ! ( $token instanceof WC_Payment_Token ) ) { 
  912.             return false; 
  913.         } 
  914.  
  915.         $token_ids = $this->data_store->get_payment_token_ids( $this ); 
  916.         $token_ids[] = $token->get_id(); 
  917.         $this->data_store->update_payment_token_ids( $this, $token_ids ); 
  918.  
  919.         do_action( 'woocommerce_payment_token_added_to_order', $this->get_id(), $token->get_id(), $token, $token_ids ); 
  920.         return $token->get_id(); 
  921.     } 
  922.  
  923.     /** 
  924.      * Returns a list of all payment tokens associated with the current order 
  925.      * 
  926.      * @since 2.6 
  927.      * @return array An array of payment token objects 
  928.      */ 
  929.     public function get_payment_tokens() { 
  930.         return $this->data_store->get_payment_token_ids( $this ); 
  931.     } 
  932.  
  933.     /** 
  934.     |-------------------------------------------------------------------------- 
  935.     | Calculations. 
  936.     |-------------------------------------------------------------------------- 
  937.     | 
  938.     | These methods calculate order totals and taxes based on the current data. 
  939.     | 
  940.     */ 
  941.  
  942.     /** 
  943.      * Calculate shipping total. 
  944.      * 
  945.      * @since 2.2 
  946.      * @return float 
  947.      */ 
  948.     public function calculate_shipping() { 
  949.         $shipping_total = 0; 
  950.  
  951.         foreach ( $this->get_shipping_methods() as $shipping ) { 
  952.             $shipping_total += $shipping->get_total(); 
  953.         } 
  954.  
  955.         $this->set_shipping_total( $shipping_total ); 
  956.         $this->save(); 
  957.  
  958.         return $this->get_shipping_total(); 
  959.     } 
  960.  
  961.     /** 
  962.      * Get all tax classes for items in the order. 
  963.      * 
  964.      * @since 2.6.3 
  965.      * @return array 
  966.      */ 
  967.     public function get_items_tax_classes() { 
  968.         $found_tax_classes = array(); 
  969.  
  970.         foreach ( $this->get_items() as $item ) { 
  971.             if ( $_product = $item->get_product() ) { 
  972.                 $found_tax_classes[] = $_product->get_tax_class(); 
  973.             } 
  974.         } 
  975.  
  976.         return array_unique( $found_tax_classes ); 
  977.     } 
  978.  
  979.     /** 
  980.      * Calculate taxes for all line items and shipping, and store the totals and tax rows. 
  981.      * 
  982.      * Will use the base country unless customer addresses are set. 
  983.      * @param $args array Added in 3.0.0 to pass things like location. 
  984.      */ 
  985.     public function calculate_taxes( $args = array() ) { 
  986.         $tax_based_on = get_option( 'woocommerce_tax_based_on' ); 
  987.         $args = wp_parse_args( $args, array( 
  988.             'country' => 'billing' === $tax_based_on ? $this->get_billing_country()  : $this->get_shipping_country(),  
  989.             'state' => 'billing' === $tax_based_on ? $this->get_billing_state()    : $this->get_shipping_state(),  
  990.             'postcode' => 'billing' === $tax_based_on ? $this->get_billing_postcode() : $this->get_shipping_postcode(),  
  991.             'city' => 'billing' === $tax_based_on ? $this->get_billing_city()     : $this->get_shipping_city(),  
  992.  ) ); 
  993.  
  994.         // Default to base 
  995.         if ( 'base' === $tax_based_on || empty( $args['country'] ) ) { 
  996.             $default = wc_get_base_location(); 
  997.             $args['country'] = $default['country']; 
  998.             $args['state'] = $default['state']; 
  999.             $args['postcode'] = ''; 
  1000.             $args['city'] = ''; 
  1001.         } 
  1002.  
  1003.         // Calc taxes for line items 
  1004.         foreach ( $this->get_items( array( 'line_item', 'fee' ) ) as $item_id => $item ) { 
  1005.             $tax_class = $item->get_tax_class(); 
  1006.             $tax_status = $item->get_tax_status(); 
  1007.  
  1008.             if ( '0' !== $tax_class && 'taxable' === $tax_status ) { 
  1009.                 $tax_rates = WC_Tax::find_rates( array( 
  1010.                     'country' => $args['country'],  
  1011.                     'state' => $args['state'],  
  1012.                     'postcode' => $args['postcode'],  
  1013.                     'city' => $args['city'],  
  1014.                     'tax_class' => $tax_class,  
  1015.  ) ); 
  1016.  
  1017.                 $total = $item->get_total(); 
  1018.                 $taxes = WC_Tax::calc_tax( $total, $tax_rates, false ); 
  1019.  
  1020.                 if ( $item->is_type( 'line_item' ) ) { 
  1021.                     $subtotal = $item->get_subtotal(); 
  1022.                     $subtotal_taxes = WC_Tax::calc_tax( $subtotal, $tax_rates, false ); 
  1023.                     $item->set_taxes( array( 'total' => $taxes, 'subtotal' => $subtotal_taxes ) ); 
  1024.                 } else { 
  1025.                     $item->set_taxes( array( 'total' => $taxes ) ); 
  1026.                 } 
  1027.                 $item->save(); 
  1028.             } 
  1029.         } 
  1030.  
  1031.         // Calc taxes for shipping 
  1032.         foreach ( $this->get_shipping_methods() as $item_id => $item ) { 
  1033.             $shipping_tax_class = get_option( 'woocommerce_shipping_tax_class' ); 
  1034.  
  1035.             // Inherit tax class from items 
  1036.             if ( 'inherit' === $shipping_tax_class ) { 
  1037.                 $tax_rates = array(); 
  1038.                 $tax_classes = array_merge( array( '' ), WC_Tax::get_tax_class_slugs() ); 
  1039.                 $found_tax_classes = $this->get_items_tax_classes(); 
  1040.  
  1041.                 foreach ( $tax_classes as $tax_class ) { 
  1042.                     if ( in_array( $tax_class, $found_tax_classes ) ) { 
  1043.                         $tax_rates = WC_Tax::find_shipping_rates( array( 
  1044.                             'country' => $args['country'],  
  1045.                             'state' => $args['state'],  
  1046.                             'postcode' => $args['postcode'],  
  1047.                             'city' => $args['city'],  
  1048.                             'tax_class' => $tax_class,  
  1049.  ) ); 
  1050.                         break; 
  1051.                     } 
  1052.                 } 
  1053.             } else { 
  1054.                 $tax_rates = WC_Tax::find_shipping_rates( array( 
  1055.                     'country' => $args['country'],  
  1056.                     'state' => $args['state'],  
  1057.                     'postcode' => $args['postcode'],  
  1058.                     'city' => $args['city'],  
  1059.                     'tax_class' => $shipping_tax_class,  
  1060.  ) ); 
  1061.             } 
  1062.  
  1063.             $item->set_taxes( array( 'total' => WC_Tax::calc_tax( $item->get_total(), $tax_rates, false ) ) ); 
  1064.             $item->save(); 
  1065.         } 
  1066.         $this->update_taxes(); 
  1067.     } 
  1068.  
  1069.     /** 
  1070.      * Update tax lines for the order based on the line item taxes themselves. 
  1071.      */ 
  1072.     public function update_taxes() { 
  1073.         $cart_taxes = array(); 
  1074.         $shipping_taxes = array(); 
  1075.         $existing_taxes = $this->get_taxes(); 
  1076.         $saved_rate_ids = array(); 
  1077.  
  1078.         foreach ( $this->get_items( array( 'line_item', 'fee' ) ) as $item_id => $item ) { 
  1079.             $taxes = $item->get_taxes(); 
  1080.             foreach ( $taxes['total'] as $tax_rate_id => $tax ) { 
  1081.                 $cart_taxes[ $tax_rate_id ] = isset( $cart_taxes[ $tax_rate_id ] ) ? $cart_taxes[ $tax_rate_id ] + (float) $tax : (float) $tax; 
  1082.             } 
  1083.         } 
  1084.  
  1085.         foreach ( $this->get_shipping_methods() as $item_id => $item ) { 
  1086.             $taxes = $item->get_taxes(); 
  1087.             foreach ( $taxes['total'] as $tax_rate_id => $tax ) { 
  1088.                 $shipping_taxes[ $tax_rate_id ] = isset( $shipping_taxes[ $tax_rate_id ] ) ? $shipping_taxes[ $tax_rate_id ] + (float) $tax : (float) $tax; 
  1089.             } 
  1090.         } 
  1091.  
  1092.         foreach ( $existing_taxes as $tax ) { 
  1093.             // Remove taxes which no longer exist for cart/shipping. 
  1094.             if ( ( ! array_key_exists( $tax->get_rate_id(), $cart_taxes ) && ! array_key_exists( $tax->get_rate_id(), $shipping_taxes ) ) || in_array( $tax->get_rate_id(), $saved_rate_ids ) ) { 
  1095.                 $this->remove_item( $tax->get_id() ); 
  1096.                 continue; 
  1097.             } 
  1098.             $saved_rate_ids[] = $tax->get_rate_id(); 
  1099.             $tax->set_tax_total( isset( $cart_taxes[ $tax->get_rate_id() ] ) ? $cart_taxes[ $tax->get_rate_id() ] : 0 ); 
  1100.             $tax->set_shipping_tax_total( ! empty( $shipping_taxes[ $tax->get_rate_id() ] ) ? $shipping_taxes[ $tax->get_rate_id() ] : 0 ); 
  1101.             $tax->save(); 
  1102.         } 
  1103.  
  1104.         $new_rate_ids = wp_parse_id_list( array_diff( array_keys( $cart_taxes + $shipping_taxes ), $saved_rate_ids ) ); 
  1105.  
  1106.         // New taxes. 
  1107.         foreach ( $new_rate_ids as $tax_rate_id ) { 
  1108.             $item = new WC_Order_Item_Tax(); 
  1109.             $item->set_rate( $tax_rate_id ); 
  1110.             $item->set_tax_total( isset( $cart_taxes[ $tax_rate_id ] ) ? $cart_taxes[ $tax_rate_id ] : 0 ); 
  1111.             $item->set_shipping_tax_total( ! empty( $shipping_taxes[ $tax_rate_id ] ) ? $shipping_taxes[ $tax_rate_id ] : 0 ); 
  1112.             $this->add_item( $item ); 
  1113.         } 
  1114.  
  1115.         // Save tax totals 
  1116.         $this->set_shipping_tax( WC_Tax::round( array_sum( $shipping_taxes ) ) ); 
  1117.         $this->set_cart_tax( WC_Tax::round( array_sum( $cart_taxes ) ) ); 
  1118.         $this->save(); 
  1119.     } 
  1120.  
  1121.     /** 
  1122.      * Calculate totals by looking at the contents of the order. Stores the totals and returns the orders final total. 
  1123.      * 
  1124.      * @since 2.2 
  1125.      * @param  bool $and_taxes Calc taxes if true. 
  1126.      * @return float calculated grand total. 
  1127.      */ 
  1128.     public function calculate_totals( $and_taxes = true ) { 
  1129.         $cart_subtotal = 0; 
  1130.         $cart_total = 0; 
  1131.         $fee_total = 0; 
  1132.         $cart_subtotal_tax = 0; 
  1133.         $cart_total_tax = 0; 
  1134.  
  1135.         if ( $and_taxes && wc_tax_enabled() ) { 
  1136.             $this->calculate_taxes(); 
  1137.         } 
  1138.  
  1139.         // line items 
  1140.         foreach ( $this->get_items() as $item ) { 
  1141.             $cart_subtotal     += $item->get_subtotal(); 
  1142.             $cart_total        += $item->get_total(); 
  1143.             $cart_subtotal_tax += $item->get_subtotal_tax(); 
  1144.             $cart_total_tax    += $item->get_total_tax(); 
  1145.         } 
  1146.  
  1147.         $this->calculate_shipping(); 
  1148.  
  1149.         foreach ( $this->get_fees() as $item ) { 
  1150.             $fee_total += $item->get_total(); 
  1151.         } 
  1152.  
  1153.         $grand_total = round( $cart_total + $fee_total + $this->get_shipping_total() + $this->get_cart_tax() + $this->get_shipping_tax(), wc_get_price_decimals() ); 
  1154.  
  1155.         $this->set_discount_total( $cart_subtotal - $cart_total ); 
  1156.         $this->set_discount_tax( $cart_subtotal_tax - $cart_total_tax ); 
  1157.         $this->set_total( $grand_total ); 
  1158.         $this->save(); 
  1159.  
  1160.         return $grand_total; 
  1161.     } 
  1162.  
  1163.     /** 
  1164.      * Get item subtotal - this is the cost before discount. 
  1165.      * 
  1166.      * @param object $item 
  1167.      * @param bool $inc_tax (default: false). 
  1168.      * @param bool $round (default: true). 
  1169.      * @return float 
  1170.      */ 
  1171.     public function get_item_subtotal( $item, $inc_tax = false, $round = true ) { 
  1172.         $subtotal = 0; 
  1173.  
  1174.         if ( is_callable( array( $item, 'get_subtotal' ) ) ) { 
  1175.             if ( $inc_tax ) { 
  1176.                 $subtotal = ( $item->get_subtotal() + $item->get_subtotal_tax() ) / max( 1, $item->get_quantity() ); 
  1177.             } else { 
  1178.                 $subtotal = ( floatval( $item->get_subtotal() ) / max( 1, $item->get_quantity() ) ); 
  1179.             } 
  1180.  
  1181.             $subtotal = $round ? number_format( (float) $subtotal, wc_get_price_decimals(), '.', '' ) : $subtotal; 
  1182.         } 
  1183.  
  1184.         return apply_filters( 'woocommerce_order_amount_item_subtotal', $subtotal, $this, $item, $inc_tax, $round ); 
  1185.     } 
  1186.  
  1187.     /** 
  1188.      * Get line subtotal - this is the cost before discount. 
  1189.      * 
  1190.      * @param object $item 
  1191.      * @param bool $inc_tax (default: false). 
  1192.      * @param bool $round (default: true). 
  1193.      * @return float 
  1194.      */ 
  1195.     public function get_line_subtotal( $item, $inc_tax = false, $round = true ) { 
  1196.         $subtotal = 0; 
  1197.  
  1198.         if ( is_callable( array( $item, 'get_subtotal' ) ) ) { 
  1199.             if ( $inc_tax ) { 
  1200.                 $subtotal = $item->get_subtotal() + $item->get_subtotal_tax(); 
  1201.             } else { 
  1202.                 $subtotal = $item->get_subtotal(); 
  1203.             } 
  1204.  
  1205.             $subtotal = $round ? round( $subtotal, wc_get_price_decimals() ) : $subtotal; 
  1206.         } 
  1207.  
  1208.         return apply_filters( 'woocommerce_order_amount_line_subtotal', $subtotal, $this, $item, $inc_tax, $round ); 
  1209.     } 
  1210.  
  1211.     /** 
  1212.      * Calculate item cost - useful for gateways. 
  1213.      * 
  1214.      * @param object $item 
  1215.      * @param bool $inc_tax (default: false). 
  1216.      * @param bool $round (default: true). 
  1217.      * @return float 
  1218.      */ 
  1219.     public function get_item_total( $item, $inc_tax = false, $round = true ) { 
  1220.         $total = 0; 
  1221.  
  1222.         if ( is_callable( array( $item, 'get_total' ) ) ) { 
  1223.             if ( $inc_tax ) { 
  1224.                 $total = ( $item->get_total() + $item->get_total_tax() ) / max( 1, $item->get_quantity() ); 
  1225.             } else { 
  1226.                 $total = floatval( $item->get_total() ) / max( 1, $item->get_quantity() ); 
  1227.             } 
  1228.  
  1229.             $total = $round ? round( $total, wc_get_price_decimals() ) : $total; 
  1230.         } 
  1231.  
  1232.         return apply_filters( 'woocommerce_order_amount_item_total', $total, $this, $item, $inc_tax, $round ); 
  1233.     } 
  1234.  
  1235.     /** 
  1236.      * Calculate line total - useful for gateways. 
  1237.      * 
  1238.      * @param object $item 
  1239.      * @param bool $inc_tax (default: false). 
  1240.      * @param bool $round (default: true). 
  1241.      * @return float 
  1242.      */ 
  1243.     public function get_line_total( $item, $inc_tax = false, $round = true ) { 
  1244.         $total = 0; 
  1245.  
  1246.         if ( is_callable( array( $item, 'get_total' ) ) ) { 
  1247.             // Check if we need to add line tax to the line total. 
  1248.             $total = $inc_tax ? $item->get_total() + $item->get_total_tax() : $item->get_total(); 
  1249.  
  1250.             // Check if we need to round. 
  1251.             $total = $round ? round( $total, wc_get_price_decimals() ) : $total; 
  1252.         } 
  1253.  
  1254.         return apply_filters( 'woocommerce_order_amount_line_total', $total, $this, $item, $inc_tax, $round ); 
  1255.     } 
  1256.  
  1257.     /** 
  1258.      * Get item tax - useful for gateways. 
  1259.      * 
  1260.      * @param mixed $item 
  1261.      * @param bool $round (default: true). 
  1262.      * @return float 
  1263.      */ 
  1264.     public function get_item_tax( $item, $round = true ) { 
  1265.         $tax = 0; 
  1266.  
  1267.         if ( is_callable( array( $item, 'get_total_tax' ) ) ) { 
  1268.             $tax = $item->get_total_tax() / max( 1, $item->get_quantity() ); 
  1269.             $tax = $round ? wc_round_tax_total( $tax ) : $tax; 
  1270.         } 
  1271.  
  1272.         return apply_filters( 'woocommerce_order_amount_item_tax', $tax, $item, $round, $this ); 
  1273.     } 
  1274.  
  1275.     /** 
  1276.      * Get line tax - useful for gateways. 
  1277.      * 
  1278.      * @param mixed $item 
  1279.      * @return float 
  1280.      */ 
  1281.     public function get_line_tax( $item ) { 
  1282.         return apply_filters( 'woocommerce_order_amount_line_tax', is_callable( array( $item, 'get_total_tax' ) ) ? wc_round_tax_total( $item->get_total_tax() ) : 0, $item, $this ); 
  1283.     } 
  1284.  
  1285.     /** 
  1286.      * Gets line subtotal - formatted for display. 
  1287.      * 
  1288.      * @param array  $item 
  1289.      * @param string $tax_display 
  1290.      * @return string 
  1291.      */ 
  1292.     public function get_formatted_line_subtotal( $item, $tax_display = '' ) { 
  1293.         $tax_display = $tax_display ? $tax_display : get_option( 'woocommerce_tax_display_cart' ); 
  1294.  
  1295.         if ( 'excl' == $tax_display ) { 
  1296.             $ex_tax_label = $this->get_prices_include_tax() ? 1 : 0; 
  1297.  
  1298.             $subtotal = wc_price( $this->get_line_subtotal( $item ), array( 'ex_tax_label' => $ex_tax_label, 'currency' => $this->get_currency() ) ); 
  1299.         } else { 
  1300.             $subtotal = wc_price( $this->get_line_subtotal( $item, true ), array( 'currency' => $this->get_currency() ) ); 
  1301.         } 
  1302.  
  1303.         return apply_filters( 'woocommerce_order_formatted_line_subtotal', $subtotal, $item, $this ); 
  1304.     } 
  1305.  
  1306.     /** 
  1307.      * Gets order total - formatted for display. 
  1308.      * @return string 
  1309.      */ 
  1310.     public function get_formatted_order_total() { 
  1311.         $formatted_total = wc_price( $this->get_total(), array( 'currency' => $this->get_currency() ) ); 
  1312.         return apply_filters( 'woocommerce_get_formatted_order_total', $formatted_total, $this ); 
  1313.     } 
  1314.  
  1315.     /** 
  1316.      * Gets subtotal - subtotal is shown before discounts, but with localised taxes. 
  1317.      * 
  1318.      * @param bool $compound (default: false). 
  1319.      * @param string $tax_display (default: the tax_display_cart value). 
  1320.      * @return string 
  1321.      */ 
  1322.     public function get_subtotal_to_display( $compound = false, $tax_display = '' ) { 
  1323.         $tax_display = $tax_display ? $tax_display : get_option( 'woocommerce_tax_display_cart' ); 
  1324.         $subtotal = 0; 
  1325.  
  1326.         if ( ! $compound ) { 
  1327.             foreach ( $this->get_items() as $item ) { 
  1328.                 $subtotal += $item->get_subtotal(); 
  1329.  
  1330.                 if ( 'incl' === $tax_display ) { 
  1331.                     $subtotal += $item->get_subtotal_tax(); 
  1332.                 } 
  1333.             } 
  1334.  
  1335.             $subtotal = wc_price( $subtotal, array( 'currency' => $this->get_currency() ) ); 
  1336.  
  1337.             if ( 'excl' === $tax_display && $this->get_prices_include_tax() ) { 
  1338.                 $subtotal .= ' <small class="tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>'; 
  1339.             } 
  1340.         } else { 
  1341.             if ( 'incl' === $tax_display ) { 
  1342.                 return ''; 
  1343.             } 
  1344.  
  1345.             foreach ( $this->get_items() as $item ) { 
  1346.                 $subtotal += $item->get_subtotal(); 
  1347.             } 
  1348.  
  1349.             // Add Shipping Costs. 
  1350.             $subtotal += $this->get_shipping_total(); 
  1351.  
  1352.             // Remove non-compound taxes. 
  1353.             foreach ( $this->get_taxes() as $tax ) { 
  1354.                 if ( $tax->is_compound() ) { 
  1355.                     continue; 
  1356.                 } 
  1357.                 $subtotal = $subtotal + $tax->get_tax_total() + $tax->get_shipping_tax_total(); 
  1358.             } 
  1359.  
  1360.             // Remove discounts. 
  1361.             $subtotal = $subtotal - $this->get_total_discount(); 
  1362.             $subtotal = wc_price( $subtotal, array( 'currency' => $this->get_currency() ) ); 
  1363.         } 
  1364.  
  1365.         return apply_filters( 'woocommerce_order_subtotal_to_display', $subtotal, $compound, $this ); 
  1366.     } 
  1367.  
  1368.     /** 
  1369.      * Gets shipping (formatted). 
  1370.      * 
  1371.      * @return string 
  1372.      */ 
  1373.     public function get_shipping_to_display( $tax_display = '' ) { 
  1374.         $tax_display = $tax_display ? $tax_display : get_option( 'woocommerce_tax_display_cart' ); 
  1375.  
  1376.         if ( $this->get_shipping_total() != 0 ) { 
  1377.  
  1378.             if ( 'excl' === $tax_display ) { 
  1379.  
  1380.                 // Show shipping excluding tax. 
  1381.                 $shipping = wc_price( $this->get_shipping_total(), array( 'currency' => $this->get_currency() ) ); 
  1382.  
  1383.                 if ( $this->get_shipping_tax() != 0 && $this->get_prices_include_tax() ) { 
  1384.                     $shipping .= apply_filters( 'woocommerce_order_shipping_to_display_tax_label', ' <small class="tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>', $this, $tax_display ); 
  1385.                 } 
  1386.             } else { 
  1387.  
  1388.                 // Show shipping including tax. 
  1389.                 $shipping = wc_price( $this->get_shipping_total() + $this->get_shipping_tax(), array( 'currency' => $this->get_currency() ) ); 
  1390.  
  1391.                 if ( $this->get_shipping_tax() != 0 && ! $this->get_prices_include_tax() ) { 
  1392.                     $shipping .= apply_filters( 'woocommerce_order_shipping_to_display_tax_label', ' <small class="tax_label">' . WC()->countries->inc_tax_or_vat() . '</small>', $this, $tax_display ); 
  1393.                 } 
  1394.             } 
  1395.  
  1396.             /** translators: %s: shipping method */ 
  1397.             $shipping .= apply_filters( 'woocommerce_order_shipping_to_display_shipped_via', ' <small class="shipped_via">' . sprintf( __( 'via %s', 'woocommerce' ), $this->get_shipping_method() ) . '</small>', $this ); 
  1398.  
  1399.         } elseif ( $this->get_shipping_method() ) { 
  1400.             $shipping = $this->get_shipping_method(); 
  1401.         } else { 
  1402.             $shipping = __( 'Free!', 'woocommerce' ); 
  1403.         } 
  1404.  
  1405.         return apply_filters( 'woocommerce_order_shipping_to_display', $shipping, $this ); 
  1406.     } 
  1407.  
  1408.     /** 
  1409.      * Get the discount amount (formatted). 
  1410.      * @since  2.3.0 
  1411.      * @return string 
  1412.      */ 
  1413.     public function get_discount_to_display( $tax_display = '' ) { 
  1414.         $tax_display = $tax_display ? $tax_display : get_option( 'woocommerce_tax_display_cart' ); 
  1415.         return apply_filters( 'woocommerce_order_discount_to_display', wc_price( $this->get_total_discount( 'excl' === $tax_display && 'excl' === get_option( 'woocommerce_tax_display_cart' ) ), array( 'currency' => $this->get_currency() ) ), $this ); 
  1416.     } 
  1417.  
  1418.     /** 
  1419.      * Add total row for subtotal. 
  1420.      * 
  1421.      * @param array $total_rows 
  1422.      * @param string $tax_display 
  1423.      */ 
  1424.     protected function add_order_item_totals_subtotal_row( &$total_rows, $tax_display ) { 
  1425.         if ( $subtotal = $this->get_subtotal_to_display( false, $tax_display ) ) { 
  1426.             $total_rows['cart_subtotal'] = array( 
  1427.                 'label' => __( 'Subtotal:', 'woocommerce' ),  
  1428.                 'value' => $subtotal,  
  1429.  ); 
  1430.         } 
  1431.     } 
  1432.  
  1433.     /** 
  1434.      * Add total row for discounts. 
  1435.      * 
  1436.      * @param array $total_rows 
  1437.      * @param string $tax_display 
  1438.      */ 
  1439.     protected function add_order_item_totals_discount_row( &$total_rows, $tax_display ) { 
  1440.         if ( $this->get_total_discount() > 0 ) { 
  1441.             $total_rows['discount'] = array( 
  1442.                 'label' => __( 'Discount:', 'woocommerce' ),  
  1443.                 'value' => '-' . $this->get_discount_to_display( $tax_display ),  
  1444.  ); 
  1445.         } 
  1446.     } 
  1447.  
  1448.     /** 
  1449.      * Add total row for shipping. 
  1450.      * 
  1451.      * @param array $total_rows 
  1452.      * @param string $tax_display 
  1453.      */ 
  1454.     protected function add_order_item_totals_shipping_row( &$total_rows, $tax_display ) { 
  1455.         if ( $this->get_shipping_method() ) { 
  1456.             $total_rows['shipping'] = array( 
  1457.                 'label' => __( 'Shipping:', 'woocommerce' ),  
  1458.                 'value' => $this->get_shipping_to_display( $tax_display ),  
  1459.  ); 
  1460.         } 
  1461.     } 
  1462.  
  1463.     /** 
  1464.      * Add total row for fees. 
  1465.      * 
  1466.      * @param array $total_rows 
  1467.      * @param string $tax_display 
  1468.      */ 
  1469.     protected function add_order_item_totals_fee_rows( &$total_rows, $tax_display ) { 
  1470.         if ( $fees = $this->get_fees() ) { 
  1471.             foreach ( $fees as $id => $fee ) { 
  1472.                 if ( apply_filters( 'woocommerce_get_order_item_totals_excl_free_fees', empty( $fee['line_total'] ) && empty( $fee['line_tax'] ), $id ) ) { 
  1473.                     continue; 
  1474.                 } 
  1475.                 $total_rows[ 'fee_' . $fee->get_id() ] = array( 
  1476.                     'label' => $fee->get_name() . ':',  
  1477.                     'value' => wc_price( 'excl' === $tax_display ? $fee->get_total() : $fee->get_total() + $fee->get_total_tax(), array( 'currency' => $this->get_currency() ) ),  
  1478.  ); 
  1479.             } 
  1480.         } 
  1481.     } 
  1482.  
  1483.     /** 
  1484.      * Add total row for taxes. 
  1485.      * 
  1486.      * @param array $total_rows 
  1487.      * @param string $tax_display 
  1488.      */ 
  1489.     protected function add_order_item_totals_tax_rows( &$total_rows, $tax_display ) { 
  1490.         // Tax for tax exclusive prices. 
  1491.         if ( 'excl' === $tax_display ) { 
  1492.             if ( 'itemized' === get_option( 'woocommerce_tax_total_display' ) ) { 
  1493.                 foreach ( $this->get_tax_totals() as $code => $tax ) { 
  1494.                     $total_rows[ sanitize_title( $code ) ] = array( 
  1495.                         'label' => $tax->label . ':',  
  1496.                         'value' => $tax->formatted_amount,  
  1497.  ); 
  1498.                 } 
  1499.             } else { 
  1500.                 $total_rows['tax'] = array( 
  1501.                     'label' => WC()->countries->tax_or_vat() . ':',  
  1502.                     'value' => wc_price( $this->get_total_tax(), array( 'currency' => $this->get_currency() ) ),  
  1503.  ); 
  1504.             } 
  1505.         } 
  1506.     } 
  1507.  
  1508.     /** 
  1509.      * Add total row for grand total. 
  1510.      * 
  1511.      * @param array $total_rows 
  1512.      * @param string $tax_display 
  1513.      */ 
  1514.     protected function add_order_item_totals_total_row( &$total_rows, $tax_display ) { 
  1515.         $total_rows['order_total'] = array( 
  1516.             'label' => __( 'Total:', 'woocommerce' ),  
  1517.             'value' => $this->get_formatted_order_total( $tax_display ),  
  1518.  ); 
  1519.     } 
  1520.  
  1521.     /** 
  1522.      * Get totals for display on pages and in emails. 
  1523.      * 
  1524.      * @param mixed $tax_display 
  1525.      * @return array 
  1526.      */ 
  1527.     public function get_order_item_totals( $tax_display = '' ) { 
  1528.         $tax_display = $tax_display ? $tax_display : get_option( 'woocommerce_tax_display_cart' ); 
  1529.         $total_rows = array(); 
  1530.  
  1531.         $this->add_order_item_totals_subtotal_row( $total_rows, $tax_display ); 
  1532.         $this->add_order_item_totals_discount_row( $total_rows, $tax_display ); 
  1533.         $this->add_order_item_totals_shipping_row( $total_rows, $tax_display ); 
  1534.         $this->add_order_item_totals_fee_rows( $total_rows, $tax_display ); 
  1535.         $this->add_order_item_totals_tax_rows( $total_rows, $tax_display ); 
  1536.         $this->add_order_item_totals_total_row( $total_rows, $tax_display ); 
  1537.  
  1538.         return apply_filters( 'woocommerce_get_order_item_totals', $total_rows, $this, $tax_display ); 
  1539.     } 
  1540.  
  1541.     /** 
  1542.     |-------------------------------------------------------------------------- 
  1543.     | Conditionals 
  1544.     |-------------------------------------------------------------------------- 
  1545.     | 
  1546.     | Checks if a condition is true or false. 
  1547.     | 
  1548.     */ 
  1549.  
  1550.     /** 
  1551.      * Checks the order status against a passed in status. 
  1552.      * 
  1553.      * @return bool 
  1554.      */ 
  1555.     public function has_status( $status ) { 
  1556.         return apply_filters( 'woocommerce_order_has_status', ( is_array( $status ) && in_array( $this->get_status(), $status ) ) || $this->get_status() === $status ? true : false, $this, $status ); 
  1557.     } 
  1558.  
  1559.     /** 
  1560.      * Check whether this order has a specific shipping method or not. 
  1561.      * 
  1562.      * @param string $method_id 
  1563.      * @return bool 
  1564.      */ 
  1565.     public function has_shipping_method( $method_id ) { 
  1566.         foreach ( $this->get_shipping_methods() as $shipping_method ) { 
  1567.             if ( strpos( $shipping_method->get_method_id(), $method_id ) === 0 ) { 
  1568.                 return true; 
  1569.             } 
  1570.         } 
  1571.         return false; 
  1572.     } 
  1573.  
  1574.     /** 
  1575.      * Returns true if the order contains a free product. 
  1576.      * @since 2.5.0 
  1577.      * @return bool 
  1578.      */ 
  1579.     public function has_free_item() { 
  1580.         foreach ( $this->get_items() as $item ) { 
  1581.             if ( ! $item->get_total() ) { 
  1582.                 return true; 
  1583.             } 
  1584.         } 
  1585.         return false; 
  1586.     } 
  1587. }