ProductInventoryObserver::process() - Code Metrics - Inspection of "Merge pull request #19 from wagnert/master" - techdivision/import-product - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fb9075...7e65e5 )

by Tim

created 2017-01-07 14:34 UTC

ProductInventoryObserver::process() A

↳ Parent: ProductInventoryObserver

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	0
cts	8
cp	0
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	0
crap	6

<?php

/**
 * TechDivision\Import\Product\Observers\ProductInventoryObserver
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-product
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Observers;

use TechDivision\Import\Product\Utils\ColumnKeys;
use TechDivision\Import\Product\Utils\MemberNames;
use TechDivision\Import\Product\Observers\AbstractProductImportObserver;

/**
 * Observer that creates/updates the product's inventory.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-product
 * @link      http://www.techdivision.com
 */
class ProductInventoryObserver extends AbstractProductImportObserver
{

    /**
     * Process the observer's business logic.
     *
     * @return array The processed row
     */
    protected function process()
    {

        // query whether or not, we've found a new SKU => means we've found a new product
        if ($this->isLastSku($this->getValue(ColumnKeys::SKU))) {
            return;
        }

        // prepare, initialize and persist the stock status/item
        $this->persistStockStatus($this->initializeStockStatus($this->prepareStockStatusAttributes()));
        $this->persistStockItem($this->initializeStockItem($this->prepareStockItemAttributes()));
    }

    /**
     * Prepare the stock status attributes of the entity that has to be persisted.
     *
     * @return array The prepared stock status attributes
     */
    protected function prepareStockStatusAttributes()
    {

        // load the ID of the product that has been created recently
        $lastEntityId = $this->getLastEntityId();

        // initialize the stock status data
        $websiteId =  $this->getValue(ColumnKeys::WEBSITE_ID);
        $qty = $this->castValueByBackendType('float', $this->getValue(ColumnKeys::QTY));

        // return the prepared stock status
        return $this->initializeEntity(
            array(
                MemberNames::PRODUCT_ID   => $lastEntityId,
                MemberNames::WEBSITE_ID   => $websiteId,
                MemberNames::STOCK_ID     => 1,
                MemberNames::STOCK_STATUS => $qty > 0 ? 1 : 0,
                MemberNames::QTY          => $qty
            )
        );
    }

    /**
     * Initialize the stock status with the passed attributes and returns an instance.
     *
     * @param array $attr The stock status attributes
     *
     * @return array The initialized stock status
     */
    protected function initializeStockStatus(array $attr)
    {
        return $attr;
    }

    /**
     * Prepare the stock item attributes of the entity that has to be persisted.
     *
     * @return array The prepared stock status item
     */
    protected function prepareStockItemAttributes()
    {

        // load the ID of the product that has been created recently
        $lastEntityId = $this->getLastEntityId();

        // initialize the stock status data
        $websiteId =  $this->getValue(ColumnKeys::WEBSITE_ID);

        // initialize the stock item with the basic data
        $stockItem = $this->initializeEntity(
            array(
                MemberNames::PRODUCT_ID  => $lastEntityId,
                MemberNames::WEBSITE_ID  => $websiteId,
                MemberNames::STOCK_ID    => 1
            )
        );

        // append the row values to the stock item
        $headerStockMappings = $this->getHeaderStockMappings();
        foreach ($headerStockMappings as $columnName => $header) {
            list ($headerName, $backendType) = $header;
            $stockItem[$columnName] = $this->castValueByBackendType($backendType, $this->getValue($headerName));
        }

        // return the prepared stock item
        return $stockItem;
    }

    /**
     * Initialize the stock item with the passed attributes and returns an instance.
     *
     * @param array $attr The stock item attributes
     *
     * @return array The initialized stock item
     */
    protected function initializeStockItem(array $attr)
    {
        return $attr;
    }

    /**
     * Persist's the passed stock item data and return's the ID.
     *
     * @param array $stockItem The stock item data to persist
     *
     * @return void
     */
    protected function persistStockItem($stockItem)
    {
        $this->getSubject()->persistStockItem($stockItem);
    }

    /**
     * Persist's the passed stock status data and return's the ID.
     *
     * @param array $stockStatus The stock status data to persist
     *
     * @return void
     */
    protected function persistStockStatus($stockStatus)
    {
        $this->getSubject()->persistStockStatus($stockStatus);
    }

