WooCommerce\RestApi\Controllers\Version4\Schema\ProductVariationRequest

Complexity

Total Complexity

32

Size/Duplication

Total Lines	189
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	parse_image_field()	0	40	10
A	prepare_object()	0	18	3
C	parse_attributes_field()	0	43	12
B	set_common_props()	0	54	7

<?php
/**
 * Convert data in the product schema format to a product object.
 *
 * @package WooCommerce/RestApi
 */

namespace WooCommerce\RestApi\Controllers\Version4\Schema;

defined( 'ABSPATH' ) || exit;

/**
 * ProductVariationRequest class.
 */
class ProductVariationRequest extends ProductRequest {

	/**
	 * Convert request to object.
	 *
	 * @throws \WC_REST_Exception Will throw an exception if the resulting product object is invalid.
	 * @return \WC_Product_Variation
	 */
	public function prepare_object() {
		$id     = (int) $this->get_param( 'id', 0 );
		$object = new \WC_Product_Variation( $id );
		$object->set_parent_id( (int) $this->get_param( 'product_id', 0 ) );
		$parent = wc_get_product( $object->get_parent_id() );

		if ( ! $parent ) {

$parent is of type WC_Product, thus it always evaluated to true.

			throw new \WC_REST_Exception( 'woocommerce_rest_product_variation_invalid_parent', __( 'Invalid parent product.', 'woocommerce' ), 404 );
		}

		$this->set_common_props( $object );
		$this->set_meta_data( $object );

		if ( $object->get_downloadable() ) {
			$this->set_downloadable_props( $object );
		}

		return $object;
	}

	/**
	 * Set common product props.
	 *
	 * @param \WC_Product_Variation $object Product object reference.
	 */
	protected function set_common_props( &$object ) {
		$props = [
			'status',
			'sku',
			'virtual',
			'downloadable',
			'download_limit',
			'download_expiry',
			'manage_stock',
			'stock_status',
			'backorders',
			'regular_price',
			'sale_price',
			'date_on_sale_from',
			'date_on_sale_from_gmt',
			'date_on_sale_to',
			'date_on_sale_to_gmt',
			'tax_class',
			'description',
			'menu_order',
			'stock_quantity',
			'image',
			'downloads',
			'attributes',
			'weight',
			'dimensions',
			'shipping_class',
		];

		$request_props = array_intersect_key( $this->request, array_flip( $props ) );
		$prop_values   = [];

		foreach ( $request_props as $prop => $value ) {
			switch ( $prop ) {
				case 'image':
					$prop_values['image_id'] = $this->parse_image_field( $value, $object );
					break;
				case 'attributes':
					$prop_values['attributes'] = $this->parse_attributes_field( $value, $object );
					break;
				case 'dimensions':
					$dimensions  = $this->parse_dimensions_fields( $value );
					$prop_values = array_merge( $prop_values, $dimensions );
					break;
				case 'shipping_class':
					$prop_values['shipping_class_id'] = $this->parse_shipping_class( $value, $object );
					break;
				default:
					$prop_values[ $prop ] = $value;
			}
		}

		foreach ( $prop_values as $prop => $value ) {
			$object->{"set_$prop"}( $value );
		}
	}

	/**
	 * Set product object's attributes.
	 *
	 * @param array                 $raw_attributes Attribute data from request.
	 * @param \WC_Product_Variation $object Product object.
	 */
	protected function parse_attributes_field( $raw_attributes, $object = null ) {
		$attributes        = array();
		$parent            = wc_get_product( $object->get_parent_id() );

The method get_parent_id() does not exist on null.

		$parent_attributes = $parent->get_attributes();

		foreach ( $raw_attributes as $attribute ) {
			$attribute_id   = 0;
			$attribute_name = '';

			// Check ID for global attributes or name for product attributes.
			if ( ! empty( $attribute['id'] ) ) {
				$attribute_id   = absint( $attribute['id'] );
				$attribute_name = wc_attribute_taxonomy_name_by_id( $attribute_id );
			} elseif ( ! empty( $attribute['name'] ) ) {
				$attribute_name = sanitize_title( $attribute['name'] );
			}

			if ( ! $attribute_id && ! $attribute_name ) {
				continue;
			}

			if ( ! isset( $parent_attributes[ $attribute_name ] ) || ! $parent_attributes[ $attribute_name ]->get_variation() ) {
				continue;
			}

			$attribute_key   = sanitize_title( $parent_attributes[ $attribute_name ]->get_name() );
			$attribute_value = isset( $attribute['option'] ) ? wc_clean( stripslashes( $attribute['option'] ) ) : '';

			if ( $parent_attributes[ $attribute_name ]->is_taxonomy() ) {
				// If dealing with a taxonomy, we need to get the slug from the name posted to the API.
				$term = get_term_by( 'name', $attribute_value, $attribute_name );

				if ( $term && ! is_wp_error( $term ) ) {
					$attribute_value = $term->slug;
				} else {
					$attribute_value = sanitize_title( $attribute_value );
				}
			}

			$attributes[ $attribute_key ] = $attribute_value;
		}

		return $attributes;
	}

	/**
	 * Set product images.
	 *
	 * @throws \WC_REST_Exception REST API exceptions.
	 * @param array                 $image  Image data.
	 * @param \WC_Product_Variation $object Product object.
	 * @return array
	 */
	protected function parse_image_field( $image, $object ) {
		if ( empty( $image ) ) {
			return '';
		}

		$attachment_id = isset( $image['id'] ) ? absint( $image['id'] ) : 0;

		if ( 0 === $attachment_id && isset( $image['src'] ) ) {
			$upload = wc_rest_upload_image_from_url( esc_url_raw( $image['src'] ) );

			if ( is_wp_error( $upload ) ) {
				if ( ! apply_filters( 'woocommerce_rest_suppress_image_upload_error', false, $upload, $object->get_id(), array( $image ) ) ) {
					throw new \WC_REST_Exception( 'woocommerce_variation_image_upload_error', $upload->get_error_message(), 400 );
				}
			}

			$attachment_id = wc_rest_set_uploaded_image_as_attachment( $upload, $object->get_id() );

It seems like $upload can also be of type WP_Error; however, parameter $upload of wc_rest_set_uploaded_image_as_attachment() does only seem to accept array, maybe add an additional type check?

		}

		if ( ! wp_attachment_is_image( $attachment_id ) ) {
			/* translators: %s: attachment ID */
			throw new \WC_REST_Exception( 'woocommerce_variation_invalid_image_id', sprintf( __( '#%s is an invalid image ID.', 'woocommerce' ), $attachment_id ), 400 );
		}

		// Set the image alt if present.
		if ( ! empty( $image['alt'] ) ) {
			update_post_meta( $attachment_id, '_wp_attachment_image_alt', wc_clean( $image['alt'] ) );
		}

		// Set the image name if present.
		if ( ! empty( $image['name'] ) ) {
			wp_update_post(
				array(
					'ID'         => $attachment_id,
					'post_title' => $image['name'],
				)
			);
		}

		return $attachment_id;
	}
}