[#4] Implement split order by product attribute

Add custom attribute to select

Capability to use multiselect

Improve split method

Split order by custom attribute

Improve get ptoduct attribute

Add release 1.0.2

Add release 1.0.2

Improve settings descriptions

Enable capability to split shipping

Add release 1.0.2

Add release 1.0.2

Author: Willian Keller

Api/QuoteHandlerInterface.php

@@ -23,12 +23,11 @@ interface QuoteHandlerInterface
     public function normalizeQuotes($quote);
 
     /**
-     * Check if quotes should be split.
-     *
-     * @param object $quotes
-     * @return bool
+     * @param object $product
+     * @param string $attributes
+     * @return string
      */
-    public function isSplittable($quotes);
+    public function getProductAttributes($product, $attributes);
 
     /**
      * Collect list of data addresses.
@@ -48,25 +47,33 @@ public function setCustomerData($quote, $split);
     /**
      * Populate quotes with new data.
      *
+     * @param object $quotes
      * @param object $split
      * @param object $item
      * @param array $addresses
-     * @param string $paymentMethod
+     * @param string $payment
      * @return $this
      */
-    public function populateQuote($split, $item, $addresses, $paymentMethod);
+    public function populateQuote($quotes, $split, $item, $addresses, $payment);
 
     /**
      * Recollect order totals.
      *
+     * @param object $quotes
      * @param object $item
      * @param object $quote
      * @param array $addresses
-     * @param float $shippingAmount
      * @return $this
      */
-    public function recollectTotal($item, $quote, $addresses, $shippingAmount = 0);
+    public function recollectTotal($quotes, $item, $quote, $addresses);
 
+    /**
+     * @param object $quotes
+     * @param object $quote
+     * @param float $total
+     */
+    public function shippingAmount($quotes, $quote, $total = 0);
+    
     /**
      * Set payment method.
      *

CHANGELOG.md

@@ -1,6 +1,20 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [1.0.2] - 2018-08-21
+### Added
+- Option to select a product attribute to define order split.
+- Capability to split shipping totals into all orders or only one.
+
+### Fixed
+- Split shipping totals into all orders or only one.
+- Set shipping to one order only.
+
+### Changed
+- Improved module architecture.
+- Stable order submission.
+
+
 ## [1.0.1] - 2018-07-20
 ### Added
 - CMS module settings (Enable/Disable)

Helper/Data.php

@@ -12,6 +12,8 @@
 
 namespace Magestat\SplitOrder\Helper;
 
+use Magento\Store\Model\ScopeInterface;
+
 class Data extends \Magento\Framework\App\Helper\AbstractHelper
 {
     /**
@@ -28,6 +30,34 @@ public function isActive($storeId = null)
         );
     }
 
+    /**
+     * Get attributes to split.
+     *
+     * @param null $storeId
+     * @return array
+     */
+    public function getAttributes($storeId = null)
+    {
+        return $this->getConfig(
+            'magestat_split_order/options/attributes',
+            $storeId
+        );
+    }
+
+    /**
+     * Check if should split delivery.
+     *
+     * @param null $storeId
+     * @return bool
+     */
+    public function getShippingSplit($storeId = null)
+    {
+        return (bool) $this->getConfig(
+            'magestat_split_order/options/shipping',
+            $storeId
+        );
+    }
+
     /**
      * Return store configuration value.
      *
@@ -39,7 +69,7 @@ public function getConfig($path, $storeId = null)
     {
         return $this->scopeConfig->getValue(
             $path,
-            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
+            ScopeInterface::SCOPE_STORE,
             $storeId
         );
     }

Model/Config/Source/Attributes.php

@@ -0,0 +1,64 @@
+<?php
+
+/**
+ * A Magento 2 module named Magestat/SplitOrder
+ * Copyright (C) 2018 Magestat
+ *
+ * This file included in Magestat/SplitOrder is licensed under OSL 3.0
+ *
+ * http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * Please see LICENSE.txt for the full text of the OSL 3.0 license
+ */
+
+namespace Magestat\SplitOrder\Model\Config\Source;
+
+use Magento\Framework\Option\ArrayInterface;
+use Magento\Catalog\Model\ResourceModel\Product\Attribute\CollectionFactory;
+
+class Attributes implements ArrayInterface
+{
+    /**
+     * @var array
+     */
+    protected $options;
+
+    /**
+     * @var \Magento\Catalog\Model\ResourceModel\Product\Attribute\CollectionFactory
+     */
+    protected $collection;
+
+    /**
+     * @param CollectionFactory $collectionFactory
+     */
+    public function __construct(
+        CollectionFactory $collectionFactory
+    ) {
+        $this->collection = $collectionFactory;
+    }
+
+    /**
+     * Get options as array
+     *
+     * @return array
+     */
+    public function toOptionArray($isMultiselect = false)
+    {
+        if (!$this->options) {
+            $collection = $this->collection->create();
+
+            foreach ($collection as $items) {
+                $attributes[] = [
+                    'value' => $items->getAttributeCode(),
+                    'label' => $items->getFrontendLabel()
+                ];
+            }
+            $this->options = $attributes;
+        }
+
+        $options = $this->options;
+        if (!$isMultiselect) {
+            array_unshift($options, ['value' => '', 'label' => __('--Please Select--')]);
+        }
+        return $options;
+    }
+}

Model/QuoteHandler.php

@@ -13,6 +13,8 @@
 namespace Magestat\SplitOrder\Model;
 
 use Magento\Checkout\Model\Session as CheckoutSession;
+use Magento\Quote\Api\CartManagementInterface;
+use Magento\Customer\Api\Data\GroupInterface;
 use Magestat\SplitOrder\Api\QuoteHandlerInterface;
 use Magestat\SplitOrder\Helper\Data as HelperData;
 
@@ -45,23 +47,44 @@ public function __construct(
      */
     public function normalizeQuotes($quote)
     {
+        // if module is active.
+        if (!$this->helperData->isActive()) {
+            return false;
+        }
+        $attributes = $this->helperData->getAttributes();
+        if (empty($attributes)) {
+            return false;
+        }
+
         $groups = [];
         foreach ($quote->getAllVisibleItems() as $item) {
-            $groups[$item->getProduct()->getSku()][] = $item;
+            $product = $item->getProduct();
+
+            $attribute = $this->getProductAttributes($product, $attributes);
+            if (empty($attribute)) {
+                // Kill function if attribute is null.
+                return false;
+            }
+            $groups[$attribute][] = $item;
         }
-        return $groups;
+        // If order have more than one item.
+        if (count($groups) > 1) {
+            return $groups;
+        }
+        return false;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function isSplittable($quotes)
+    public function getProductAttributes($product, $attributes)
     {
-        // If module is active and order have more than one item.
-        if ($this->helperData->isActive() && count($quotes) > 1) {
-            return true;
-        }
-        return false;
+        $attribute = $product->getResource()
+            ->getAttribute($attributes)
+            ->getFrontend()
+            ->getValue($product);
+
+        return $attribute;
     }
 
     /**
@@ -93,32 +116,31 @@ public function setCustomerData($quote, $split)
         $split->setCustomer($quote->getCustomer());
         $split->setCustomerIsGuest($quote->getCustomerIsGuest());
 
-        if ($quote->getCheckoutMethod() === \Magento\Quote\Api\CartManagementInterface::METHOD_GUEST) {
+        if ($quote->getCheckoutMethod() === CartManagementInterface::METHOD_GUEST) {
             $split->setCustomerId(null);
             $split->setCustomerEmail($quote->getBillingAddress()->getEmail());
             $split->setCustomerIsGuest(true);
-            $split->setCustomerGroupId(\Magento\Customer\Api\Data\GroupInterface::NOT_LOGGED_IN_ID);
+            $split->setCustomerGroupId(GroupInterface::NOT_LOGGED_IN_ID);
         }
         return $this;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function populateQuote($split, $item, $addresses, $paymentMethod)
+    public function populateQuote($quotes, $split, $item, $addresses, $payment)
     {
-        $this->recollectTotal($item, $split, $addresses);
-
+        $this->recollectTotal($quotes, $item, $split, $addresses);
         // Set payment method.
-        $this->setPaymentMethod($split, $addresses['payment'], $paymentMethod);
+        $this->setPaymentMethod($split, $addresses['payment'], $payment);
 
         return $this;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function recollectTotal($item, $quote, $addresses, $shippingAmount = 0)
+    public function recollectTotal($quotes, $item, $quote, $addresses)
     {
         // Retrieve values.
         $tax      = $item->getData('tax_amount');
@@ -131,14 +153,12 @@ public function recollectTotal($item, $quote, $addresses, $shippingAmount = 0)
         $quote->getShippingAddress()->setData($addresses['shipping']);
 
         // Add shipping amount if product is not virual.
-        if ($quote->hasVirtualItems() === false) {
-            $shippingAmount = $quote->getShippingAddress()->getShippingAmount();
-        }
+        $shipping = $this->shippingAmount($quotes, $quote);
 
         // Recollect totals into the quote.
         foreach ($quote->getAllAddresses() as $address) {
             // Build grand total.
-            $grandTotal = (($finalPrice + $shippingAmount + $tax) - $discount);
+            $grandTotal = (($finalPrice + $shipping + $tax) - $discount);
 
             $address->setBaseSubtotal($finalPrice);
             $address->setSubtotal($finalPrice);
@@ -150,7 +170,39 @@ public function recollectTotal($item, $quote, $addresses, $shippingAmount = 0)
         }
         return $this;
     }
- 
+
+    /**
+     * {@inheritdoc}
+     */
+    public function shippingAmount($quotes, $quote, $total = 0)
+    {
+        // Add shipping amount if product is not virual.
+        if ($quote->hasVirtualItems() === true) {
+            return $total;
+        }
+        $shippingTotals = $quote->getShippingAddress()->getShippingAmount();
+
+        // If not, set shipping to one order only.
+        if (!$this->helperData->getShippingSplit()) {
+            static $process = 1;
+
+            if ($process > 1) {
+                // Set zero price to next orders.
+                $quote->getShippingAddress()->setShippingAmount($total);
+                return $total;
+            }
+            $process ++;
+
+            return $shippingTotals;
+        }
+        if ($shippingTotals > 0) {
+            // Divide shippinto to each order.
+            $total = (float) ($shippingTotals / count($quotes));
+            $quote->getShippingAddress()->setShippingAmount($total);
+        }
+        return $total;
+    }
+
     /**
      * {@inheritdoc}
      */

Plugin/SplitQuote.php

@@ -65,21 +65,18 @@ public function __construct(
      * @param QuoteManagement $subject
      * @param callable $proceed
      * @param int $cartId
-     * @param string $paymentMethod
+     * @param string $payment
      * @return mixed
      * @throws LocalizedException
      */
-    public function aroundPlaceOrder(QuoteManagement $subject, callable $proceed, $cartId, $paymentMethod = null)
+    public function aroundPlaceOrder(QuoteManagement $subject, callable $proceed, $cartId, $payment = null)
     {
         $quote = $this->quoteRepository->getActive($cartId);
 
         // Separate all items in quote into new quotes.
-        $quotes = $this->quoteHandler->normalizeQuotes($quote);
-
-        if (!$this->quoteHandler->isSplittable($quotes)) {
-            return $result = $proceed($cartId, $paymentMethod);
+        if (($quotes = $this->quoteHandler->normalizeQuotes($quote)) === false) {
+            return $result = $proceed($cartId, $payment);
         }
-
         // Collect list of data addresses.
         $addresses = $this->quoteHandler->collectAddressesData($quote);
 
@@ -99,9 +96,8 @@ public function aroundPlaceOrder(QuoteManagement $subject, callable $proceed, $c
                 $item->setId(null);
                 $split->addItem($item);
             }
-
             // Recollect order totals.
-            $this->quoteHandler->populateQuote($split, $item, $addresses, $paymentMethod);
+            $this->quoteHandler->populateQuote($quotes, $split, $item, $addresses, $payment);
 
             // Dispatch event as Magento standard once per each quote split.
             $this->eventManager->dispatch(

composer.json

@@ -13,7 +13,7 @@
     "license": [
         "OSL-3.0"
     ],
-    "version": "1.0.1",
+    "version": "1.0.2",
     "authors": [
         {
             "name": "Magestat",