woocommerce/classes/class-wc-order.php

<?php
/**
 * Order
 *
 * The WooCommerce order class handles order data.
 *
 * @class 		WC_Order
 * @version		1.6.4
 * @package		WooCommerce/Classes
 * @author 		WooThemes
 */
class WC_Order {

	/** @var int Order (post) ID */
	var $id;

	/** @var string Coupon code. */
	var $status;

	/** @var string Order date (placed). */
	var $order_date;

	/** @var string Order date (paid). */
	var $modified_date;

	/** @var string Note added by the customer. */
	var $customer_note;

	/** @var array Order (post) meta/custom fields. */
	var $order_custom_fields;

	/** @var string Order unique key. */
	var $order_key;

	/** @var string */
	var $billing_first_name;

	/** @var string */
	var $billing_last_name;

	/** @var string */
	var $billing_company;

	/** @var string */
	var $billing_address_1;

	/** @var string */
	var $billing_address_2;

	/** @var string */
	var $billing_city;

	/** @var string */
	var $billing_postcode;

	/** @var string */
	var $billing_country;

	/** @var string */
	var $billing_state;

	/** @var string */
	var $billing_email;

	/** @var string */
	var $billing_phone;

	/** @var string */
	var $shipping_first_name;

	/** @var string */
	var $shipping_last_name;

	/** @var string */
	var $shipping_company;

	/** @var string */
	var $shipping_address_1;

	/** @var string */
	var $shipping_address_2;

	/** @var string */
	var $shipping_city;

	/** @var string */
	var $shipping_postcode;

	/** @var string */
	var $shipping_country;

	/** @var string */
	var $shipping_state;

	/** @var string Method id of the shipping used */
	var $shipping_method;

	/** @var string Shipping method title */
	var $shipping_method_title;

	/** @var string Method id of the payment used */
	var $payment_method;

	/** @var string Payment method title */
	var $payment_method_title;

	/** @var string After tax discount total */
	var $order_discount;

	/** @var string Before tax discount total */
	var $cart_discount;

	/** @var string Tax for the items total */
	var $order_tax;

	/** @var string Shipping cost */
	var $order_shipping;

	/** @var string Shipping tax */
	var $order_shipping_tax;

	/** @var string Grand total */
	var $order_total;

	/** @var array Order line items array */
	var $items;

	/** @var array Taxes array (tax rows) */
	var $taxes;

	/** @var int User ID */
	var $customer_user;

	/** @var int User ID */
	var $user_id;

	/** @var string */
	var $completed_date;

	/** @var string */
	var $billing_address;

	/** @var string */
	var $formatted_billing_address;

	/** @var string */
	var $shipping_address;

	/** @var string */
	var $formatted_shipping_address;

	/**
	 * Get the order if ID is passed, otherwise the order is new and empty.
	 *
	 * @access public
	 * @param string $id (default: '')
	 * @return void
	 */
	function __construct( $id = '' ) {
		$this->prices_include_tax = (get_option('woocommerce_prices_include_tax')=='yes') ? true : false;
		$this->display_totals_ex_tax = (get_option('woocommerce_display_totals_excluding_tax')=='yes') ? true : false;
		$this->display_cart_ex_tax = (get_option('woocommerce_display_cart_prices_excluding_tax')=='yes') ? true : false;
		if ( $id > 0 )
			$this->get_order( $id );
	}


	/**
	 * Gets an order from the database.
	 *
	 * @access public
	 * @param int $id (default: 0)
	 * @return bool
	 */
	function get_order( $id = 0 ) {
		if ( ! $id )
			return false;
		if ( $result = get_post( $id ) ) {
			$this->populate( $result );
			return true;
		}
		return false;
	}


	/**
	 * Populates an order from the loaded post data.
	 *
	 * @access public
	 * @param mixed $result
	 * @return void
	 */
	function populate( $result ) {
		// Standard post data
		$this->id = $result->ID;
		$this->order_date = $result->post_date;
		$this->modified_date = $result->post_modified;
		$this->customer_note = $result->post_excerpt;
		$this->order_custom_fields = get_post_custom( $this->id );

		// Define the data we're going to load: Key => Default value
		$load_data = apply_filters( 'woocommerce_load_order_data', array(
			'order_key'				=> '',
			'billing_first_name'	=> '',
			'billing_last_name' 	=> '',
			'billing_company'		=> '',
			'billing_address_1'		=> '',
			'billing_address_2'		=> '',
			'billing_city'			=> '',
			'billing_postcode'		=> '',
			'billing_country'		=> '',
			'billing_state' 		=> '',
			'billing_email'			=> '',
			'billing_phone'			=> '',
			'shipping_first_name'	=> '',
			'shipping_last_name'	=> '',
			'shipping_company'		=> '',
			'shipping_address_1'	=> '',
			'shipping_address_2'	=> '',
			'shipping_city'			=> '',
			'shipping_postcode'		=> '',
			'shipping_country'		=> '',
			'shipping_state'		=> '',
			'shipping_method'		=> '',
			'shipping_method_title'	=> '',
			'payment_method'		=> '',
			'payment_method_title' 	=> '',
			'order_discount'		=> '',
			'cart_discount'			=> '',
			'order_tax'				=> '',
			'order_shipping'		=> '',
			'order_shipping_tax'	=> '',
			'order_total'			=> '',
			'customer_user'			=> '',
			'completed_date'		=> $this->modified_date
		) );

		// Load the data from the custom fields
		foreach ( $load_data as $key => $default ) {
			if ( isset( $this->order_custom_fields[ '_' . $key ][0] ) && $this->order_custom_fields[ '_' . $key ][0] !== '' ) {
				$this->$key = $this->order_custom_fields[ '_' . $key ][0];
			} else {
				$this->$key = $default;
			}
		}

		// Aliases
		$this->user_id = (int) $this->customer_user;

		// Get status
		$terms = wp_get_object_terms( $this->id, 'shop_order_status', array('fields' => 'slugs') );
		$this->status = (isset($terms[0])) ? $terms[0] : 'pending';
	}


