providerbuilderbase.php

<?php
 
namespace Bitrix\Sale\Internals;
 
use Bitrix\Main;
use Bitrix\Sale;
 
abstract class ProviderBuilderBase
{
    protected $items = array();
    protected $providerClass = null;
    protected $callbackFunction = null;
    protected $context = array();
 
    public static function createBuilder($providerClass, $context)
    {
        if ($providerClass && ($providerClass instanceof Sale\SaleProviderBase))
        {
            $builder = ProviderBuilder::create($providerClass, $context);
        }
        else
        {
            $builder = ProviderBuilderCompatibility::create($providerClass, $context);
        }
 
        return $builder;
    }
 
    public static function create($providerClass, $context)
    {
        $builder = new static();
 
        if ($providerClass && !is_string($providerClass))
        {
            $builder->providerClass = $providerClass;
        }
        $builder->context = $context;
 
        return $builder;
    }
 
    protected function callTransferMethod($className, $methodName, Sale\Result $result = null)
    {
        if (!class_exists($className))
        {
            throw new Main\ArgumentOutOfRangeException('className');
        }
 
        $transfer = $className::create($this->getProviderClass(), $this->getContext());
        if (!method_exists($transfer, $methodName))
        {
            throw new Main\ArgumentOutOfRangeException('methodName');
        }
 
        if ($result)
        {
            $r = $transfer->$methodName($this->getItems(), $result);
        }
        else
        {
            $r = $transfer->$methodName($this->getItems());
        }
 
        return $r;
 
    }
 
    abstract public function addProductByBasketItem(Sale\BasketItemBase $basketItem);
 
    abstract public function addProductByShipmentItem(Sale\ShipmentItem $shipmentItem);
 
    abstract public function addProductData(array $productData);
 
    public function addBasketItemBarcodeData(array $barcodeParams)
    {
        $this->addItem($barcodeParams['PRODUCT_ID'], $barcodeParams);
    }
 
    public function addProductById($productId)
    {
        $fields = array(
            'PRODUCT_ID' => $productId,
        );
 
        $this->addItem($productId, $fields);
    }
 
    public function getProductData($outputName)
    {
        $r = static::callTransferMethod($this->getTransferClassName(), 'getProductData');
        if (!$r->isSuccess())
        {
            return $r;
        }
 
        return $this->decomposeIntoProvider($r, $outputName);
    }
 
    public function getAvailableQuantity($outputName)
    {
        $r = static::callTransferMethod($this->getTransferClassName(), 'getAvailableQuantity');
        if (!$r->isSuccess())
        {
            return $r;
        }
 
        return $this->decomposeIntoProvider($r, $outputName);
    }
 
    public function getAvailableQuantityByStore($outputName)
    {
        $r = static::callTransferMethod($this->getTransferClassName(), 'getAvailableQuantityByStore');
        if (!$r->isSuccess())
        {
            return $r;
        }
 
        return $this->decomposeIntoProvider($r, $outputName);
    }
 
    public function getAvailableQuantityAndPrice($outputName)
    {
        $r = static::callTransferMethod($this->getTransferClassName(), 'getAvailableQuantityAndPrice');
        if (!$r->isSuccess())
        {
            return $r;
        }
 
        return $this->decomposeIntoProvider($r, $outputName);
    }
 
    protected function decomposeIntoProvider(Sale\Result $resultProvider, $outputName)
    {
        $result = new Sale\Result();
        $providerData = $resultProvider->getData();
 
        if (empty($providerData[$outputName]))
        {
            return $result;
        }
 
        $result->setData($providerData);
        return $result;
    }
 
    public function tryShip()
    {
        return static::callTransferMethod($this->getTransferClassName(), 'tryShip');
    }
 
    public function isNeedShip()
    {
        return static::callTransferMethod($this->getTransferClassName(), 'isNeedShip');
    }
 
    public function getBundleItems()
    {
        return static::callTransferMethod($this->getTransferClassName(), 'getBundleItems');
    }
 
    public function deliver()
    {
        return static::callTransferMethod($this->getTransferClassName(), 'deliver');
    }
 
    public function viewProduct()
    {
        return static::callTransferMethod($this->getTransferClassName(), 'viewProduct');
    }
 
    public function getProductStores()
    {
        return static::callTransferMethod($this->getTransferClassName(), 'getProductStores');
    }
 
    public function checkBarcode()
    {
        return static::callTransferMethod($this->getTransferClassName(), 'checkBarcode');
    }
 
 
    public function recurring()
    {
        return static::callTransferMethod($this->getTransferClassName(), 'recurring');
    }
 
    public function writeOffProductBatches(): Main\Result
    {
        return static::callTransferMethod($this->getTransferClassName(), 'writeOffProductBatches');
    }
 
