Merge pull request #160 from BeAPI/ver/7.1.0

Release 7.1.0

Author: petitphp

.plugin-data

@@ -1,4 +1,4 @@
 {
-    "version": "7.0.0",
+    "version": "7.1.0",
     "slug": "shopping-feed"
 }

readme.md

@@ -3,11 +3,11 @@
 * Contributors: ShoppingFeed, BeAPI
 * Tags: shoppingfeed, marketplace, woocommerce, products feed, import orders
 * Description: WordPress connection Controller Plugin for ShoppingFeed – Sell on Amazon, Ebay, Google, and 1000’s of international marketplaces
-* Stable tag: 7.0.0
-* Version: 7.0.0
+* Stable tag: 7.1.0
+* Version: 7.1.0
 * Requires PHP: 7.3
 * Requires at least: 5.7
-* Tested up to: 6.7
+* Tested up to: 6.8
 * WC requires at least: 7.0
 * WC tested up to: 9.6.0
 * License: GPL v2 or later
@@ -19,6 +19,16 @@
 
 ## Changelog
 
+### 7.1.0
+
+#### Enhancements
+
+* **Feed** : Allow extra attributes to be added to the feed for variations.
+
+#### Fixes
+
+* **Order** : Check for reference alias in itemsReferencesAliases when importing order.
+
 ### 7.0.0
 
 Adds support for multilingual product feeds.
@@ -330,16 +340,55 @@ function your_custom_tracking_url_function() {
     return ‘your_custom_order_meta_key’
 }
 ```
-
 ### Extra Fields
-If you want to add an extra fields to your XML Feed, you can use the following snippet
+
+#### Add extra fields for products in product feed
+
+If you want to add an extra fields to products in your XML Feed, you can use the following snippet :
+
 ```php
-add_filter( 'shopping_feed_extra_fields', 'your_custom_fields_function', 10, 2 );
+add_filter( 'shopping_feed_extra_fields', 'sf_product_extra_fields', 10, 2 );
 
-/** @return array */
-function your_custom_fields_function($fields, $wc_product) {
-    $fields[] = array('name'=>'my_field', 'value'=>'my_value');
-    return $fields;
+/**
+ * Include additional fields for products in product feed.
+ *
+ * @param array $fields
+ * @param \WC_Product $product
+ *
+ * @return array
+ */
+function sf_product_extra_fields( $fields, $product ) {
+	$fields[] = array(
+		'name'  => 'my_custom_product_field',
+		'value'  => 'my_custom_value',
+	);
+
+	return $fields;
+}
+```
+
+#### Add extra fields for variations in product feed
+
+If you want to add an extra fields to variations in your XML Feed, you can use the following snippet :
+
+```php
+add_filter( 'shopping_feed_variation_extra_fields', 'sf_product_variation_extra_fields', 10, 2 );
+
+/**
+ * Include additional fields for variation in product feed.
+ *
+ * @param array $fields
+ * @param \WC_Product $variation
+ *
+ * @return array
+ */
+function sf_product_variation_extra_fields( $fields, $variation ) {
+	$fields[] = array(
+		'name'  => 'my_custom_variation_field',
+		'value'  => 'my_custom_value',
+	);
+
+	return $fields;
 }
 ```
 

readme.txt

@@ -2,11 +2,11 @@
 Contributors: ShoppingFeed, BeAPI
 Tags: shoppingfeed, marketplace, woocommerce, products feed, import orders
 Description: WordPress connection Controller Plugin for ShoppingFeed – Sell on Amazon, Ebay, Google, and 1000’s of international marketplaces
-Stable tag: 7.0.0
-Version: 7.0.0
+Stable tag: 7.1.0
+Version: 7.1.0
 Requires PHP: 7.3
 Requires at least: 5.7
-Tested up to: 6.7
+Tested up to: 6.8
 WC requires at least: 7.0
 WC tested up to: 9.6.0
 License: GPL v2 or later
@@ -17,6 +17,16 @@ Version 6.0.0 is a major version, there are several changes and improvements whi
 
 == Changelog ==
 
+= 7.1.0 =
+
+#### Enhancements
+
+* **Feed** : Allow extra attributes to be added to the feed for variations.
+
+#### Fixes
+
+* **Order** : Check for reference alias in itemsReferencesAliases when importing order.
+
 = 7.0.0 =
 
 Adds support for multilingual product feeds.
@@ -336,15 +346,54 @@ function your_custom_tracking_url_function() {
 `
 
 ### Extra Fields
-If you want to add an extra fields to your XML Feed, you can use the following snippet
+
+#### Add extra fields for products in product feed
+
+If you want to add an extra fields to products in your XML Feed, you can use the following snippet :
 
 `
-add_filter( 'shopping_feed_extra_fields', 'your_custom_fields_function', 10, 2 );
+add_filter( 'shopping_feed_extra_fields', 'sf_product_extra_fields', 10, 2 );
 
-/** @return array */
-function your_custom_fields_function($fields, $wc_product) {
-    $fields[] = array('name'=>'my_field', 'value'=>'my_value');
-    return $fields;
+/**
+ * Include additional fields for products in product feed.
+ *
+ * @param array $fields
+ * @param \WC_Product $product
+ *
+ * @return array
+ */
+function sf_product_extra_fields( $fields, $product ) {
+	$fields[] = array(
+		'name'  => 'my_custom_product_field',
+		'value'  => 'my_custom_value',
+	);
+
+	return $fields;
+}
+`
+
+#### Add extra fields for variations in product feed
+
+If you want to add an extra fields to variations in your XML Feed, you can use the following snippet :
+
+`
+add_filter( 'shopping_feed_variation_extra_fields', 'sf_product_variation_extra_fields', 10, 2 );
+
+/**
+ * Include additional fields for variation in product feed.
+ *
+ * @param array $fields
+ * @param \WC_Product $variation
+ *
+ * @return array
+ */
+function sf_product_variation_extra_fields( $fields, $variation ) {
+	$fields[] = array(
+		'name'  => 'my_custom_variation_field',
+		'value'  => 'my_custom_value',
+	);
+
+	return $fields;
 }
 `
 

shoppingfeed.php

@@ -7,7 +7,7 @@
  * Author URI:           https://www.shopping-feed.com/
  * Text Domain:          shopping-feed
  * Domain Path:          /languages
- * Version:              7.0.0
+ * Version:              7.1.0
  * Requires at least:    5.7
  * Requires PHP:         7.3
  * WC requires at least: 5.1.0
@@ -26,7 +26,7 @@
 	require_once plugin_dir_path( __FILE__ ) . '/vendor/autoload.php';
 }
 