	/**
	 * Check if an order key is valid.
	 *
	 * @access public
	 * @param mixed $key
	 * @return bool
	 */
	function key_is_valid( $key ) {
		if ( $key == $this->order_key ) return true;
		return false;
	}


	/**
	 * get_order_number function.
	 *
	 * Gets the order number for display (by default, order ID)
	 *
	 * @access public
	 * @return string
	 */
	function get_order_number() {
		return apply_filters( 'woocommerce_order_number', _x( '#', 'hash before order number', 'woocommerce' ) . $this->id, $this );
	}

	/**
	 * Get a formatted billing address for the order.
	 *
	 * @access public
	 * @return string
	 */
	function get_formatted_billing_address() {
		if ( ! $this->formatted_billing_address ) {
			global $woocommerce;

			// Formatted Addresses
			$address = array(
				'first_name' 	=> $this->billing_first_name,
				'last_name'		=> $this->billing_last_name,
				'company'		=> $this->billing_company,
				'address_1'		=> $this->billing_address_1,
				'address_2'		=> $this->billing_address_2,
				'city'			=> $this->billing_city,
				'state'			=> $this->billing_state,
				'postcode'		=> $this->billing_postcode,
				'country'		=> $this->billing_country
			);

			$this->formatted_billing_address = $woocommerce->countries->get_formatted_address( $address );
		}
		return $this->formatted_billing_address;
	}

	/**
	 * Get the billing address in an array.
	 *
	 * @access public
	 * @return array
	 */
	function get_billing_address() {
		if ( ! $this->billing_address ) {
			// Formatted Addresses
			$address = array(
				'address_1'		=> $this->billing_address_1,
				'address_2'		=> $this->billing_address_2,
				'city'			=> $this->billing_city,
				'state'			=> $this->billing_state,
				'postcode'		=> $this->billing_postcode,
				'country'		=> $this->billing_country
			);
			$joined_address = array();
			foreach ($address as $part) if (!empty($part)) $joined_address[] = $part;
			$this->billing_address = implode(', ', $joined_address);
		}
		return $this->billing_address;
	}

	/**
	 * Get a formatted shipping address for the order.
	 *
	 * @access public
	 * @return void
	 */
	function get_formatted_shipping_address() {
		if ( ! $this->formatted_shipping_address ) {
			if ( $this->shipping_address_1 ) {
				global $woocommerce;

				// Formatted Addresses
				$address = array(
					'first_name' 	=> $this->shipping_first_name,
					'last_name'		=> $this->shipping_last_name,
					'company'		=> $this->shipping_company,
					'address_1'		=> $this->shipping_address_1,
					'address_2'		=> $this->shipping_address_2,
					'city'			=> $this->shipping_city,
					'state'			=> $this->shipping_state,
					'postcode'		=> $this->shipping_postcode,
					'country'		=> $this->shipping_country
				);

				$this->formatted_shipping_address = $woocommerce->countries->get_formatted_address( $address );
			}
		}
		return $this->formatted_shipping_address;
	}


	/**
	 * Get the shipping address in an array.
	 *
	 * @access public
	 * @return array
	 */
	function get_shipping_address() {
		if ( ! $this->shipping_address ) {
			if ( $this->shipping_address_1 ) {
				// Formatted Addresses
				$address = array(
					'address_1'		=> $this->shipping_address_1,
					'address_2'		=> $this->shipping_address_2,
					'city'			=> $this->shipping_city,
					'state'			=> $this->shipping_state,
					'postcode'		=> $this->shipping_postcode,
					'country'		=> $this->shipping_country
				);
				$joined_address = array();
				foreach ($address as $part) if (!empty($part)) $joined_address[] = $part;
				$this->shipping_address = implode(', ', $joined_address);
			}
		}
		return $this->shipping_address;
	}

	/**
	 * Return an array of items/product within this order.
	 *
	 * @access public
	 * @return array
	 */
	function get_items() {
		if ( ! $this->items )
			$this->items = isset( $this->order_custom_fields['_order_items'][0] ) ? maybe_unserialize( $this->order_custom_fields['_order_items'][0] ) : array();
		return $this->items;
	}

	/**
	 * Return an array of taxes for this order.
	 *
	 * @access public
	 * @return array
	 */
	function get_taxes() {
		if ( ! $this->taxes )
			$this->taxes = isset( $this->order_custom_fields['_order_taxes'][0] ) ? maybe_unserialize( $this->order_custom_fields['_order_taxes'][0] ) : array();
		return $this->taxes;
	}


	/** Total Getters *******************************************************/

	/**
	 * Gets shipping and product tax.
	 *
	 * @access public
	 * @return float
	 */
	function get_total_tax() {
		return apply_filters( 'woocommerce_order_amount_total_tax', number_format( (double) $this->order_tax + (double) $this->order_shipping_tax, 2, '.', '' ) );
	}


	/**
	 * Gets the total (product) discount amount - these are applied before tax.
	 *
	 * @access public
	 * @return float
	 */
	function get_cart_discount() {
		return apply_filters( 'woocommerce_order_amount_cart_discount', number_format( (double) $this->cart_discount, 2, '.', '' ) );
	}


	/**
	 * Gets the total (product) discount amount - these are applied before tax.
	 *
	 * @access public
	 * @return float
	 */
	function get_order_discount() {
		return apply_filters( 'woocommerce_order_amount_order_discount', number_format( (double) $this->order_discount, 2, '.', '' ) );
	}