    public function returnProductBatches(): Main\Result
    {
        return static::callTransferMethod($this->getTransferClassName(), 'returnProductBatches');
    }
 
    abstract public function setItemsResultAfterTryShip(PoolQuantity $pool, array $productTryShipList);
 
    public function setItemsResultAfterShip(Sale\Result $result)
    {
        return static::callTransferMethod($this->getTransferClassName(), 'setItemsResultAfterShip', $result);
    }
 
    public function reserve()
    {
        return static::callTransferMethod($this->getTransferClassName(), 'reserve');
    }
 
    public function ship()
    {
        return static::callTransferMethod($this->getTransferClassName(), 'ship');
    }
 
    public function createItemsResultAfterDeliver(Sale\Result $resultAfterDeliver)
    {
        $result = new Sale\Result();
        $resultList = array();
        $products = $this->getItems();
 
        if (empty($products))
        {
            return $result;
        }
 
        $resultDeliverData = $resultAfterDeliver->getData();
 
        foreach ($products as $productId => $productData)
        {
            $providerName = $this->getProviderName();
            if (empty($resultDeliverData['DELIVER_PRODUCTS_LIST']) ||
                empty($resultDeliverData['DELIVER_PRODUCTS_LIST'][$providerName]) ||
                !array_key_exists($productId, $resultDeliverData['DELIVER_PRODUCTS_LIST'][$providerName]))
            {
                continue;
            }
 
            if (empty($productData['SHIPMENT_ITEM_LIST']))
            {
                continue;
            }
 
            foreach ($productData['SHIPMENT_ITEM_LIST'] as $shipmentItemIndex => $shipmentItem)
            {
                $basketItem = $shipmentItem->getBasketItem();
 
                if (!$basketItem)
                {
                    throw new Main\ObjectNotFoundException('Entity "BasketItem" not found');
                }
 
                $resultList[$basketItem->getBasketCode()] = $resultDeliverData['DELIVER_PRODUCTS_LIST'][$providerName][$productId];
            }
        }
 
        if (!empty($resultList))
        {
            $result->setData(
                array(
                    'RESULT_AFTER_DELIVER_LIST' => $resultList
                )
            );
        }
 
        return $result;
    }
 
    protected function addProduct(array $productData)
    {
        $this->items[$productData['PRODUCT_ID']] = $productData;
    }
 
    public function getProviderClass()
    {
        return $this->providerClass;
    }
 
    public function getCallbackFunction()
    {
        return $this->callbackFunction;
    }
 
    public function getProviderName()
    {
        $providerName = null;
        $providerClass = $this->getProviderClass();
        if ($providerClass)
        {
            $reflect = new \ReflectionClass($this->getProviderClass());
            $providerName = $reflect->getName();
        }
 
        return  $this->clearProviderName($providerName);
    }
 
    protected function clearProviderName($providerName)
    {
        if (is_string($providerName) && mb_substr($providerName, 0, 1) == "\\")
        {
            $providerName = mb_substr($providerName, 1);
        }
 
        return $providerName;
    }
 
 
    protected function getContext()
    {
        return $this->context;
    }
 
    protected function getItems()
    {
        return $this->items;
    }
 