-define( 'SF_VERSION', '7.0.0' );
+define( 'SF_VERSION', '7.1.0' );
 define( 'SF_DB_VERSION_SLUG', 'SF_DB_VERSION' );
 define( 'SF_DB_VERSION', '1.0.0' );
 define( 'SF_UPGRADE_RUNNING', 'SF_UPGRADE_RUNNING' );

src/Feed/Generator.php

@@ -155,7 +155,6 @@ function (
 						$product->setAttribute( $field['name'], $field['value'] );
 					}
 				}
-
 			}
 		);
 
@@ -206,6 +205,14 @@ function (
 					if ( ! empty( $sf_product_variation['height'] ) ) {
 						$variation->setAttribute( 'height', (string) $sf_product_variation['height'] );
 					}
+					if ( ! empty( $sf_product_variation['extra'] ) ) {
+						foreach ( $sf_product_variation['extra'] as $field ) {
+							if ( empty( $field['name'] ) ) {
+								continue;
+							}
+							$variation->setAttribute( $field['name'], $field['value'] );
+						}
+					}
 				}
 			}
 		);

src/Orders/Order/Products.php

@@ -45,14 +45,16 @@ public function __construct( $sf_order, $include_vat = false ) {
 	 * Set Products
 	 */
 	private function set_products() {
-		$this->products = array();
+		$this->products     = array();
+		$references_aliases = $this->sf_order->getItemsReferencesAliases();
 		foreach ( $this->sf_order->getItems() as $sf_product ) {
-			$product = $this->mapping_product( $sf_product );
+			$product = $this->mapping_product( $sf_product, $references_aliases );
 			if ( empty( $product ) ) {
 				ShoppingFeedHelper::get_logger()->error(
 					sprintf(
-					/* translators: %1$1s: Product reference. %2$2s: Order id. */
-						__( 'cant match product  %1$1s => in order %2$2s', 'shopping-feed' ),
+						/* translators: %1$s: product reference or alias, %2$s: original product reference, %3$s: order id. */
+						__( 'Can\'t match product "%1$s" (original ref: %2$s) in order %3$s', 'shopping-feed' ),
+						( $references_aliases[ $sf_product->getReference() ] ?? $sf_product->getReference() ),
 						$sf_product->getReference(),
 						$this->sf_order->getId()
 					),
@@ -62,19 +64,22 @@ private function set_products() {
 				);
 				continue;
 			}
-			$this->products[] = $this->mapping_product( $sf_product );
+
+			$this->products[] = $product;
 		}
 	}
 
 	/**
-	 * @param $sf_product OrderItem
+	 * Map products in SF order to Woocommerce products.
+	 *
+	 * @param OrderItem $sf_product
+	 * @param array $references_aliases
 	 *
 	 * @return array
 	 */
-	private function mapping_product( $sf_product ) {
-
+	private function mapping_product( $sf_product, $references_aliases = [] ) {
 		$product_identifier = ShoppingFeedHelper::get_sf_feed_product_identifier();
-		$wc_product_id      = $sf_product->getReference();
+		$wc_product_id      = $references_aliases[ $sf_product->getReference() ] ?? $sf_product->getReference();
 
 		if ( 'sku' === $product_identifier ) {
 			$wc_product_id = wc_get_product_id_by_sku( $wc_product_id );
@@ -116,6 +121,7 @@ private function mapping_product( $sf_product ) {
 			'args'         => $args,
 			'is_available' => $wc_product->is_in_stock() && $wc_product->has_enough_stock( $sf_product_quantity ),
 			'sf_ref'       => $sf_product->getReference(),
+			'wc_ref'       => $references_aliases[ $sf_product->getReference() ] ?? $sf_product->getReference(),
 		);
 	}
 

src/Products/Product.php

@@ -493,6 +493,7 @@ public function get_variations( $for_feed = false ) {
 			$variation_data['image_main'] = apply_filters( 'shopping_feed_variation_main_image', $main_image, $variation, $product );
 
 			$variation_data['attributes'] = $this->get_variation_attributes( $variation );
+			$variation_data['extra'] = $this->get_variation_extra_fields( $variation );
 			$variations[]                 = $variation_data;
 		}
 
@@ -544,6 +545,23 @@ public function get_extra_fields() {
 		return apply_filters( 'shopping_feed_extra_fields', [], $this->product );
 	}
 
+	/**
+	 * Get variation extra fields
+	 *
+	 * @param \WC_Product_Variation $variation
+	 *
+	 * @return array
+	 */
+	public function get_variation_extra_fields( $variation ) {
+		/**
+		 * Filter extra fields written in the feed for the variation.
+		 *
+		 * @param array $extra_fields
+		 * @param \WC_Product_Variation $variation
+		 */
+		return apply_filters( 'shopping_feed_variation_extra_fields', [], $variation );
+	}
+
 	/**
 	 * Get product's stock quantity.
 	 *