	/**
	 * Gets the total discount amount - both kinds
	 *
	 * @access public
	 * @return float
	 */
	function get_total_discount() {
		if ( $this->order_discount || $this->cart_discount )
			return apply_filters( 'woocommerce_order_amount_total_discount', number_format( (double) $this->order_discount + (double) $this->cart_discount, 2, '.', '' ) );
	}


	/**
	 * Gets shipping total.
	 *
	 * @access public
	 * @return float
	 */
	function get_shipping() {
		return apply_filters( 'woocommerce_order_amount_shipping', number_format( (double) $this->order_shipping, 2, '.', '' ) );
	}


	/**
	 * Gets shipping tax amount.
	 *
	 * @access public
	 * @return float
	 */
	function get_shipping_tax() {
		return apply_filters( 'woocommerce_order_amount_shipping_tax', number_format( (double) $this->order_shipping_tax, 2, '.', '' ) );
	}


	/**
	 * Gets order total.
	 *
	 * @access public
	 * @return float
	 */
	function get_total() {
		return apply_filters( 'woocommerce_order_amount_total', number_format( (double) $this->order_total, 2, '.', '' ) );
	}


	/**
	 * Gets shipping method title.
	 *
	 * @access public
	 * @return string
	 */
	function get_shipping_method() {
		return apply_filters( 'woocommerce_order_shipping_method', ucwords( $this->shipping_method_title ) );
	}


	/**
	 * Get item subtotal - this is the cost before discount.
	 *
	 * @access public
	 * @param mixed $item
	 * @param bool $inc_tax (default: false)
	 * @param bool $round (default: true)
	 * @return float
	 */
	function get_item_subtotal( $item, $inc_tax = false, $round = true ) {
		if ( $inc_tax )
			$price = ( $item['line_subtotal'] + $item['line_subtotal_tax'] / $item['qty'] );
		else
			$price = ( $item['line_subtotal'] / $item['qty'] );
		return apply_filters( 'woocommerce_order_amount_item_subtotal', ($round) ? number_format( $price, 2, '.', '') : $price );
	}


	/**
	 * Get line subtotal - this is the cost before discount.
	 *
	 * @access public
	 * @param mixed $item
	 * @param bool $inc_tax (default: false)
	 * @param bool $round (default: true)
	 * @return float
	 */
	function get_line_subtotal( $item, $inc_tax = false, $round = true ) {
		if ( $inc_tax )
			$price = $item['line_subtotal'] + $item['line_subtotal_tax'];
		else
			$price = $item['line_subtotal'];
		return apply_filters( 'woocommerce_order_amount_line_subtotal', ($round) ? number_format( $price, 2, '.', '') : $price );
	}


	/**
	 * Calculate item cost - useful for gateways.
	 *
	 * @access public
	 * @param mixed $item
	 * @param bool $inc_tax (default: false)
	 * @param bool $round (default: true)
	 * @return float
	 */
	function get_item_total( $item, $inc_tax = false, $round = true ) {
		if ( $inc_tax )
			$price = ( ( $item['line_total'] + $item['line_tax'] ) / $item['qty'] );
		else
			$price = $item['line_total'] / $item['qty'];
		return apply_filters( 'woocommerce_order_amount_item_total', ($round) ? number_format( $price, 2, '.', '') : $price );
	}


	/**
	 * Calculate item tax - useful for gateways.
	 *
	 * @access public
	 * @param mixed $item
	 * @param bool $round (default: true)
	 * @return float
	 */
	function get_item_tax( $item, $round = true ) {
		$price = $item['line_tax'] / $item['qty'];
		return apply_filters( 'woocommerce_order_amount_item_tax', ($round) ? number_format( $price, 2, '.', '') : $price );
	}


	/**
	 * Calculate line total - useful for gateways.
	 *
	 * @access public
	 * @param mixed $item
	 * @param bool $inc_tax (default: false)
	 * @return float
	 */
	function get_line_total( $item, $inc_tax = false ) {
		if ( $inc_tax )
			return apply_filters( 'woocommerce_order_amount_line_total', number_format( $item['line_total'] + $item['line_tax'] , 2, '.', '') );
		else
			return apply_filters( 'woocommerce_order_amount_line_total', number_format( $item['line_total'] , 2, '.', '') );
	}


	/**
	 * Calculate line tax - useful for gateways.
	 *
	 * @access public
	 * @param mixed $item
	 * @return float
	 */
	function get_line_tax( $item ) {
		return apply_filters( 'woocommerce_order_amount_line_tax', number_format( $item['line_tax'], 2, '.', '') );
	}

	/** Deprecated functions */


	/**
	 * get_order_total function.
	 *
	 * @deprecated 1.4
	 * @access public
	 * @return float
	 */
	function get_order_total() {
		return $this->get_total();
	}


	/**
	 * get_item_cost function.
	 *
	 * @deprecated 1.4
	 * @access public
	 * @param mixed $item
	 * @param bool $inc_tax (default: false)
	 * @return float
	 */
	function get_item_cost( $item, $inc_tax = false ) {
		_deprecated_function( __FUNCTION__, '1.4', 'get_item_total()' );
		return $this->get_item_total( $item, $inc_tax );
	}


	/**
	 * get_row_cost function.
	 *
	 * @deprecated 1.4
	 * @access public
	 * @param mixed $item
	 * @param bool $inc_tax (default: false)
	 * @return float
	 */
	function get_row_cost( $item, $inc_tax = false ) {
		_deprecated_function( __FUNCTION__, '1.4', 'get_row_cost()' );
		return $this->get_line_total( $item, $inc_tax );
	}

	/** End Total Getters *******************************************************/

