EbayEnterprise_Inventory_Model_Observer

Complexity

Total Complexity

20

Size/Duplication

Total Lines	240
Duplicated Lines	10.83 %

Coupling/Cohesion

Components	2
Dependencies	5

12 Methods

Rating	Name	Duplication	Size	Complexity
A	nullCoalesce()	0	4	2
B	__construct()	26	26	1
A	checkTypes()	0	10	1
B	handleBeforeCollectTotals()	0	30	4
A	handleAdminOrderException()	0	13	3
A	getAdminQuoteSession()	0	7	2
A	handleEbayEnterpriseOrderCreateItem()	0	11	1
A	getItemForLookup()	0	7	2
A	handleEbayEnterpriseTaxItemShipOrigin()	0	8	1
A	handleSalesOrderPlaceBefore()	0	7	1
A	handleSalesModelServiceQuoteSubmitFailure()	0	5	1
A	handleEbayEnterpriseOrderCreateSuccessful()	0	7	1

<?php
/**
 * Copyright (c) 2013-2014 eBay Enterprise, Inc.
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * @copyright   Copyright (c) 2013-2014 eBay Enterprise, Inc. (http://www.ebayenterprise.com/)
 * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 */

class EbayEnterprise_Inventory_Model_Observer
{
    /** @var EbayEnterprise_Inventory_Model_Quantity_Service */
    protected $quantityService;
    /** @var EbayEnterprise_Inventory_Model_Details_Service */
    protected $detailsService;
    /** @var EbayEnterprise_Inventory_Model_Allocation_Service */
    protected $allocationService;
    /** @var EbayEnterprise_MageLog_Helper_Data */
    protected $logger;
    /** @var EbayEnterprise_MageLog_Helper_Context */
    protected $logContext;
    /** @var Mage_Core_Model_App */
    protected $app;
    /** @var Mage_Adminhtml_Model_Session_Quote */
    protected $adminQuoteSession;

    /**
     * @param array $args May contain:
     *                    - quantity_service => EbayEnterprise_Inventory_Model_Quantity_Service
     *                    - details_service => EbayEnterprise_Inventory_Model_Details_Service
     *                    - logger => EbayEnterprise_MageLog_Helper_Data
     *                    - log_context => EbayEnterprise_MageLog_Helper_Context
     */
    public function __construct(array $args = [])

This method seems to be duplicated in your project.

    {
        list(
            $this->quantityService,
            $this->detailsService,
            $this->allocationService,
            $this->logger,
            $this->logContext,
            $this->app
        ) = $this->checkTypes(
            $this->nullCoalesce(
                $args,
                'quantity_service',
                Mage::getModel('ebayenterprise_inventory/quantity_service')
            ),
            $this->nullCoalesce($args, 'details_service', Mage::getModel('ebayenterprise_inventory/details_service')),
            $this->nullCoalesce(
                $args,
                'allocation_service',
                Mage::getModel('ebayenterprise_inventory/allocation_service')
            ),
            $this->nullCoalesce($args, 'logger', Mage::helper('ebayenterprise_magelog')),
            $this->nullCoalesce($args, 'log_context', Mage::helper('ebayenterprise_magelog/context')),
            Mage::app()
        );
    }

    /**
     * Enforce type checks on constructor init params.
     *
     * @param EbayEnterprise_Inventory_Model_Quantity_Service
     * @param EbayEnterprise_Inventory_Model_Details_Service
     * @param EbayEnterprise_Inventory_Model_Allocation_Service
     * @param EbayEnterprise_MageLog_Helper_Data
     * @param EbayEnterprise_MageLog_Helper_Context
     * @param Mage_Core_Model_App
     * @return array
     */
    protected function checkTypes(

The method parameter $quantityService is never used

The method parameter $detailsService is never used

The method parameter $allocationService is never used

The method parameter $logger is never used

The method parameter $logContext is never used

The method parameter $app is never used

        EbayEnterprise_Inventory_Model_Quantity_Service $quantityService,

The parameter $quantityService is not used and could be removed.

        EbayEnterprise_Inventory_Model_Details_Service $detailsService,

The parameter $detailsService is not used and could be removed.

        EbayEnterprise_Inventory_Model_Allocation_Service $allocationService,

The parameter $allocationService is not used and could be removed.

        EbayEnterprise_MageLog_Helper_Data $logger,

The parameter $logger is not used and could be removed.

        EbayEnterprise_MageLog_Helper_Context $logContext,

The parameter $logContext is not used and could be removed.

        Mage_Core_Model_App $app

The parameter $app is not used and could be removed.

    ) {
        return func_get_args();
    }

    /**
     * Fill in default values.
     *
     * @param string
     * @param array
     * @param mixed
     * @return mixed
     */
    protected function nullCoalesce(array $arr, $key, $default)
    {
        return isset($arr[$key]) ? $arr[$key] : $default;
    }

