woocommerce / woocommerce-rest-api

unit-tests/Helpers/OrderHelper.php

<?php
/**
 * Orders helper.
 */

namespace Automattic\WooCommerce\RestApi\UnitTests\Helpers;

defined( 'ABSPATH' ) || exit;

use \WC_Tax;
use \WC_Shipping_Rate;
use \WC_Order_Item_Shipping;
use \WC_Order_Item_Product;

/**
 * Class OrderHelper.
 *
 * This helper class should ONLY be used for unit tests!.
 */
class OrderHelper {

	/**
	 * Delete a product.
	 *
	 * @param int $order_id ID of the order to delete.
	 */
	public static function delete_order( $order_id ) {

		$order = wc_get_order( $order_id );

		// Delete all products in the order.
		foreach ( $order->get_items() as $item ) {
			\Automattic\WooCommerce\RestApi\UnitTests\Helpers\ProductHelper::delete_product( $item['product_id'] );
		}

		ShippingHelper::delete_simple_flat_rate();

		// Delete the order post.
		$order->delete( true );
	}

	/**
	 * Create a order.
	 *
	 * @since   2.4
	 * @version 3.0 New parameter $product.
	 *
	 * @param int        $customer_id
	 * @param WC_Product $product

The type Automattic\WooCommerce\RestApi\UnitTests\Helpers\WC_Product was not found. Did you mean WC_Product? If so, make sure to prefix the type with \.

	 *
	 * @return WC_Order

The type Automattic\WooCommerce\RestApi\UnitTests\Helpers\WC_Order was not found. Did you mean WC_Order? If so, make sure to prefix the type with \.

	 */
	public static function create_order( $customer_id = 1, $product = null ) {

		if ( ! is_a( $product, 'WC_Product' ) ) {
			$product = \Automattic\WooCommerce\RestApi\UnitTests\Helpers\ProductHelper::create_simple_product();
		}

		ShippingHelper::create_simple_flat_rate();

		$order_data = array(
			'status'        => 'pending',
			'customer_id'   => $customer_id,
			'customer_note' => '',
			'total'         => '',
		);

		$_SERVER['REMOTE_ADDR'] = '127.0.0.1'; // Required, else wc_create_order throws an exception
		$order                  = wc_create_order( $order_data );

		// Add order products
		$item = new WC_Order_Item_Product();
		$item->set_props(
			array(
				'product'  => $product,
				'quantity' => 4,
				'subtotal' => wc_get_price_excluding_tax( $product, array( 'qty' => 4 ) ),
				'total'    => wc_get_price_excluding_tax( $product, array( 'qty' => 4 ) ),
			)
		);
		$item->save();
		$order->add_item( $item );

The method add_item() does not exist on WP_Error.

		// Set billing address
		$order->set_billing_first_name( 'Jeroen' );

The method set_billing_first_name() does not exist on WP_Error.

		$order->set_billing_last_name( 'Sormani' );

The method set_billing_last_name() does not exist on WP_Error.

		$order->set_billing_company( 'WooCompany' );

The method set_billing_company() does not exist on WP_Error.

		$order->set_billing_address_1( 'WooAddress' );

The method set_billing_address_1() does not exist on WP_Error.

		$order->set_billing_address_2( '' );

The method set_billing_address_2() does not exist on WP_Error.

		$order->set_billing_city( 'WooCity' );

The method set_billing_city() does not exist on WP_Error.

		$order->set_billing_state( 'NY' );

The method set_billing_state() does not exist on WP_Error.

		$order->set_billing_postcode( '123456' );

The method set_billing_postcode() does not exist on WP_Error.

		$order->set_billing_country( 'US' );

The method set_billing_country() does not exist on WP_Error.

		$order->set_billing_email( 'admin@example.org' );

The method set_billing_email() does not exist on WP_Error.

		$order->set_billing_phone( '555-32123' );

The method set_billing_phone() does not exist on WP_Error.

		// Add shipping costs
		$shipping_taxes = WC_Tax::calc_shipping_tax( '10', WC_Tax::get_shipping_tax_rates() );

'10' of type string is incompatible with the type double expected by parameter $price of WC_Tax::calc_shipping_tax().

		$rate           = new WC_Shipping_Rate( 'flat_rate_shipping', 'Flat rate shipping', '10', $shipping_taxes, 'flat_rate' );
		$item           = new WC_Order_Item_Shipping();
		$item->set_props(
			array(
				'method_title' => $rate->label,
				'method_id'    => $rate->id,
				'total'        => wc_format_decimal( $rate->cost ),
				'taxes'        => $rate->taxes,
			)
		);
		foreach ( $rate->get_meta_data() as $key => $value ) {
			$item->add_meta_data( $key, $value, true );
		}
		$order->add_item( $item );

		// Set payment gateway
		$payment_gateways = WC()->payment_gateways->payment_gateways();

The method payment_gateways() does not exist on null.

		$order->set_payment_method( $payment_gateways['bacs'] );

The method set_payment_method() does not exist on WP_Error.

		// Set totals
		$order->set_shipping_total( 10 );

The method set_shipping_total() does not exist on WP_Error.

		$order->set_discount_total( 0 );

The method set_discount_total() does not exist on WP_Error.

		$order->set_discount_tax( 0 );

The method set_discount_tax() does not exist on WP_Error.

		$order->set_cart_tax( 0 );

The method set_cart_tax() does not exist on WP_Error.

		$order->set_shipping_tax( 0 );

The method set_shipping_tax() does not exist on WP_Error.

		$order->set_total( 50 ); // 4 x $10 simple helper product

The method set_total() does not exist on WP_Error.

		$order->save();

The method save() does not exist on WP_Error.

		return $order;
	}
}