	/**
	 * Gets line subtotal - formatted for display.
	 *
	 * @access public
	 * @param mixed $item
	 * @return string
	 */
	function get_formatted_line_subtotal( $item ) {
		$subtotal = 0;

		if (!isset($item['line_subtotal']) || !isset($item['line_subtotal_tax'])) return;

		if ( $this->display_cart_ex_tax || ! $this->prices_include_tax ) :
			if ( $this->prices_include_tax ) $ex_tax_label = 1; else $ex_tax_label = 0;
			$subtotal = woocommerce_price( $this->get_line_subtotal( $item ), array('ex_tax_label' => $ex_tax_label ) );
		else :
			$subtotal = woocommerce_price( $this->get_line_subtotal( $item, true ) );
		endif;

		return apply_filters( 'woocommerce_order_formatted_line_subtotal', $subtotal, $item, $this );
	}


	/**
	 * Gets order total - formatted for display.
	 *
	 * @access public
	 * @return string
	 */
	function get_formatted_order_total() {

		$formatted_total = woocommerce_price( $this->order_total );

		return apply_filters( 'woocommerce_get_formatted_order_total', $formatted_total, $this );
	}


	/**
	 * Gets subtotal - subtotal is shown before discounts, but with localised taxes.
	 *
	 * @access public
	 * @param bool $compound (default: false)
	 * @return string
	 */
	function get_subtotal_to_display( $compound = false ) {
		global $woocommerce;

		$subtotal = 0;

		if ( ! $compound ) :

			foreach ($this->get_items() as $item) :

				if ( ! isset( $item['line_subtotal'] ) || ! isset( $item['line_subtotal_tax'] ) ) return;

				$subtotal += $this->get_line_subtotal( $item );

				if ( ! $this->display_cart_ex_tax ) :
					$subtotal += $item['line_subtotal_tax'];
				endif;

			endforeach;

			$subtotal = woocommerce_price( $subtotal );

			if ( $this->display_cart_ex_tax && $this->prices_include_tax ) :
				$subtotal .= ' <small>'.$woocommerce->countries->ex_tax_or_vat().'</small>';
			endif;

		else :

			if ( $this->prices_include_tax ) return;

			foreach ($this->get_items() as $item) :

				$subtotal += $item['line_subtotal'];

			endforeach;

			// Add Shipping Costs
			$subtotal += $this->get_shipping();

			// Remove non-compound taxes
			foreach ( $this->get_taxes() as $tax ) :

				if (isset($tax['compound']) && $tax['compound']) continue;

				$subtotal = $subtotal + $tax['cart_tax'] + $tax['shipping_tax'];

			endforeach;

			// Remove discounts
			$subtotal = $subtotal - $this->get_cart_discount();

			$subtotal = woocommerce_price($subtotal);

		endif;

		return apply_filters( 'woocommerce_order_subtotal_to_display', $subtotal, $compound, $this );
	}


	/**
	 * Gets shipping (formatted).
	 *
	 * @access public
	 * @return string
	 */
	function get_shipping_to_display() {
		global $woocommerce;

		if ( $this->order_shipping > 0 ) :

			$tax_text = '';

			if ($this->display_totals_ex_tax || !$this->prices_include_tax) :

				// Show shipping excluding tax
				$shipping = woocommerce_price($this->order_shipping);
				if ($this->order_shipping_tax > 0 && $this->prices_include_tax) :
					$tax_text = $woocommerce->countries->ex_tax_or_vat() . ' ';
				endif;

			else :

				// Show shipping including tax
				$shipping = woocommerce_price($this->order_shipping + $this->order_shipping_tax);
				if ($this->order_shipping_tax > 0 && !$this->prices_include_tax) :
					$tax_text = $woocommerce->countries->inc_tax_or_vat() . ' ';
				endif;

			endif;

			$shipping .= sprintf( __( '&nbsp;<small>%svia %s</small>', 'woocommerce' ), $tax_text, $this->get_shipping_method() );

		elseif ( $this->get_shipping_method() ) :
			$shipping = $this->get_shipping_method();
		else :
			$shipping = __( 'Free!', 'woocommerce' );
		endif;

		return apply_filters( 'woocommerce_order_shipping_to_display', $shipping, $this );
	}


	/**
	 * Get cart discount (formatted).
	 *
	 * @access public
	 * @return string.
	 */
	function get_cart_discount_to_display() {
		return apply_filters( 'woocommerce_order_cart_discount_to_display', woocommerce_price( $this->get_cart_discount() ), $this );
	}


	/**
	 * Get cart discount (formatted).
	 *
	 * @access public
	 * @return string
	 */
	function get_order_discount_to_display() {
		return apply_filters( 'woocommerce_order_discount_to_display', woocommerce_price( $this->get_order_discount() ), $this );
	}


	/**
	 * Get a product (either product or variation).
	 *
	 * @access public
	 * @param mixed $item
	 * @return WC_Product
	 */
	function get_product_from_item( $item ) {

		if (isset($item['variation_id']) && $item['variation_id']>0) :
			$_product = new WC_Product_Variation( $item['variation_id'] );
		else :
			$_product = new WC_Product( $item['id'] );
		endif;

		return $_product;

	}


