woocommerce/plugins/woocommerce-blocks/tests/php/Helpers/FixtureData.php

<?php
/**
 * Helper used to create fixture data for tests.
 */

namespace Automattic\WooCommerce\Blocks\Tests\Helpers;

/**
 * FixtureData class.
 */
class FixtureData {
	/**
	 * Create a simple product and return the result.
	 *
	 * @param array $props Product props.
	 * @return \WC_Product
	 */
	public function get_simple_product( $props ) {
		$product = new \WC_Product_Simple();
		$product->set_props(
			wp_parse_args(
				$props,
				[
					'name' => 'Simple Product',
				]
			)
		);
		$product->save();

		return wc_get_product( $product->get_id() );
	}

	/**
	 * Create a variable product and return the result.
	 *
	 * @param array $props Product props.
	 * @param array $attributes Product attributes from which to create variations.
	 * @return \WC_Product
	 */
	public function get_variable_product( $props, $attributes = [] ) {
		$product = new \WC_Product_Variable();
		$product->set_props(
			wp_parse_args(
				$props,
				[
					'name' => 'Variable Product',
				]
			)
		);
		$product->save();

		if ( $attributes ) {
			$product_attributes = [];

			foreach ( $attributes as $attribute ) {
				$product_attribute = new \WC_Product_Attribute();
				$product_attribute->set_id( $attribute['attribute_id'] );
				$product_attribute->set_name( $attribute['attribute_taxonomy'] );
				$product_attribute->set_options( $attribute['term_ids'] );
				$product_attribute->set_position( 1 );
				$product_attribute->set_visible( true );
				$product_attribute->set_variation( true );
				$product_attributes[] = $product_attribute;
			}

			$product->set_attributes( $product_attributes );
			$product->save();
		}

		return wc_get_product( $product->get_id() );
	}

	/**
	 * Create and return a variation of a product.
	 *
	 * @param integer $parent_id Parent product ID.
	 * @param array $attributes Variation attributes.
	 * @param array $props Product props.
	 * @return \WC_Product_Variation
	 */
	public function get_variation_product( $parent_id, $attributes = [], $props = [] ) {
		$variation = new \WC_Product_Variation();
		$variation->set_props(
			array_merge(
				wp_parse_args(
					$props,
					[
						'name' => 'Variation of ' . $parent_id,
						'regular_price' => '10',
					]
				),
				array(
					'parent_id'     => $parent_id,
				)
			)
		);
		$variation->set_attributes( $attributes );
		$variation->save();
		return wc_get_product( $variation->get_id() );
	}