    /**
     * Before collecting item totals, check that all items
     * in the quote are available to be fulfilled.
     *
     * @param Varien_Event_Observer
     * @return self
     */
    public function handleBeforeCollectTotals(Varien_Event_Observer $observer)
    {
        try {
            $quote = $observer->getEvent()->getQuote();
            $this->quantityService
                ->checkQuoteInventory($quote);
        } catch (EbayEnterprise_Inventory_Exception_Quantity_Collector_Exception $e) {
            $this->logger->logException($e, $this->logContext->getMetaData(__CLASS__, [], $e));
            $this->logger->warning(
                'Caught the following exception: {exception_message}.',
                $this->logContext->getMetaData(__CLASS__, ['exception_message' => $e->getMessage()])
            );
        } catch (EbayEnterprise_Inventory_Exception_Quantity_Unavailable_Exception $e) {
            $this->logger->logException($e, $this->logContext->getMetaData(__CLASS__, [], $e));
            $this->logger->warning(
                'Caught the following exception: {exception_message}.',
                $this->logContext->getMetaData(__CLASS__, ['exception_message' => $e->getMessage()])
            );
            if ($this->app->getStore()->isAdmin()) {
                // Handling admin exception here because it is not
                // being caught in the admin controller causing it
                // to display exception traces in the page.
                return $this->handleAdminOrderException($e, $quote);
            }
            // Continue to throw the exception in the frontend and let
            // the frontend controller handle it.
            throw $e;
        }
        return $this;
    }

    /**
     * Handle admin out of stock Exception thrown from ROM Inventory Service.
     *
     * @param  EbayEnterprise_Inventory_Exception_Quantity_Unavailable_Exception
     * @param  Mage_Sales_Model_Quote
     * @return self
     */
    protected function handleAdminOrderException(
        EbayEnterprise_Inventory_Exception_Quantity_Unavailable_Exception $e,
        Mage_Sales_Model_Quote $quote
    )
    {
        $this->getAdminQuoteSession()->addError($e->getMessage());
        foreach ($quote->getAllVisibleItems() as $quoteItem) {
            if (!$this->quantityService->isItemAvailable($quoteItem)) {
                $quote->deleteItem($quoteItem);
            }
        }
        return $this;
    }

    /**
     * Stash the adminhtml quote session to a class property.
     * @return Mage_Adminhtml_Model_Session_Quote
     */
    protected function getAdminQuoteSession()
    {
        if (!$this->adminQuoteSession) {
            $this->adminQuoteSession = Mage::getSingleton('adminhtml/session_quote');
        }
        return $this->adminQuoteSession;
    }

    /**
     * add estimated shipping information to the item payload
     * @param  Varien_Event_Observer $observer
     * @return self
     */
    public function handleEbayEnterpriseOrderCreateItem(Varien_Event_Observer $observer)
    {
        $event = $observer->getEvent();
        $itemPayload = $event->getItemPayload();
        $item = $this->getItemForLookup($event->getItem());
        Mage::getModel('ebayenterprise_inventory/order_create_item_details')
            ->injectShippingEstimates($itemPayload, $item);
        Mage::getModel('ebayenterprise_inventory/order_create_item_allocation')
            ->injectReservationInfo($itemPayload, $item);
        return $this;
    }

    /**
     * get the correct order item
     * @param Mage_Sales_Model_Order_Item
     * @return Mage_Sales_Model_Order_Item
     */
    protected function getItemForLookup(Mage_Sales_Model_Order_Item $item)
    {
        if ($item->getProductType() == Mage_Catalog_Model_Product_Type::TYPE_CONFIGURABLE) {
            $item = reset($item->getChildrenItems());

$item->getChildrenItems() cannot be passed to reset() as the parameter $array expects a reference.

        }
        return $item;
    }

    /**
     * Inject the ship from address into the tax item payload
     *
     * @param Varien_Event_Observer
     * @return self
     */
    public function handleEbayEnterpriseTaxItemShipOrigin(Varien_Event_Observer $observer)
    {
        $item = $observer->getEvent()->getItem();
        $address = $observer->getEvent()->getAddress();
        Mage::getModel('ebayenterprise_inventory/tax_shipping_origin')
            ->injectShippingOriginForItem($item, $address);
        return $this;
    }

    /**
     * trigger inventory allocation for the quote
     *
     * @param Varien_Event_Observer
     * @return self
     */
    public function handleSalesOrderPlaceBefore(Varien_Event_Observer $observer)
    {
        $order = $observer->getEvent()->getOrder();
        $quote = $order->getQuote();
        $this->allocationService->allocateInventoryForQuote($quote);
        return $this;
    }

    /**
     * trigger a rollback if the order fails
     *
     * @return self
     */
    public function handleSalesModelServiceQuoteSubmitFailure()
    {
        $this->allocationService->undoAllocation();
        return $this;
    }

    /**
     * Clean-up quantity session after an order was successfully created.
     *
     * @return self
     */
    public function handleEbayEnterpriseOrderCreateSuccessful()
    {
        /** @var EbayEnterprise_Inventory_Model_Session $inventorySession */
        $inventorySession = Mage::getSingleton('ebayenterprise_inventory/session');
        $inventorySession->unsetData('quantity_results');
        return $this;
    }
}