    /**
     * Return's the appings for the table column => CSV column header.
     *
     * @return array The header stock mappings
     */
    protected function getHeaderStockMappings()
    {
        return $this->getSubject()->getHeaderStockMappings();
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Product\Observers\ProductInventoryObserver
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 2016 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link https://github.com/techdivision/import-product
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Product\Observers;
22
23			use TechDivision\Import\Product\Utils\ColumnKeys;
24			use TechDivision\Import\Product\Utils\MemberNames;
25			use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
26
27			/**
28			* Observer that creates/updates the product's inventory.
29			*
30			* @author Tim Wagner <[email protected]>
31			* @copyright 2016 TechDivision GmbH <[email protected]>
32			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
33			* @link https://github.com/techdivision/import-product
34			* @link http://www.techdivision.com
35			*/
36			class ProductInventoryObserver extends AbstractProductImportObserver
37			{
38
39			/**
40			* Process the observer's business logic.
41			*
42			* @return array The processed row
43			*/
44			protected function process()
45			{
46
47			// query whether or not, we've found a new SKU => means we've found a new product
48			if ($this->isLastSku($this->getValue(ColumnKeys::SKU))) {
49			return;
50			}
51
52			// prepare, initialize and persist the stock status/item
53			$this->persistStockStatus($this->initializeStockStatus($this->prepareStockStatusAttributes()));
54			$this->persistStockItem($this->initializeStockItem($this->prepareStockItemAttributes()));
55			}
56
57			/**
58			* Prepare the stock status attributes of the entity that has to be persisted.
59			*
60			* @return array The prepared stock status attributes
61			*/
62			protected function prepareStockStatusAttributes()
63			{
64
65			// load the ID of the product that has been created recently
66			$lastEntityId = $this->getLastEntityId();
67
68			// initialize the stock status data
69			$websiteId = $this->getValue(ColumnKeys::WEBSITE_ID);
70			$qty = $this->castValueByBackendType('float', $this->getValue(ColumnKeys::QTY));
71
72			// return the prepared stock status
73			return $this->initializeEntity(
74			array(
75			MemberNames::PRODUCT_ID => $lastEntityId,
76			MemberNames::WEBSITE_ID => $websiteId,
77			MemberNames::STOCK_ID => 1,
78			MemberNames::STOCK_STATUS => $qty > 0 ? 1 : 0,
79			MemberNames::QTY => $qty
80			)
81			);
82			}
83
84			/**
85			* Initialize the stock status with the passed attributes and returns an instance.
86			*
87			* @param array $attr The stock status attributes
88			*
89			* @return array The initialized stock status
90			*/
91			protected function initializeStockStatus(array $attr)
92			{
93			return $attr;
94			}
95
96			/**
97			* Prepare the stock item attributes of the entity that has to be persisted.
98			*
99			* @return array The prepared stock status item
100			*/
101			protected function prepareStockItemAttributes()
102			{
103
104			// load the ID of the product that has been created recently
105			$lastEntityId = $this->getLastEntityId();
106
107			// initialize the stock status data
108			$websiteId = $this->getValue(ColumnKeys::WEBSITE_ID);
109
110			// initialize the stock item with the basic data
111			$stockItem = $this->initializeEntity(
112			array(
113			MemberNames::PRODUCT_ID => $lastEntityId,
114			MemberNames::WEBSITE_ID => $websiteId,
115			MemberNames::STOCK_ID => 1
116			)
117			);
118
119			// append the row values to the stock item
120			$headerStockMappings = $this->getHeaderStockMappings();
121			foreach ($headerStockMappings as $columnName => $header) {
122			list ($headerName, $backendType) = $header;
123			$stockItem[$columnName] = $this->castValueByBackendType($backendType, $this->getValue($headerName));
124			}
125
126			// return the prepared stock item
127			return $stockItem;
128			}
129
130			/**
131			* Initialize the stock item with the passed attributes and returns an instance.
132			*
133			* @param array $attr The stock item attributes
134			*
135			* @return array The initialized stock item
136			*/
137			protected function initializeStockItem(array $attr)
138			{
139			return $attr;
140			}
141
142			/**
143			* Persist's the passed stock item data and return's the ID.
144			*
145			* @param array $stockItem The stock item data to persist
146			*
147			* @return void
148			*/
149			protected function persistStockItem($stockItem)
150			{
151			$this->getSubject()->persistStockItem($stockItem);
152			}
153
154			/**
155			* Persist's the passed stock status data and return's the ID.
156			*
157			* @param array $stockStatus The stock status data to persist
158			*
159			* @return void
160			*/
161			protected function persistStockStatus($stockStatus)
162			{
163			$this->getSubject()->persistStockStatus($stockStatus);
164			}
165
166			/**
167			* Return's the appings for the table column => CSV column header.
168			*
169			* @return array The header stock mappings
170			*/
171			protected function getHeaderStockMappings()
172			{
173			return $this->getSubject()->getHeaderStockMappings();
174			}
175			}
176

techdivision / import-product

Push — master ( fb9075...7e65e5 )

ProductInventoryObserver::process() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like