    protected function addItem($productId, array $productData)
    {
        $fields = array();
        if (isset($this->items[$productId]))
        {
            $fields = $this->items[$productId];
        }
 
        $fields = $productData + $fields;
 
        if (isset($fields['QUANTITY_LIST'][$productData['BASKET_CODE']]))
        {
            $fields['QUANTITY_LIST'][$productData['BASKET_CODE']] += (float)$productData['QUANTITY'];
        }
        else
        {
            $fields['QUANTITY_LIST'][$productData['BASKET_CODE']] = (float)$productData['QUANTITY'];
        }
 
        unset($fields['QUANTITY']);
 
        if (isset($fields['QUANTITY_LIST_BY_STORE'][$productData['BASKET_CODE']]))
        {
            foreach ($productData['QUANTITY_BY_STORE'] as $storeId => $quantity)
            {
                if (!isset($fields['QUANTITY_LIST_BY_STORE'][$productData['BASKET_CODE']][$storeId]))
                {
                    $fields['QUANTITY_LIST_BY_STORE'][$productData['BASKET_CODE']][$storeId] = 0;
                }
 
                $fields['QUANTITY_LIST_BY_STORE'][$productData['BASKET_CODE']][$storeId] += $quantity;
            }
        }
        else
        {
            $fields['QUANTITY_LIST_BY_STORE'][$productData['BASKET_CODE']] = $productData['QUANTITY_BY_STORE'] ?? [];
        }
 
        unset($fields['QUANTITY_BY_STORE']);
 
        if (isset($fields['RESERVED_QUANTITY_LIST'][$productData['BASKET_CODE']]))
        {
            $fields['RESERVED_QUANTITY_LIST'][$productData['BASKET_CODE']] += (float)$productData['RESERVED_QUANTITY'];
        }
        else
        {
            $fields['RESERVED_QUANTITY_LIST'][$productData['BASKET_CODE']] = (float)($productData['RESERVED_QUANTITY'] ?? 0.0);
        }
 
        unset($fields['RESERVED_QUANTITY']);
 
        if (isset($fields['RESERVED_QUANTITY_LIST_BY_STORE'][$productData['BASKET_CODE']]))
        {
            foreach ($productData['RESERVED_QUANTITY_BY_STORE'] as $storeId => $quantity)
            {
                if (!isset($fields['RESERVED_QUANTITY_LIST_BY_STORE'][$productData['BASKET_CODE']][$storeId]))
                {
                    $fields['RESERVED_QUANTITY_LIST_BY_STORE'][$productData['BASKET_CODE']][$storeId] = 0;
                }
 
                $fields['RESERVED_QUANTITY_LIST_BY_STORE'][$productData['BASKET_CODE']][$storeId] += $quantity;
            }
        }
        else
        {
            $fields['RESERVED_QUANTITY_LIST_BY_STORE'][$productData['BASKET_CODE']] = $productData['RESERVED_QUANTITY_BY_STORE'] ?? [];
        }
 
        unset($fields['RESERVED_QUANTITY_BY_STORE']);
 
        if (isset($productData['SHIPMENT_ITEM']))
        {
            $shipmentItem = $productData['SHIPMENT_ITEM'];
            unset($fields['SHIPMENT_ITEM']);
 
            $fields['SHIPMENT_ITEM_LIST'][$shipmentItem->getInternalIndex()] = $shipmentItem;
            $fields['SHIPMENT_ITEM_QUANTITY_LIST'][$shipmentItem->getInternalIndex()] = (float)$productData['QUANTITY'];
        }
 
        if (isset($productData['STORE_DATA']))
        {
            if (!isset($fields['STORE_DATA_LIST']))
            {
                $fields['STORE_DATA_LIST'] = array();
            }
 
            $fields['STORE_DATA_LIST'] = $productData['STORE_DATA'] + $fields['STORE_DATA_LIST'];
            unset($fields['STORE_DATA']);
        }
 
        if (isset($productData['IS_BARCODE_MULTI']) && !isset($fields['IS_BARCODE_MULTI']))
        {
            $fields['IS_BARCODE_MULTI'] = $productData['IS_BARCODE_MULTI'];
        }
 
        if (isset($productData['SHIPMENT_ITEM_DATA']))
        {
            if (!isset($fields['SHIPMENT_ITEM_DATA_LIST']))
            {
                $fields['SHIPMENT_ITEM_DATA_LIST'] = array();
            }
 
            $fields['SHIPMENT_ITEM_DATA_LIST'] = $productData['SHIPMENT_ITEM_DATA'] + $fields['SHIPMENT_ITEM_DATA_LIST'];
            unset($fields['SHIPMENT_ITEM_DATA']);
        }
 
        if (isset($productData['NEED_RESERVE']))
        {
            if (!isset($fields['NEED_RESERVE_LIST']))
            {
                $fields['NEED_RESERVE_LIST'] = [];
            }
 
            $fields['NEED_RESERVE_LIST'] = $productData['NEED_RESERVE'] + $fields['NEED_RESERVE_LIST'];
 
            unset($fields['NEED_RESERVE']);
        }
 
        if (isset($productData['NEED_RESERVE_BY_STORE']))
        {
            if (!isset($fields['NEED_RESERVE_BY_STORE_LIST']))
            {
                $fields['NEED_RESERVE_BY_STORE_LIST'] = [];
            }
 
            $fields['NEED_RESERVE_BY_STORE_LIST'] = $productData['NEED_RESERVE_BY_STORE'] + $fields['NEED_RESERVE_BY_STORE_LIST'];
 
            unset($fields['NEED_RESERVE_BY_STORE']);
        }
 
        $this->items[$productId] = $fields;
    }
 
    protected function getItem($productId)
    {
        $item = false;
        if ($this->isExistsProductIdInItems($productId))
        {
            $item = $this->items[$productId];
        }
        return $item;
    }
 
    protected function isExistsProductIdInItems($productId)
    {
        return (isset($this->items[$productId]));
    }
 
    public static function getClassName()
    {
        return get_called_class();
    }
 
    abstract public function getTransferClassName();
}