	/**
	 * Get totals for display on pages and in emails.
	 *
	 * @access public
	 * @return array
	 */
	function get_order_item_totals() {
		global $woocommerce;

		$total_rows = array();

		if ( $subtotal = $this->get_subtotal_to_display() )
			$total_rows['cart_subtotal'] = array(
				'label' => __( 'Cart Subtotal:', 'woocommerce' ),
				'value'	=> $subtotal
			);

		if ( $this->get_cart_discount() > 0 )
			$total_rows['cart_discount'] = array(
				'label' => __( 'Cart Discount:', 'woocommerce' ),
				'value'	=> '-' . $this->get_cart_discount_to_display()
			);

		if ( $this->get_shipping_method() )
			$total_rows['shipping'] = array(
				'label' => __( 'Shipping:', 'woocommerce' ),
				'value'	=> $this->get_shipping_to_display()
			);
		
		// Tax for tax exclusive prices
		if ( $this->display_cart_ex_tax || ! $this->prices_include_tax ) {
			
			if ( $this->get_total_tax() > 0 ) {
	
				if ( sizeof( $this->get_taxes() ) > 0 ) {
	
					$has_compound_tax = false;
	
					foreach ( $this->get_taxes() as $tax ) {
						if ( $tax[ 'compound' ] ) {
							$has_compound_tax = true;
							continue;
						}
	
						if ( ( $tax[ 'cart_tax' ] + $tax[ 'shipping_tax' ] ) == 0 )
							continue;
	
						$total_rows[ sanitize_title( $tax[ 'label' ] ) ] = array(
							'label' => $tax[ 'label' ] . ':',
							'value'	=> woocommerce_price( ( $tax[ 'cart_tax' ] + $tax[ 'shipping_tax' ] ) )
						);
					}
	
					if ( $has_compound_tax ) {
						if ( $subtotal = $this->get_subtotal_to_display( true ) ) {
							$total_rows['subtotal'] = array(
								'label' => __( 'Subtotal:', 'woocommerce' ),
								'value'	=> $subtotal
							);
						}
					}
	
					foreach ( $this->get_taxes() as $tax ) {
						if ( ! $tax[ 'compound' ] )
							continue;
	
						if ( ( $tax[ 'cart_tax' ] + $tax[ 'shipping_tax' ] ) == 0 )
							continue;
	
						$total_rows[ sanitize_title( $tax[ 'label' ] ) ] = array(
							'label' => $tax[ 'label' ] . ':',
							'value'	=> woocommerce_price( ( $tax[ 'cart_tax' ] + $tax[ 'shipping_tax' ] ) )
						);
					}
				} else {
					$total_rows['tax'] = array(
						'label' => $woocommerce->countries->tax_or_vat(),
						'value'	=> woocommerce_price( $this->get_total_tax() )
					);
				}
	
			} elseif ( get_option( 'woocommerce_display_cart_taxes_if_zero' ) == 'yes' ) {
				$total_rows['tax'] = array(
					'label' => $woocommerce->countries->tax_or_vat(),
					'value'	=> _x( 'N/A', 'Relating to tax', 'woocommerce' )
				);
			}
		
		}

		if ( $this->get_order_discount() > 0 )
			$total_rows['order_discount'] = array(
				'label' => __( 'Order Discount:', 'woocommerce' ),
				'value'	=> '-' . $this->get_order_discount_to_display()
			);

		$total_rows['order_total'] = array(
			'label' => __( 'Order Total:', 'woocommerce' ),
			'value'	=> $this->get_formatted_order_total()
		);
		
		// Tax for inclusive prices
		if ( ! $this->display_cart_ex_tax && $this->prices_include_tax ) {
		
			$tax_string_array = array();
		
			if ( $this->get_total_tax() > 0 ) {
	
				if ( sizeof( $this->get_taxes() ) > 0 ) {
					
					foreach ( $this->get_taxes() as $tax ) {
					
						if ( ( $tax[ 'cart_tax' ] + $tax[ 'shipping_tax' ] ) == 0 )
							continue;
							
						$tax_string_array[] = sprintf( '%s %s', woocommerce_price( ( $tax[ 'cart_tax' ] + $tax[ 'shipping_tax' ] ) ), $tax[ 'label' ] );
					}
					
				} else {
					
					$tax_string_array[] = sprintf( '%s %s', woocommerce_price( $this->get_total_tax() ), $woocommerce->countries->tax_or_vat() );

				}
				
			} elseif ( get_option( 'woocommerce_display_cart_taxes_if_zero' ) == 'yes' ) {
				
				$tax_string_array[] = sprintf( '%s %s', woocommerce_price( 0 ), $woocommerce->countries->tax_or_vat() );

			}
					
			$total_rows['order_total']['value'] .= ' ' . sprintf( __( '(Includes %s)', 'woocommerce' ), implode( ', ', $tax_string_array ) );		
		}

		return apply_filters( 'woocommerce_get_order_item_totals', $total_rows, $this );
	}


	/**
	 * Output items for display in html emails.
	 *
	 * @access public
	 * @param bool $show_download_links (default: false)
	 * @param bool $show_sku (default: false)
	 * @param bool $show_purchase_note (default: false)
	 * @param bool $show_image (default: false)
	 * @param array $image_size (default: array( 32, 32 )
	 * @param bool plain text
	 * @return string
	 */
	function email_order_items_table( $show_download_links = false, $show_sku = false, $show_purchase_note = false, $show_image = false, $image_size = array( 32, 32 ), $plain_text = false ) {

		ob_start();
		
		$template = $plain_text ? 'emails/plain/email-order-items.php' : 'emails/email-order-items.php';

		woocommerce_get_template( $template, array(
			'order'					=> $this,
			'items' 				=> $this->get_items(),
			'show_download_links'	=> $show_download_links,
			'show_sku'				=> $show_sku,
			'show_purchase_note'	=> $show_purchase_note,
			'show_image' 			=> $show_image,
			'image_size'			=> $image_size
		) );

		$return = apply_filters( 'woocommerce_email_order_items_table', ob_get_clean() );

		return $return;
	}

	/**
	 * Checks if product download is permitted
	 * 
	 * @access public
	 * @return bool
	 */
	function is_download_permitted() {
		return apply_filters( 'woocommerce_order_is_download_permitted', $this->status == 'completed' || ( get_option( 'woocommerce_downloads_grant_access_after_payment' ) == 'yes' && $this->status == 'processing' ), $this );
	}

	/**
	 * Returns true if the order contains a downloadable product.
	 *
	 * @access public
	 * @return bool
	 */
	function has_downloadable_item() {
		$has_downloadable_item = false;

		foreach($this->get_items() as $item) :

			$_product = $this->get_product_from_item( $item );

			if ($_product->exists() && $_product->is_downloadable()) :
				$has_downloadable_item = true;
			endif;

		endforeach;

		return $has_downloadable_item;
	}


