Merge pull request #46 from shiki/add/order-status-arg

Add --status argument for Orders

Author: rrennick

README.md

@@ -30,6 +30,9 @@ Generate orders with random dates between `--date-start` and the current date.
 Generate orders with random dates between `--date-start` and `--date-end`.
 - `wp wc generate orders <nr of orders> --date-start=2018-04-01 --date-end=2018-04-24`
 
+Generate orders with a specific status.
+- `wp wc generate orders <nr of orders> --status=completed`
+
 You may wish to disable emails if creating a large number of orders as this will trigger emails. To block all emails from your site, install a plugin like [Disable Emails](https://wordpress.org/plugins/disable-emails/).
 
 ### Customers

includes/CLI.php

@@ -81,10 +81,18 @@ public static function orders( $args, $assoc_args ) {
 			$amount = 100;
 		}
 
+		if ( ! empty( $assoc_args['status'] ) ) {
+			$status = $assoc_args['status'];
+			if ( ! wc_is_order_status( 'wc-' . $status ) ) {
+				WP_CLI::log( "The argument \"$status\" is not a valid order status." );
+				return;
+			}
+		}
+
 		if ( $amount > 0 ) {
-			$progress = \WP_CLI\Utils\make_progress_bar('Generating orders', $amount);
-			for ($i = 1; $i <= $amount; $i++) {
-				Generator\Order::generate(true, $assoc_args);
+			$progress = \WP_CLI\Utils\make_progress_bar( 'Generating orders', $amount );
+			for ( $i = 1; $i <= $amount; $i++ ) {
+				Generator\Order::generate( true, $assoc_args );
 				$progress->tick();
 			}
 			$progress->finish();
@@ -128,7 +136,7 @@ public static function customers( $args, $assoc_args ) {
 			'name'     => 'amount',
 			'type'     => 'positional',
 			'optional' => true,
-			'default'  => 100
+			'default'  => 100,
 		),
 		array(
 			'name'     => 'date-start',
@@ -140,6 +148,11 @@ public static function customers( $args, $assoc_args ) {
 			'type'     => 'assoc',
 			'optional' => true,
 		),
+		array(
+			'name'     => 'status',
+			'type'     => 'assoc',
+			'optional' => true,
+		),
 	),
 ) );
 WP_CLI::add_command( 'wc generate customers', array( 'WC\SmoothGenerator\CLI', 'customers' ) );

includes/Generator/Order.php

@@ -58,12 +58,7 @@ public static function generate( $save = true, $assoc_args = array() ) {
 		$order->set_shipping_postcode( $customer->get_shipping_postcode() );
 		$order->set_shipping_state( $customer->get_shipping_state() );
 		$order->set_shipping_country( $customer->get_shipping_country() );
-		$order->set_status( self::random_weighted_element( array(
-			'completed'  => 70,
-			'processing' => 15,
-			'on-hold'    => 5,
-			'failed'     => 10,
-		) ) );
+		$order->set_status( self::get_status( $assoc_args ) );
 		$order->calculate_totals( true );
 
 		$date = self::get_date_created( $assoc_args );
@@ -129,6 +124,26 @@ protected static function get_date_created( $assoc_args ) {
 		return $dates[ array_rand( $dates ) ];
 	}
 
+	/**
+	 * Returns a status to use as the order's status. If no status argument has been passed, this will
+	 * return a random status.
+	 *
+	 * @param array $assoc_args CLI arguments.
+	 * @return string An order status.
+	 */
+	private static function get_status( $assoc_args ) {
+		if ( ! empty( $assoc_args['status'] ) ) {
+			return $assoc_args['status'];
+		} else {
+			return self::random_weighted_element( array(
+				'completed'  => 70,
+				'processing' => 15,
+				'on-hold'    => 5,
+				'failed'     => 10,
+			) );
+		}
+	}
+
 	/**
 	 *  Get random products selected from existing products.
 	 *