Product_Saver

Summary

Class Product_Saver


Description

Handles storing a product in the database


Source

File: src/BigCommerce/Import/Importers/Products/Product_Saver.php

abstract class Product_Saver implements Import_Strategy {
	/**
	 * @var Model\Product
	 */
	protected $product;

	/**
	 * @var Model\Listing
	 */
	protected $listing;

	/**
	 * @var int
	 */
	protected $post_id;

	/**
	 * @var CatalogApi
	 */
	protected $catalog;

	/**
	 * @var \WP_Term
	 */
	private $channel_term;

	/**
	 * Product_Saver constructor.
	 *
	 * @param Model\Product $product
	 * @param Model\Listing $listing
	 * @param \WP_Term      $channel_term
	 * @param CatalogApi    $catalog
	 * @param int           $post_id
	 */
	public function __construct( Model\Product $product, Model\Listing $listing, \WP_Term $channel_term, CatalogApi $catalog, $post_id = 0 ) {
		$this->product      = $product;
		$this->listing      = $listing;
		$this->catalog      = $catalog;
		$this->post_id      = $post_id;
		$this->channel_term = $channel_term;
	}

	/**
	 * Import the product into WordPress
	 *
	 * @return int The imported post ID
	 */
	public function do_import() {
		$builder = new Product_Builder( $this->product, $this->listing, $this->channel_term, $this->catalog );

		$this->save_terms( $builder );
		$this->save_wp_postmeta( $builder );
		$this->save_wp_post( $builder );

		$product = new Product( $this->post_id );
		$product->update_source_data( $this->product );
		$product->update_listing_data( $this->listing );

		$this->save_modifiers( $product );
		$this->save_options( $product );
		$this->save_custom_fields( $product );
		$this->save_images( $builder );

		$this->send_notifications();

		return $this->post_id;
	}

	/**
	 * Save the product as a WordPress post
	 *
	 * @param Product_Builder $builder
	 *
	 * @return void
	 */
	protected function save_wp_post( Product_Builder $builder ) {
		$postarr = $this->get_post_array( $builder );
		kses_remove_filters();
		wp_update_post( $postarr );
		kses_init();
	}

	/**
	 * Get the data that will be saved to the WordPress post
	 *
	 * @param Product_Builder $builder
	 *
	 * @return array
	 */
	protected function get_post_array( Product_Builder $builder ) {
		$postarr = $builder->build_post_array();
		if ( $this->post_id ) {
			$postarr['ID']        = $this->post_id;
			$postarr['edit_date'] = true;
		}

		/**
		 * Filters import product post array.
		 *
		 * @param array $postarr Post array.
		 */
		return apply_filters( 'bigcommerce/import/product/post_array', $postarr );
	}

	/**
	 * Save post meta for the product
	 *
	 * @param Product_Builder $builder
	 *
	 * @return void
	 */
	protected function save_wp_postmeta( Product_Builder $builder ) {
		foreach ( $builder->build_post_meta() as $meta_key => $meta_value ) {
			update_post_meta( $this->post_id, $meta_key, $meta_value );
		}
		delete_post_meta( $this->post_id, Product::REQUIRES_REFRESH_META_KEY );
	}

	/**
	 * Save product modifier information to the Product post
	 *
	 * @param Product $product
	 *
	 * @return void
	 */
	protected function save_modifiers( Product $product ) {
		$product->update_modifier_data( $this->product->getModifiers() ?: [] );
	}

	/**
	 * Save product option information to the Product post
	 *
	 * @param Product $product
	 *
	 * @return void
	 */
	protected function save_options( Product $product ) {
		$product->update_options_data( $this->product->getOptions() ?: [] );
	}

	/**
	 * Save custom fields to the Product post
	 *
	 * @param Product $product
	 *
	 * @return void
	 */
	protected function save_custom_fields( Product $product ) {
		$custom_fields = isset( $this->product['custom_fields'] ) ? (array) $this->product['custom_fields'] : [];
		$custom_fields = array_map( function ( $field ) {
			return [
				'name'  => $field['name'],
				'value' => $field['value'],
			];
		}, $custom_fields );
		$product->update_custom_field_data( $custom_fields );
	}

	/**
	 * Save taxonomy terms for the Product post
	 *
	 * @param Product_Builder $builder
	 *
	 * @return void
	 */
	protected function save_terms( Product_Builder $builder ) {
		$terms = $builder->build_taxonomy_terms();
		foreach ( [ Availability::NAME, Condition::NAME, Product_Type::NAME, Flag::NAME ] as $taxonomy ) {
			wp_set_object_terms( $this->post_id, $terms[ $taxonomy ], $taxonomy, false );
		}

		foreach ( [ Brand::NAME, Product_Category::NAME, Channel::NAME ] as $taxonomy ) {
			wp_set_object_terms( $this->post_id, array_map( 'intval', $terms[ $taxonomy ] ), $taxonomy, false );
		}
	}

	/**
	 * Save feature image and gallery for the Product post
	 *
	 * @param Product_Builder $builder
	 *
	 * @return void
	 */
	protected function save_images( Product_Builder $builder ) {
		$images = $builder->build_images( $this->post_id );
		if ( array_key_exists( 'thumbnail', $images ) ) {
			update_post_meta( $this->post_id, '_thumbnail_id', $images['thumbnail'] );
		} else {
			delete_post_meta( $this->post_id, '_thumbnail_id' );
		}
		if ( array_key_exists( 'gallery', $images ) ) {
			update_post_meta( $this->post_id, Product::GALLERY_META_KEY, $images['gallery'] );
		} else {
			delete_post_meta( $this->post_id, Product::GALLERY_META_KEY );
		}
		if ( array_key_exists( 'variants', $images ) ) {
			update_post_meta( $this->post_id, Product::VARIANT_IMAGES_META_KEY, $images['variants'] );
		} else {
			delete_post_meta( $this->post_id, Product::VARIANT_IMAGES_META_KEY );
		}
	}

	/**
	 * Trigger actions to notify listeners that the import completed
	 *
	 * @return void
	 */
	protected function send_notifications() {
		/**
		 * A product has been saved by the import process
		 *
		 * @param int           $post_id The Post ID of the skipped product
		 * @param Model\Product $product The product data
		 * @param Model\Listing $listing The channel listing data
		 * @param CatalogApi    $catalog The Catalog API instance
		 */
		do_action( 'bigcommerce/import/product/saved', $this->post_id, $this->product, $this->listing, $this->catalog );
	}
}

Methods


User Contributed Notes

You must log in before being able to contribute a note or feedback.