	/**
	 * Generates a URL so that a customer can checkout/pay for their (unpaid - pending) order via a link.
	 *
	 * @access public
	 * @return string
	 */
	function get_checkout_payment_url() {

		$payment_page = get_permalink(woocommerce_get_page_id('pay'));

		if (get_option('woocommerce_force_ssl_checkout')=='yes' || is_ssl()) $payment_page = str_replace('http:', 'https:', $payment_page);

		return apply_filters('woocommerce_get_checkout_payment_url', add_query_arg('pay_for_order', 'true', add_query_arg('order', $this->order_key, add_query_arg('order_id', $this->id, $payment_page))));
	}


	/**
	 * Generates a URL so that a customer can cancel their (unpaid - pending) order.
	 *
	 * @access public
	 * @return string
	 */
	function get_cancel_order_url() {
		global $woocommerce;
		return apply_filters('woocommerce_get_cancel_order_url', $woocommerce->nonce_url( 'cancel_order', add_query_arg('cancel_order', 'true', add_query_arg('order', $this->order_key, add_query_arg('order_id', $this->id, trailingslashit( home_url() ))))));
	}


	/**
	 * Gets a downloadable products file url.
	 *
	 * @access public
	 * @param int $item_id
	 * @param int $variation_id
	 * @return string
	 */
	function get_downloadable_file_url( $item_id, $variation_id ) {

		_deprecated_function( __METHOD__, '1.7', 'WC_Order::get_downloadable_file_urls' );

	 	$download_id = $variation_id > 0 ? $variation_id : $item_id;

	 	$user_email = $this->billing_email;

	 	return add_query_arg( 'download_file', $download_id, add_query_arg( 'order', $this->order_key, add_query_arg( 'email', $user_email, trailingslashit( home_url() ) ) ) );
	 }