	/**
	 * Create a product attribute.
	 *
	 * @param string $raw_name Name of attribute to create.
	 * @param array $terms Terms to create for the attribute.
	 * @return array Attribute data and created terms.
	 */
	public static function get_product_attribute( $raw_name = 'size', $terms = array( 'small' ) ) {
		global $wpdb, $wc_product_attributes;

		// Make sure caches are clean.
		delete_transient( 'wc_attribute_taxonomies' );
		\WC_Cache_Helper::invalidate_cache_group( 'woocommerce-attributes' );

		// These are exported as labels, so convert the label to a name if possible first.
		$attribute_labels = wp_list_pluck( wc_get_attribute_taxonomies(), 'attribute_label', 'attribute_name' );
		$attribute_name   = array_search( $raw_name, $attribute_labels, true );

		if ( ! $attribute_name ) {
			$attribute_name = wc_sanitize_taxonomy_name( $raw_name );
		}

		$attribute_id = wc_attribute_taxonomy_id_by_name( $attribute_name );

		if ( ! $attribute_id ) {
			$taxonomy_name = wc_attribute_taxonomy_name( $attribute_name );

			// Unregister taxonomy which other tests may have created...
			unregister_taxonomy( $taxonomy_name );

			$attribute_id = wc_create_attribute(
				array(
					'name'         => $raw_name,
					'slug'         => $attribute_name,
					'type'         => 'select',
					'order_by'     => 'menu_order',
					'has_archives' => 0,
				)
			);

			// Register as taxonomy.
			register_taxonomy(
				$taxonomy_name,
				apply_filters( 'woocommerce_taxonomy_objects_' . $taxonomy_name, array( 'product' ) ),
				apply_filters(
					'woocommerce_taxonomy_args_' . $taxonomy_name,
					array(
						'labels'       => array(
							'name' => $raw_name,
						),
						'hierarchical' => false,
						'show_ui'      => false,
						'query_var'    => true,
						'rewrite'      => false,
					)
				)
			);

			// Set product attributes global.
			$wc_product_attributes = array();

			foreach ( wc_get_attribute_taxonomies() as $taxonomy ) {
				$wc_product_attributes[ wc_attribute_taxonomy_name( $taxonomy->attribute_name ) ] = $taxonomy;
			}
		}

		$attribute = wc_get_attribute( $attribute_id );
		$return    = array(
			'attribute_name'     => $attribute->name,
			'attribute_taxonomy' => $attribute->slug,
			'attribute_id'       => $attribute_id,
			'term_ids'           => array(),
		);

		foreach ( $terms as $term ) {
			$result = term_exists( $term, $attribute->slug );

			if ( ! $result ) {
				$result               = wp_insert_term(
					$term,
					$attribute->slug,
					[
						'slug' => $term . '-slug',
						'description' => 'Description of ' . $term,
					]
				);
				$return['term_ids'][] = $result['term_id'];
			} else {
				$return['term_ids'][] = $result['term_id'];
			}
		}

		return $return;
	}

	/**
	 * Create a coupon and return the result.
	 *
	 * @param array $props Product props.
	 * @return \WC_Coupon
	 */
	public function get_coupon( $props ) {
		$coupon = new \WC_Coupon();
		$coupon->set_props( $props );
		$coupon->save();

		return new \WC_Coupon( $coupon->get_id() );
	}

	/**
	 * Upload a sample image and return it's ID.
	 *
	 * @param integer $product_id
	 * @return void
	 */
	public function sideload_image( $product_id = 0 ) {
		global $wpdb;
		$image_url = media_sideload_image( 'http://cldup.com/Dr1Bczxq4q.png', $product_id, '', 'src' );
		return $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM {$wpdb->posts} WHERE guid = %s", $image_url ) )[0];
	}

	/**
	 * Add a review to a product and flush cache.
	 *
	 * @param integer $product_id Product ID.
	 * @param integer $rating Review rating.
	 * @param string $content Review content.
	 * @param array $props Review props.
	 * @return void
	 */
	public function add_product_review( $product_id, $rating = 5, $content = 'Product review.', $props = [] ) {
		wp_insert_comment(
			array_merge(
				wp_parse_args(
					$props,
					[
						'comment_author'       => 'admin',
						'comment_author_email' => 'woo@woo.local',
						'comment_author_url'   => '',
						'comment_approved'     => 1,
						'comment_type'         => 'review',
					]
				),
				[
					'comment_post_ID'      => $product_id,
					'comment_content'      => $content,
					'comment_meta'         => [
						'rating' => $rating,
					],
				]
			)
		);
		\WC_Comments::clear_transients( $product_id );
	}

	/**
	 * Create a simple flat rate at the cost of 10.
	 *
	 * @param float $cost Optional. Cost of flat rate method.
	 */
	public function shipping_add_flat_rate( $cost = 10 ) {
		$flat_rate_settings = array(
			'enabled'      => 'yes',
			'title'        => 'Flat rate',
			'availability' => 'all',
			'countries'    => '',
			'tax_status'   => 'taxable',
			'cost'         => $cost,
		);
		update_option( 'woocommerce_flat_rate_settings', $flat_rate_settings );
		update_option( 'woocommerce_flat_rate', array() );
		\WC_Cache_Helper::get_transient_version( 'shipping', true );
		WC()->shipping()->load_shipping_methods();
	}
}