woocommerce/includes/import/abstract-wc-product-importe...

932 lines
24 KiB
PHP
Raw Normal View History

2017-05-16 04:02:46 +00:00
<?php
/**
* Abstract Product importer
*
* @author Automattic
* @category Admin
* @package WooCommerce/Import
* @version 3.1.0
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Include dependencies.
*/
if ( ! class_exists( 'WC_Importer_Interface', false ) ) {
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-importer-interface.php' );
}
/**
* WC_Product_Importer Class.
*/
abstract class WC_Product_Importer implements WC_Importer_Interface {
2017-05-16 04:43:45 +00:00
/**
* CSV file.
*
* @var string
*/
protected $file = '';
2017-05-18 16:59:40 +00:00
/**
* The file position after the last read.
*
* @var int
*/
protected $file_position = 0;
2017-05-16 04:43:45 +00:00
/**
* Importer parameters.
*
* @var array
*/
protected $params = array();
/**
* Raw keys - CSV raw headers.
*
* @var array
*/
protected $raw_keys = array();
/**
* Mapped keys - CSV headers.
*
* @var array
*/
protected $mapped_keys = array();
/**
* Raw data.
*
* @var array
*/
protected $raw_data = array();
/**
* Parsed data.
*
* @var array
*/
protected $parsed_data = array();
/**
* Get file raw headers.
*
* @return array
*/
public function get_raw_keys() {
return $this->raw_keys;
}
/**
* Get file mapped headers.
*
* @return array
*/
public function get_mapped_keys() {
return ! empty( $this->mapped_keys ) ? $this->mapped_keys : $this->raw_keys;
2017-05-16 04:43:45 +00:00
}
/**
* Get raw data.
*
* @return array
*/
public function get_raw_data() {
return $this->raw_data;
}
/**
* Get parsed data.
*
* @return array
*/
public function get_parsed_data() {
2017-05-19 21:45:58 +00:00
return apply_filters( 'woocommerce_product_importer_parsed_data', $this->parsed_data, $this->get_raw_data() );
2017-05-16 04:43:45 +00:00
}
2017-05-18 16:59:40 +00:00
/**
* Get file pointer position from the last read.
*
* @return int
*/
public function get_file_position() {
return $this->file_position;
}
/**
* Get file pointer position as a percentage of file size.
*
* @return int
*/
public function get_percent_complete() {
$size = filesize( $this->file );
if ( ! $size ) {
return 0;
}
return min( round( ( $this->file_position / $size ) * 100 ), 100 );
}
2017-05-16 04:02:46 +00:00
/**
2017-05-16 04:22:00 +00:00
* Process a single item and save.
2017-05-16 04:02:46 +00:00
*
* @param array $data Raw CSV data.
* @return WC_Product|WC_Error
*/
protected function process_item( $data ) {
2017-05-19 00:09:25 +00:00
// Only update.
// @todo
$update_only = false;
2017-05-16 04:02:46 +00:00
try {
2017-05-19 00:09:25 +00:00
$object = $this->prepare_product( $data, $update_only );
2017-05-16 04:02:46 +00:00
if ( is_wp_error( $object ) ) {
return $object;
}
$object->save();
2017-05-16 04:22:00 +00:00
// Clean cache for updated products.
$this->clear_cache( $object );
2017-05-16 04:02:46 +00:00
return $object->get_id();
} catch ( WC_Data_Exception $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), $e->getErrorData() );
} catch ( Exception $e ) {
2017-05-19 21:45:58 +00:00
return new WP_Error( 'woocommerce_product_importer_error', $e->getMessage(), array( 'status' => $e->getCode() ) );
2017-05-16 04:02:46 +00:00
}
}
2017-05-16 04:22:00 +00:00
/**
* Clear product cache.
*
* @param WC_Product $object Product instance.
*/
protected function clear_cache( $object ) {
$id = $object->get_id();
2017-05-16 04:43:45 +00:00
if ( 'variation' === $object->get_type() ) {
$id = $object->get_parent_id();
2017-05-16 04:22:00 +00:00
}
wc_delete_product_transients( $id );
wp_cache_delete( 'product-' . $id, 'products' );
}
2017-05-16 04:02:46 +00:00
/**
* Prepare a single product for create or update.
*
* @param array $data Row data.
* @param bool $creating If should force create a new product.
* @return WC_Product|WP_Error
*/
2017-05-19 00:09:25 +00:00
protected function prepare_product( $data, $update_only = false ) {
$id = isset( $data['id'] ) ? absint( $data['id'] ) : 0;
// @todo
if ( $update_only && ! $id ) {
2017-05-19 21:45:58 +00:00
return new WP_Error( 'woocommerce_product_importer_product_does_not_exists', __( 'Product does not exists, to create new products disable "Update only" option.', 'woocommerce' ), array( 'status' => 404 ) );
2017-05-19 00:09:25 +00:00
}
2017-05-16 04:02:46 +00:00
// Type is the most important part here because we need to be using the correct class and methods.
if ( isset( $data['type'] ) ) {
2017-05-19 21:45:58 +00:00
if ( ! in_array( $data['type'], array_keys( wc_get_product_types() ), true ) ) {
return new WP_Error( 'woocommerce_product_importer_invalid_type', __( 'Invalid product type.', 'woocommerce' ), array( 'status' => 401 ) );
2017-05-16 04:02:46 +00:00
}
2017-05-19 21:45:58 +00:00
$classname = WC_Product_Factory::get_classname_from_product_type( $data['type'] );
2017-05-16 04:02:46 +00:00
if ( ! class_exists( $classname ) ) {
$classname = 'WC_Product_Simple';
}
$product = new $classname( $id );
} elseif ( isset( $data['id'] ) ) {
$product = wc_get_product( $id );
} else {
$product = new WC_Product_Simple();
}
if ( 'variation' === $product->get_type() ) {
2017-05-16 04:22:00 +00:00
$product = $this->save_variation_data( $product, $data );
2017-05-16 04:02:46 +00:00
} else {
2017-05-16 04:22:00 +00:00
$product = $this->save_product_data( $product, $data );
2017-05-16 04:02:46 +00:00
}
2017-05-19 21:45:58 +00:00
return apply_filters( 'woocommerce_product_import_pre_insert_product_object', $product, $data );
2017-05-16 04:02:46 +00:00
}
/**
* Set product data.
*
* @param WC_Product $product Product instance.
* @param array $data Row data.
*
* @return WC_Product
*/
2017-05-16 04:22:00 +00:00
protected function save_product_data( $product, $data ) {
2017-05-16 04:02:46 +00:00
2017-05-19 00:09:25 +00:00
// Name.
2017-05-16 04:02:46 +00:00
if ( isset( $data['name'] ) ) {
$product->set_name( wp_filter_post_kses( $data['name'] ) );
}
2017-05-19 00:09:25 +00:00
// Description.
2017-05-16 04:02:46 +00:00
if ( isset( $data['description'] ) ) {
$product->set_description( wp_filter_post_kses( $data['description'] ) );
}
2017-05-19 00:09:25 +00:00
// Short description.
2017-05-16 04:02:46 +00:00
if ( isset( $data['short_description'] ) ) {
$product->set_short_description( wp_filter_post_kses( $data['short_description'] ) );
}
2017-05-19 00:09:25 +00:00
// Status.
if ( isset( $data['published'] ) ) {
$product->set_status( $data['published'] ? 'publish' : 'draft' );
2017-05-16 04:02:46 +00:00
}
2017-05-19 00:09:25 +00:00
// Slug.
2017-05-16 04:02:46 +00:00
if ( isset( $data['slug'] ) ) {
$product->set_slug( $data['slug'] );
}
// Comment status.
if ( isset( $data['reviews_allowed'] ) ) {
$product->set_reviews_allowed( $data['reviews_allowed'] );
}
// Virtual.
2017-05-19 21:45:58 +00:00
if ( isset( $data['virtual'] ) ) {
$product->set_virtual( $data['virtual'] );
2017-05-16 04:02:46 +00:00
}
// Tax status.
if ( isset( $data['tax_status'] ) ) {
$product->set_tax_status( $data['tax_status'] );
}
// Tax Class.
if ( isset( $data['tax_class'] ) ) {
$product->set_tax_class( $data['tax_class'] );
}
// Catalog Visibility.
if ( isset( $data['catalog_visibility'] ) ) {
$product->set_catalog_visibility( $data['catalog_visibility'] );
}
// Purchase Note.
if ( isset( $data['purchase_note'] ) ) {
2017-05-19 00:09:25 +00:00
$product->set_purchase_note( $data['purchase_note'] );
2017-05-16 04:02:46 +00:00
}
// Featured Product.
if ( isset( $data['featured'] ) ) {
$product->set_featured( $data['featured'] );
}
// Shipping data.
$product = $this->save_product_shipping_data( $product, $data );
// SKU.
if ( isset( $data['sku'] ) ) {
2017-05-19 00:09:25 +00:00
$product->set_sku( $data['sku'] );
2017-05-16 04:02:46 +00:00
}
// Attributes.
2017-05-19 00:09:25 +00:00
// @todo
2017-05-16 04:02:46 +00:00
if ( isset( $data['attributes'] ) ) {
$attributes = array();
foreach ( $data['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 = wc_clean( $attribute['name'] );
}
if ( ! $attribute_id && ! $attribute_name ) {
continue;
}
if ( $attribute_id ) {
if ( isset( $attribute['options'] ) ) {
$options = $attribute['options'];
if ( ! is_array( $attribute['options'] ) ) {
// Text based attributes - Posted values are term names.
$options = explode( WC_DELIMITER, $options );
}
$values = array_map( 'wc_sanitize_term_text_based', $options );
$values = array_filter( $values, 'strlen' );
} else {
$values = array();
}
if ( ! empty( $values ) ) {
// Add attribute to array, but don't set values.
$attribute_object = new WC_Product_Attribute();
$attribute_object->set_id( $attribute_id );
$attribute_object->set_name( $attribute_name );
$attribute_object->set_options( $values );
$attribute_object->set_position( isset( $attribute['position'] ) ? (string) absint( $attribute['position'] ) : '0' );
$attribute_object->set_visible( ( isset( $attribute['visible'] ) && $attribute['visible'] ) ? 1 : 0 );
$attribute_object->set_variation( ( isset( $attribute['variation'] ) && $attribute['variation'] ) ? 1 : 0 );
$attributes[] = $attribute_object;
}
} elseif ( isset( $attribute['options'] ) ) {
// Custom attribute - Add attribute to array and set the values.
if ( is_array( $attribute['options'] ) ) {
$values = $attribute['options'];
} else {
$values = explode( WC_DELIMITER, $attribute['options'] );
}
$attribute_object = new WC_Product_Attribute();
$attribute_object->set_name( $attribute_name );
$attribute_object->set_options( $values );
$attribute_object->set_position( isset( $attribute['position'] ) ? (string) absint( $attribute['position'] ) : '0' );
$attribute_object->set_visible( ( isset( $attribute['visible'] ) && $attribute['visible'] ) ? 1 : 0 );
$attribute_object->set_variation( ( isset( $attribute['variation'] ) && $attribute['variation'] ) ? 1 : 0 );
$attributes[] = $attribute_object;
}
}
$product->set_attributes( $attributes );
}
// Sales and prices.
if ( in_array( $product->get_type(), array( 'variable', 'grouped' ), true ) ) {
$product->set_regular_price( '' );
$product->set_sale_price( '' );
$product->set_date_on_sale_to( '' );
$product->set_date_on_sale_from( '' );
$product->set_price( '' );
} else {
// Regular Price.
if ( isset( $data['regular_price'] ) ) {
$product->set_regular_price( $data['regular_price'] );
}
// Sale Price.
if ( isset( $data['sale_price'] ) ) {
$product->set_sale_price( $data['sale_price'] );
}
if ( isset( $data['date_on_sale_from'] ) ) {
$product->set_date_on_sale_from( $data['date_on_sale_from'] );
}
if ( isset( $data['date_on_sale_to'] ) ) {
$product->set_date_on_sale_to( $data['date_on_sale_to'] );
}
}
// Product parent ID for groups.
if ( isset( $data['parent_id'] ) ) {
$product->set_parent_id( $data['parent_id'] );
}
// Sold individually.
if ( isset( $data['sold_individually'] ) ) {
$product->set_sold_individually( $data['sold_individually'] );
}
// Stock status.
2017-05-19 00:09:25 +00:00
if ( isset( $data['stock_status'] ) ) {
$stock_status = $data['stock_status'] ? 'instock' : 'outofstock';
2017-05-16 04:02:46 +00:00
} else {
$stock_status = $product->get_stock_status();
}
// Stock data.
if ( 'yes' === get_option( 'woocommerce_manage_stock' ) ) {
// Manage stock.
2017-05-24 00:58:10 +00:00
if ( isset( $data['manage_stock'] ) ) {
$product->set_manage_stock( $data['manage_stock'] );
2017-05-16 04:02:46 +00:00
}
// Backorders.
if ( isset( $data['backorders'] ) ) {
$product->set_backorders( $data['backorders'] );
}
if ( $product->is_type( 'grouped' ) ) {
2017-05-19 00:09:25 +00:00
$product->set_manage_stock( false );
$product->set_backorders( false );
2017-05-16 04:02:46 +00:00
$product->set_stock_quantity( '' );
$product->set_stock_status( $stock_status );
} elseif ( $product->is_type( 'external' ) ) {
2017-05-19 00:09:25 +00:00
$product->set_manage_stock( false );
$product->set_backorders( false );
2017-05-16 04:02:46 +00:00
$product->set_stock_quantity( '' );
$product->set_stock_status( 'instock' );
} elseif ( $product->get_manage_stock() ) {
// Stock status is always determined by children so sync later.
if ( ! $product->is_type( 'variable' ) ) {
$product->set_stock_status( $stock_status );
}
// Stock quantity.
if ( isset( $data['stock_quantity'] ) ) {
$product->set_stock_quantity( wc_stock_amount( $data['stock_quantity'] ) );
}
} else {
// Don't manage stock.
2017-05-19 00:09:25 +00:00
$product->set_manage_stock( false );
2017-05-16 04:02:46 +00:00
$product->set_stock_quantity( '' );
$product->set_stock_status( $stock_status );
}
} elseif ( ! $product->is_type( 'variable' ) ) {
$product->set_stock_status( $stock_status );
}
// Upsells.
if ( isset( $data['upsell_ids'] ) ) {
2017-05-19 00:09:25 +00:00
$product->set_upsell_ids( $data['upsell_ids'] );
2017-05-16 04:02:46 +00:00
}
// Cross sells.
if ( isset( $data['cross_sell_ids'] ) ) {
2017-05-19 00:09:25 +00:00
$product->set_cross_sell_ids( $data['cross_sell_ids'] );
2017-05-16 04:02:46 +00:00
}
// Product categories.
2017-05-22 21:54:30 +00:00
if ( isset( $data['category_ids'] ) ) {
$product->set_category_ids( $data['category_ids'] );
2017-05-16 04:02:46 +00:00
}
// Product tags.
2017-05-22 21:54:30 +00:00
if ( isset( $data['tag_ids'] ) ) {
$product->set_tag_ids( $data['tag_ids'] );
2017-05-16 04:02:46 +00:00
}
// Downloadable.
if ( isset( $data['downloadable'] ) ) {
$product->set_downloadable( $data['downloadable'] );
}
// Downloadable options.
if ( $product->get_downloadable() ) {
// Downloadable files.
2017-05-24 01:31:06 +00:00
if ( isset( $data['downloads'] ) ) {
2017-05-16 04:02:46 +00:00
$product = $this->save_downloadable_files( $product, $data['downloads'] );
}
// Download limit.
if ( isset( $data['download_limit'] ) ) {
$product->set_download_limit( $data['download_limit'] );
}
// Download expiry.
if ( isset( $data['download_expiry'] ) ) {
$product->set_download_expiry( $data['download_expiry'] );
}
}
// Product url and button text for external products.
if ( $product->is_type( 'external' ) ) {
if ( isset( $data['external_url'] ) ) {
$product->set_product_url( $data['external_url'] );
}
if ( isset( $data['button_text'] ) ) {
$product->set_button_text( $data['button_text'] );
}
}
// Save default attributes for variable products.
2017-05-19 00:09:25 +00:00
// @todo
2017-05-16 04:02:46 +00:00
if ( $product->is_type( 'variable' ) ) {
$product = $this->save_default_attributes( $product, $data );
}
2017-05-24 06:14:54 +00:00
// Featured image.
if ( isset( $data['image_id'] ) ) {
$image_id = $data['image_id'] ? $this->get_attachment_id( $data['image_id'], $product->get_id() ) : '';
$product->set_image_id( $image_id );
}
// Gallery.
if ( isset( $data['gallery_image_ids'] ) ) {
$gallery_image_ids = array();
foreach ( $data['gallery_image_ids'] as $url ) {
if ( empty( $url ) ) {
continue;
}
$gallery_image_ids[] = $this->get_attachment_id( $url, $product->get_id() );
}
$product->set_gallery_image_ids( array_filter( $gallery_image_ids ) );
2017-05-16 04:02:46 +00:00
}
// Allow set meta_data.
if ( isset( $data['meta_data'] ) && is_array( $data['meta_data'] ) ) {
foreach ( $data['meta_data'] as $meta ) {
2017-05-22 22:31:05 +00:00
$product->update_meta_data( $meta['key'], $meta['value'] );
2017-05-16 04:02:46 +00:00
}
}
return $product;
}
/**
* Set variation data.
*
* @param WC_Product $variation Product instance.
* @param array $data Row data.
*
2017-05-19 00:09:25 +00:00
* @return WC_Product|WP_Error
2017-05-16 04:02:46 +00:00
*/
2017-05-16 04:22:00 +00:00
protected function save_variation_data( $variation, $data ) {
2017-05-19 00:09:25 +00:00
// Check if parent exist.
2017-05-24 00:58:10 +00:00
if ( isset( $data['parent_id'] ) && ! wc_get_product( $data['parent_id'] ) ) {
$variation->set_parent_id( $data['parent_id'] );
2017-05-16 04:22:00 +00:00
} else {
2017-05-19 00:09:25 +00:00
return new WP_Error( 'woocommerce_product_importer_missing_variation_parent_id', __( 'Missing parent ID or parent does not exist.', 'woocommerce' ), array( 'status' => 401 ) );
2017-05-16 04:22:00 +00:00
}
// Status.
if ( isset( $data['status'] ) ) {
$variation->set_status( false === $data['status'] ? 'private' : 'publish' );
}
// SKU.
if ( isset( $data['sku'] ) ) {
$variation->set_sku( wc_clean( $data['sku'] ) );
}
2017-05-24 06:14:54 +00:00
// Featured image.
if ( isset( $data['image_id'] ) ) {
$image_id = $data['image_id'] ? $this->get_attachment_id( $data['image_id'], $variation->get_id() ) : '';
$variation->set_image_id( $image_id );
2017-05-16 04:22:00 +00:00
}
// Virtual variation.
if ( isset( $data['virtual'] ) ) {
$variation->set_virtual( $data['virtual'] );
}
// Downloadable variation.
if ( isset( $data['downloadable'] ) ) {
$variation->set_downloadable( $data['downloadable'] );
}
// Downloads.
if ( $variation->get_downloadable() ) {
// Downloadable files.
2017-05-24 01:31:06 +00:00
if ( isset( $data['downloads'] ) ) {
2017-05-16 04:22:00 +00:00
$variation = $this->save_downloadable_files( $variation, $data['downloads'] );
}
// Download limit.
if ( isset( $data['download_limit'] ) ) {
$variation->set_download_limit( $data['download_limit'] );
}
// Download expiry.
if ( isset( $data['download_expiry'] ) ) {
$variation->set_download_expiry( $data['download_expiry'] );
}
}
// Shipping data.
$variation = $this->save_product_shipping_data( $variation, $data );
// Stock handling.
2017-05-24 00:58:10 +00:00
if ( isset( $data['stock_status'] ) ) {
$variation->set_stock_status( $data['stock_status'] ? 'instock' : 'outofstock' );
2017-05-16 04:22:00 +00:00
}
2017-05-24 00:58:10 +00:00
if ( 'yes' === get_option( 'woocommerce_manage_stock' ) ) {
if ( isset( $data['manage_stock'] ) ) {
$variation->set_manage_stock( $data['manage_stock'] );
}
2017-05-16 04:22:00 +00:00
2017-05-24 00:58:10 +00:00
if ( isset( $data['backorders'] ) ) {
$variation->set_backorders( $data['backorders'] );
}
2017-05-16 04:22:00 +00:00
2017-05-24 00:58:10 +00:00
if ( $variation->get_manage_stock() ) {
if ( isset( $data['stock_quantity'] ) ) {
$variation->set_stock_quantity( $data['stock_quantity'] );
}
} else {
$variation->set_backorders( 'no' );
$variation->set_stock_quantity( '' );
2017-05-16 04:22:00 +00:00
}
}
// Regular Price.
if ( isset( $data['regular_price'] ) ) {
$variation->set_regular_price( $data['regular_price'] );
}
// Sale Price.
if ( isset( $data['sale_price'] ) ) {
$variation->set_sale_price( $data['sale_price'] );
}
if ( isset( $data['date_on_sale_from'] ) ) {
$variation->set_date_on_sale_from( $data['date_on_sale_from'] );
}
if ( isset( $data['date_on_sale_from_gmt'] ) ) {
$variation->set_date_on_sale_from( $data['date_on_sale_from_gmt'] ? strtotime( $data['date_on_sale_from_gmt'] ) : null );
}
if ( isset( $data['date_on_sale_to'] ) ) {
$variation->set_date_on_sale_to( $data['date_on_sale_to'] );
}
if ( isset( $data['date_on_sale_to_gmt'] ) ) {
$variation->set_date_on_sale_to( $data['date_on_sale_to_gmt'] ? strtotime( $data['date_on_sale_to_gmt'] ) : null );
}
// Tax class.
if ( isset( $data['tax_class'] ) ) {
$variation->set_tax_class( $data['tax_class'] );
}
// Description.
if ( isset( $data['description'] ) ) {
$variation->set_description( wp_kses_post( $data['description'] ) );
}
// Update taxonomies.
2017-05-24 00:58:10 +00:00
// @todo
2017-05-16 04:22:00 +00:00
if ( isset( $data['attributes'] ) ) {
$attributes = array();
$parent = wc_get_product( $variation->get_parent_id() );
$parent_attributes = $parent->get_attributes();
foreach ( $data['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;
}
$variation->set_attributes( $attributes );
}
// Meta data.
if ( isset( $data['meta_data'] ) && is_array( $data['meta_data'] ) ) {
foreach ( $data['meta_data'] as $meta ) {
2017-05-22 22:31:05 +00:00
$variation->update_meta_data( $meta['key'], $meta['value'] );
2017-05-16 04:22:00 +00:00
}
}
2017-05-16 04:02:46 +00:00
return $variation;
}
/**
2017-05-24 06:14:54 +00:00
* Get attachment ID.
2017-05-19 00:09:25 +00:00
*
2017-05-24 06:14:54 +00:00
* @param string $url Attachment URL.
* @param int $product_id Product ID.
* @return int
2017-05-16 04:02:46 +00:00
*/
2017-05-24 06:14:54 +00:00
protected function get_attachment_id( $url, $product_id ) {
if ( empty( $url ) ) {
return 0;
}
2017-05-16 04:02:46 +00:00
2017-05-24 06:14:54 +00:00
$id = 0;
$upload_dir = wp_upload_dir();
$base_url = $upload_dir['baseurl'] . '/';
// Check first if attachment is on WordPress uploads directory.
if ( false !== strpos( $url, $base_url ) ) {
// Search for yyyy/mm/slug.extension
$file = str_replace( $base_url, '', $url );
$args = array(
'post_type' => 'attachment',
'post_status' => 'any',
'fields' => 'ids',
'meta_query' => array(
array(
'value' => $file,
'compare' => 'LIKE',
'key' => '_wp_attachment_metadata',
),
2017-05-24 06:26:17 +00:00
),
2017-05-24 06:14:54 +00:00
);
if ( $ids = get_posts( $args ) ) {
$id = current( $ids );
}
} else {
$args = array(
'post_type' => 'attachment',
'post_status' => 'any',
'fields' => 'ids',
'meta_query' => array(
array(
2017-05-24 06:26:17 +00:00
'value' => $url,
'key' => '_wc_attachment_source',
2017-05-24 06:14:54 +00:00
),
2017-05-24 06:26:17 +00:00
),
2017-05-24 06:14:54 +00:00
);
if ( $ids = get_posts( $args ) ) {
$id = current( $ids );
}
}
2017-05-16 04:02:46 +00:00
2017-05-24 06:14:54 +00:00
// Upload if attachment does not exists.
if ( ! $id ) {
$upload = wc_rest_upload_image_from_url( $url );
2017-05-16 04:02:46 +00:00
2017-05-24 06:14:54 +00:00
if ( is_wp_error( $upload ) ) {
throw new Exception( $upload->get_error_message(), 400 );
}
2017-05-16 04:02:46 +00:00
2017-05-24 06:14:54 +00:00
$id = wc_rest_set_uploaded_image_as_attachment( $upload, $product_id );
2017-05-16 04:02:46 +00:00
2017-05-24 06:14:54 +00:00
if ( ! wp_attachment_is_image( $id ) ) {
throw new Exception( sprintf( __( 'Not able to attach "%s".', 'woocommerce' ), $url ), 400 );
2017-05-16 04:02:46 +00:00
}
2017-05-24 06:14:54 +00:00
// Save attachment source for future reference.
update_post_meta( $id, '_wc_attachment_source', $url );
2017-05-16 04:02:46 +00:00
}
2017-05-24 06:14:54 +00:00
return $id;
2017-05-16 04:02:46 +00:00
}
/**
* Save product shipping data.
*
* @param WC_Product $product Product instance.
* @param array $data Shipping data.
* @return WC_Product
*/
protected function save_product_shipping_data( $product, $data ) {
// Virtual.
2017-05-19 00:09:25 +00:00
if ( $product->is_virtual() ) {
2017-05-16 04:02:46 +00:00
$product->set_weight( '' );
$product->set_height( '' );
$product->set_length( '' );
$product->set_width( '' );
} else {
if ( isset( $data['weight'] ) ) {
$product->set_weight( $data['weight'] );
}
// Height.
2017-05-16 04:22:00 +00:00
if ( isset( $data['height'] ) ) {
$product->set_height( $data['height'] );
2017-05-16 04:02:46 +00:00
}
// Width.
2017-05-16 04:22:00 +00:00
if ( isset( $data['width'] ) ) {
$product->set_width( $data['width'] );
2017-05-16 04:02:46 +00:00
}
// Length.
2017-05-16 04:22:00 +00:00
if ( isset( $data['length'] ) ) {
$product->set_length( $data['length'] );
2017-05-16 04:02:46 +00:00
}
}
// Shipping class.
2017-05-16 04:22:00 +00:00
if ( isset( $data['shipping_class_id'] ) ) {
2017-05-24 06:26:17 +00:00
$product->set_shipping_class_id( $data['shipping_class_id'] );
2017-05-16 04:02:46 +00:00
}
return $product;
}
/**
* Save downloadable files.
*
2017-05-24 01:31:06 +00:00
* @param WC_Product $product Product instance.
* @param array $downloads Downloads data.
2017-05-16 04:02:46 +00:00
* @return WC_Product
*/
2017-05-24 01:31:06 +00:00
protected function save_downloadable_files( $product, $data ) {
$downloads = array();
foreach ( $data as $key => $file ) {
if ( empty( $file['url'] ) ) {
2017-05-16 04:02:46 +00:00
continue;
}
2017-05-24 01:31:06 +00:00
$downloads[] = array(
'name' => $file['name'] ? $file['name'] : wc_get_filename_from_url( $file['url'] ),
'file' => apply_filters( 'woocommerce_file_download_path', $file['url'], $product, $key ),
);
2017-05-16 04:02:46 +00:00
}
2017-05-24 01:31:06 +00:00
$product->set_downloads( $downloads );
2017-05-16 04:02:46 +00:00
return $product;
}
/**
* Save default attributes.
*
2017-05-19 00:09:25 +00:00
* @todo
*
2017-05-16 04:02:46 +00:00
* @since 3.0.0
*
2017-05-24 01:31:06 +00:00
* @param WC_Product $product Product instance.
* @param array $data Row data.
2017-05-16 04:02:46 +00:00
* @return WC_Product
*/
2017-05-16 04:22:00 +00:00
protected function save_default_attributes( $product, $data ) {
if ( isset( $data['default_attributes'] ) && is_array( $data['default_attributes'] ) ) {
2017-05-16 04:02:46 +00:00
$attributes = $product->get_attributes();
$default_attributes = array();
2017-05-16 04:22:00 +00:00
foreach ( $data['default_attributes'] as $attribute ) {
2017-05-16 04:02:46 +00:00
$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( $attributes[ $attribute_name ] ) ) {
$_attribute = $attributes[ $attribute_name ];
if ( $_attribute['is_variation'] ) {
$value = isset( $attribute['option'] ) ? wc_clean( stripslashes( $attribute['option'] ) ) : '';
if ( ! empty( $_attribute['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', $value, $attribute_name );
if ( $term && ! is_wp_error( $term ) ) {
$value = $term->slug;
} else {
$value = sanitize_title( $value );
}
}
if ( $value ) {
$default_attributes[ $attribute_name ] = $value;
}
}
}
}
$product->set_default_attributes( $default_attributes );
}
return $product;
}
}