	/**
	 * Gets any downloadable product file urls.
	 *
	 * @access public
	 * @param int $product_id product identifier
	 * @param int $variation_id variation identifier, or null
	 * @param array $item the item
	 * @return array available downloadable file urls
	 */
	function get_downloadable_file_urls( $product_id, $variation_id, $item ) {
		global $wpdb;

	 	$download_file = $variation_id > 0 ? $variation_id : $product_id;
		$_product = new WC_Product( $download_file );

	 	$user_email = $this->billing_email;

		$results = $wpdb->get_results( $wpdb->prepare("
			SELECT download_id
			FROM " . $wpdb->prefix . "woocommerce_downloadable_product_permissions
			WHERE user_email = %s
			AND order_key = %s
			AND product_id = %s
		", $user_email, $this->order_key, $download_file ) );

		$file_urls = array();
		foreach ( $results as $result ) {
			if ( $_product->has_file( $result->download_id ) ) {
				$file_urls[] = add_query_arg( array( 'download_file' => $download_file, 'order' => $this->order_key, 'email' => $user_email, 'key' => $result->download_id ), trailingslashit( home_url() ) );
			}
		}

		return apply_filters( 'woocommerce_get_downloadable_file_urls', $file_urls, $product_id, $variation_id, $item );
	}

	/**
	 * Adds a note (comment) to the order
	 *
	 * @access public
	 * @param string $note Note to add
	 * @param int $is_customer_note (default: 0) Is this a note for the customer?
	 * @return id Comment ID
	 */
	function add_order_note( $note, $is_customer_note = 0 ) {

		$comment_post_ID 		= $this->id;
		$comment_author 		= __( 'WooCommerce', 'woocommerce' );
		$comment_author_email 	= strtolower( __( 'WooCommerce', 'woocommerce' ) ) . '@' . str_replace('www.', '', $_SERVER['HTTP_HOST']);
		$comment_author_url 	= '';
		$comment_content 		= $note;
		$comment_agent			= 'WooCommerce';
		$comment_type			= 'order_note';
		$comment_parent			= 0;
		$comment_approved 		= 1;
		$commentdata 			= compact( 'comment_post_ID', 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_content', 'comment_agent', 'comment_type', 'comment_parent', 'comment_approved' );

		$comment_id = wp_insert_comment( $commentdata );

		add_comment_meta( $comment_id, 'is_customer_note', $is_customer_note );

		if ($is_customer_note) do_action( 'woocommerce_new_customer_note', array( 'order_id' => $this->id, 'customer_note' => $note ) );

		return $comment_id;
	}


	/**
	 * Updates status of order
	 *
	 * @access public
	 * @param string $new_status_slug Status to change the order to
	 * @param string $note (default: '') Optional note to add
	 * @return void
	 */
	function update_status( $new_status_slug, $note = '' ) {

		if ( $note ) 
			$note .= ' ';

		$old_status = get_term_by( 'slug', sanitize_title( $this->status ), 'shop_order_status' );
		$new_status = get_term_by( 'slug', sanitize_title( $new_status_slug ), 'shop_order_status' );
		
		if ( $new_status ) {

			wp_set_object_terms( $this->id, array( $new_status->slug ), 'shop_order_status', false );

			if ( $this->status != $new_status->slug ) {

				// Status was changed
				do_action( 'woocommerce_order_status_' . $new_status->slug, $this->id );
				do_action( 'woocommerce_order_status_' . $this->status . '_to_' . $new_status->slug, $this->id );
				do_action( 'woocommerce_order_status_changed', $this->id, $this->status, $new_status->slug );
				
				$this->add_order_note( $note . sprintf( __( 'Order status changed from %s to %s.', 'woocommerce' ), __( $old_status->name, 'woocommerce' ), __( $new_status->name, 'woocommerce' ) ) );

				// Record the completed date of the order
				if ( $new_status->slug == 'completed' )
					update_post_meta( $this->id, '_completed_date', current_time('mysql') );

				if ( $new_status->slug == 'processing' || $new_status->slug == 'completed' || $new_status->slug == 'on-hold' ) {

					// Record the sales
					$this->record_product_sales();

					// Increase coupon usage counts
					$this->increase_coupon_usage_counts();
				}

				// If the order is cancelled, restore used coupons
				if ( $new_status->slug == 'cancelled' )
					$this->decrease_coupon_usage_counts();

			}

		}

		delete_transient( 'woocommerce_processing_order_count' );
	}


	/**
	 * Cancel the order and restore the cart (before payment)
	 *
	 * @access public
	 * @param string $note (default: '') Optional note to add
	 * @return void
	 */
	function cancel_order( $note = '' ) {
		global $woocommerce;
		
		unset( $woocommerce->session->order_awaiting_payment );

		$this->update_status('cancelled', $note);

	}


	/**
	 * When a payment is complete this function is called
	 *
	 * Most of the time this should mark an order as 'processing' so that admin can process/post the items
	 * If the cart contains only downloadable items then the order is 'complete' since the admin needs to take no action
	 * Stock levels are reduced at this point
	 * Sales are also recorded for products
	 * Finally, record the date of payment
	 *
	 * @access public
	 * @return void
	 */
	function payment_complete() {
		global $woocommerce;
		
		unset( $woocommerce->session->order_awaiting_payment );

		if ( $this->status == 'on-hold' || $this->status == 'pending' || $this->status == 'failed' ) {

			$order_needs_processing = true;

			if ( sizeof( $this->get_items() ) > 0 ) {
			
				foreach( $this->get_items() as $item ) {
				
					if ( $item['id'] > 0 ) {

						$_product = $this->get_product_from_item( $item );

						if ( ( $_product->is_downloadable() && $_product->is_virtual() ) || ! apply_filters( 'woocommerce_order_item_needs_processing', true, $_product, $this->id ) ) {
							$order_needs_processing = false;
							continue;
						}

					}
					$order_needs_processing = true;
					break;
				}
			}

			$new_order_status = $order_needs_processing ? 'processing' : 'completed';

			$new_order_status = apply_filters( 'woocommerce_payment_complete_order_status', $new_order_status, $this->id );

			$this->update_status( $new_order_status );

			add_post_meta( $this->id, '_paid_date', current_time('mysql'), true );

			$this_order = array(
				'ID' => $this->id,
				'post_date' => current_time( 'mysql', 0 ),
				'post_date_gmt' => current_time( 'mysql', 1 )
			);
			wp_update_post( $this_order );

			$this->reduce_order_stock(); // Payment is complete so reduce stock levels

			do_action( 'woocommerce_payment_complete', $this->id );
		}
	}


	/**
	 * Record sales
	 *
	 * @access public
	 * @return void
	 */
	function record_product_sales() {

		if ( get_post_meta( $this->id, '_recorded_sales', true ) == 'yes' )
			return;

		if ( sizeof( $this->get_items() ) > 0 ) {
			foreach ( $this->get_items() as $item ) {
				if ( $item['id'] > 0 ) {
					$sales = (int) get_post_meta( $item['id'], 'total_sales', true );
					$sales += (int) $item['qty'];
					if ( $sales )
						update_post_meta( $item['id'], 'total_sales', $sales );
				}
			}
		}

		update_post_meta( $this->id, '_recorded_sales', 'yes' );
	}


	/**
	 * Increase applied coupon counts
	 *
	 * @access public
	 * @return array
	 */
	function get_used_coupons() {

		$coupons = get_post_meta( $this->id, 'coupons', true );

		return array_map( 'trim', explode( ',', $coupons ) );
	}


	/**
	 * Increase applied coupon counts
	 *
	 * @access public
	 * @return void
	 */
	function increase_coupon_usage_counts() {
		global $woocommerce;

		if ( get_post_meta( $this->id, '_recorded_coupon_usage_counts', true ) == 'yes' )
			return;

		if ( sizeof( $this->get_used_coupons() ) > 0 ) {
			foreach ( $this->get_used_coupons() as $code ) {
				if ( ! $code )
					continue;

				$coupon = $woocommerce->coupon( $code );
				$coupon->inc_usage_count();
			}
		}

		update_post_meta( $this->id, '_recorded_coupon_usage_counts', 'yes' );
	}


	/**
	 * Decrease applied coupon counts
	 *
	 * @access public
	 * @return void
	 */
	function decrease_coupon_usage_counts() {
		global $woocommerce;

		if ( get_post_meta( $this->id, '_recorded_coupon_usage_counts', true ) != 'yes' )
			return;

		if ( sizeof( $this->get_used_coupons() ) > 0 ) {
			foreach ( $this->get_used_coupons() as $code ) {
				if ( ! $code )
					continue;

				$coupon = $woocommerce->coupon( $code );
				$coupon->dcr_usage_count();
			}
		}

		delete_post_meta( $this->id, '_recorded_coupon_usage_counts' );
	}


	/**
	 * Reduce stock levels
	 *
	 * @access public
	 * @return void
	 */
	function reduce_order_stock() {

		if ( get_option('woocommerce_manage_stock') == 'yes' && sizeof( $this->get_items() ) > 0 ) {

			// Reduce stock levels and do any other actions with products in the cart
			foreach ( $this->get_items() as $item ) {

				if ($item['id']>0) {
					$_product = $this->get_product_from_item( $item );

					if ( $_product && $_product->exists() && $_product->managing_stock() ) {

						$old_stock = $_product->stock;

						$new_quantity = $_product->reduce_stock( $item['qty'] );

						$this->add_order_note( sprintf( __( 'Item #%s stock reduced from %s to %s.', 'woocommerce' ), $item['id'], $old_stock, $new_quantity) );

						$this->send_stock_notifications( $_product, $new_quantity, $item['qty'] );

					}

				}

			}

			do_action( 'woocommerce_reduce_order_stock', $this );

			$this->add_order_note( __( 'Order item stock reduced successfully.', 'woocommerce' ) );
		}

	}


	/**
	 * send_stock_notifications function.
	 *
	 * @access public
	 * @param object $product
	 * @param int $new_stock
	 * @param int $qty_ordered
	 * @return void
	 */
	function send_stock_notifications( $product, $new_stock, $qty_ordered ) {

		// Backorders
		if ( $new_stock < 0 )
			do_action( 'woocommerce_product_on_backorder', array( 'product' => $product, 'order_id' => $this->id, 'quantity' => $qty_ordered ) );

		// stock status notifications
		$notification_sent = false;

		if ( get_option( 'woocommerce_notify_no_stock' ) == 'yes' && get_option('woocommerce_notify_no_stock_amount') >= $new_stock ) {
			do_action( 'woocommerce_no_stock', $product );
			$notification_sent = true;
		}
		if ( ! $notification_sent && get_option( 'woocommerce_notify_low_stock' ) == 'yes' && get_option('woocommerce_notify_low_stock_amount') >= $new_stock ) {
			do_action( 'woocommerce_low_stock', $product );
			$notification_sent = true;
		}

	}


	/**
	 * List order notes (public) for the customer
	 *
	 * @access public
	 * @return array
	 */
	function get_customer_order_notes() {

		$notes = array();

		$args = array(
			'post_id' => $this->id,
			'approve' => 'approve',
			'type' => ''
		);

		remove_filter('comments_clauses', 'woocommerce_exclude_order_comments');

		$comments = get_comments( $args );

		foreach ($comments as $comment) :
			$is_customer_note = get_comment_meta($comment->comment_ID, 'is_customer_note', true);
			$comment->comment_content = make_clickable($comment->comment_content);
			if ($is_customer_note)
				$notes[] = $comment;
		endforeach;

		add_filter('comments_clauses', 'woocommerce_exclude_order_comments');

		return (array) $notes;

	}

}


/**
 * Order Item Meta
 *
 * A Simple class for managing order item meta so plugins add it in the correct format
 *
 * @class 		order_item_meta
 * @version		1.6.4
 * @package		WooCommerce/Classes
 * @author 		WooThemes
 */
class WC_Order_Item_Meta {

	var $meta;

	/**
	 * Constructor
	 *
	 * @access public
	 * @param string $item_meta (default: '')
	 * @return void
	 */
	function __construct( $item_meta = '' ) {
		$this->meta = array();

		if ( $item_meta ) $this->meta = $item_meta;
	}


	/**
	 * new_order_item function.
	 *
	 * @access public
	 * @param array $item
	 * @return void
	 */
	function new_order_item( $item ) {
		if ( $item )
			do_action('woocommerce_order_item_meta', $this, $item);
	}


	/**
	 * Add meta
	 *
	 * @access public
	 * @param string $name
	 * @param string $value
	 * @return void
	 */
	function add( $name, $value ) {
		$this->meta[] = array(
			'meta_name' 	=> $name,
			'meta_value' 	=> $value
		);
	}


	/**
	 * Display meta in a formatted list
	 *
	 * @access public
	 * @param bool $flat (default: false)
	 * @param bool $return (default: false)
	 * @param string $hideprefix (default: _)
	 * @return void
	 */
	function display( $flat = false, $return = false, $hideprefix = '_' ) {
		global $woocommerce;

		if ( $this->meta && is_array( $this->meta ) ) {
			
			$output = $flat ? '' : '<dl class="variation">';

			$meta_list = array();

			foreach ( $this->meta as $meta ) {
			
				if ( ! empty( $hideprefix ) && substr( $meta['meta_name'], 0, 1 ) == $hideprefix ) {
					// Skip
					continue;
				} else {
					$name 	= $meta['meta_name'];
					$value	= $meta['meta_value'];
				}

				if ( ! $value ) 
					continue;

				// If this is a term slug, get the term's nice name
	            if ( taxonomy_exists( esc_attr( str_replace( 'attribute_', '', $name ) ) ) ) {
	            	$term = get_term_by('slug', $value, esc_attr( str_replace( 'attribute_', '', $name ) ) );
	            	if ( ! is_wp_error( $term ) && $term->name )
	            		$value = $term->name;
	            } else {
	            	$value = ucfirst($value);
	            }

				if ( $flat )
					$meta_list[] = $woocommerce->attribute_label( str_replace( 'attribute_', '', $name ) ) . ': ' . $value;
				else
					$meta_list[] = '<dt>' . $woocommerce->attribute_label( str_replace( 'attribute_', '', $name ) ) . ':</dt><dd>' . $value . '</dd>';

			}

			if ( $flat )
				$output .= implode( ", \n", $meta_list );
			else
				$output .= implode( '', $meta_list );

			if ( ! $flat ) 
				$output .= '</dl>';

			if ( $return ) return $output; else echo $output;

		}
	}
}

/**
 * woocommerce_order class.
 *
 * @extends 	WC_Order
 * @deprecated 	1.4
 * @package		WooCommerce/Classes
 */
class woocommerce_order extends WC_Order {
	public function __construct( $id = '' ) {
		parent::__construct( $id );
	}
}

/**
 * order_item_meta class.
 *
 * @extends 	WC_Order_Item_Meta
 * @deprecated 	1.6.4
 * @package		WooCommerce/Classes
 */
class order_item_meta extends WC_Order_Item_Meta {
	public function __construct( $item_meta = '' ) {
		//_deprecated_function( 'order_item_meta', '1.6.4', 'WC_Order_Item_Meta()' );
		parent::__construct( $item_meta );
	}
}