AbstractMsiSubject::hasSourceBeenProcessed() - Code Metrics - Inspection of "Merge pull request #12 from techdivision/PAC-294-i..." - techdivision/import-product-msi - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b8b3d1...a7897a )

unknown

created 2022-02-14 13:03 UTC

AbstractMsiSubject::hasSourceBeenProcessed() A

↳ Parent: AbstractMsiSubject

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	2
dl	0
loc	3
ccs	0
cts	3
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php

/**
 * TechDivision\Import\Product\Msi\Subjects\AbstractMsiSubject
 *
 * PHP version 7
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2018 TechDivision GmbH <[email protected]>
 * @license   https://opensource.org/licenses/MIT
 * @link      https://github.com/techdivision/import-product-msi
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Msi\Subjects;

use League\Event\EmitterInterface;
use Doctrine\Common\Collections\Collection;
use TechDivision\Import\Product\Subjects\AbstractProductSubject;
use TechDivision\Import\Utils\Generators\GeneratorInterface;
use TechDivision\Import\Services\RegistryProcessorInterface;
use TechDivision\Import\Product\Msi\Utils\RegistryKeys;
use TechDivision\Import\Product\Msi\Services\MsiBunchProcessorInterface;

/**
 * The abstract subject implementation that provides basic MSI inventory source item
 * handling business logic.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2018 TechDivision GmbH <[email protected]>
 * @license   https://opensource.org/licenses/MIT
 * @link      https://github.com/techdivision/import-product-msi
 * @link      http://www.techdivision.com
 */
abstract class AbstractMsiSubject extends AbstractProductSubject
{

    /**
     * The ID of the source item that has been created recently.
     *
     * @var string
     */
    protected $lastSourceItemId;

    /**
     * The mapping for the SKU/source code to the created source item IDs.
     *
     * @var array
     */
    protected $skuSourceItemIdMapping = array();

    /**
     * The available inventory sources.
     *
     * @var array
     */
    protected $inventorySources = array();

    /**
     * The MSI bunch processor instance.
     *
     * @var \TechDivision\Import\Product\Msi\Services\MsiBunchProcessorInterface
     */
    protected $msiBunchProcessor;

    /**
     * Initialize the subject instance.
     *
     * @param \TechDivision\Import\Services\RegistryProcessorInterface             $registryProcessor          The registry processor instance
     * @param \TechDivision\Import\Utils\Generators\GeneratorInterface             $coreConfigDataUidGenerator The UID generator for the core config data
     * @param \Doctrine\Common\Collections\Collection                              $systemLoggers              The array with the system loggers instances
     * @param \League\Event\EmitterInterface                                       $emitter                    The event emitter instance
     * @param \TechDivision\Import\Product\Msi\Services\MsiBunchProcessorInterface $msiBunchProcessor          The MSI bunch processor instance
     */
    public function __construct(
        RegistryProcessorInterface $registryProcessor,
        GeneratorInterface $coreConfigDataUidGenerator,
        Collection $systemLoggers,
        EmitterInterface $emitter,
        MsiBunchProcessorInterface $msiBunchProcessor
    ) {

        // set the MSI bunch processor instance
        $this->msiBunchProcessor = $msiBunchProcessor;

        // pass the instances through to the parent instance
        parent::__construct($registryProcessor, $coreConfigDataUidGenerator, $systemLoggers, $emitter);
    }

    /**
     * Returns the MSI bunch processor instance.
     *
     * @return \TechDivision\Import\Product\Msi\Services\MsiBunchProcessorInterface The MSI bunch processor instance
     */
    protected function getMsiBunchProcessor()
    {
        return $this->msiBunchProcessor;
    }

    /**
     * Set's the ID of the source item that has been created recently.
     *
     * @param string $lastSourceItemId The entity ID
     *
     * @return void
     */
    public function setLastSourceItemId($lastSourceItemId)
    {
        $this->lastSourceItemId = $lastSourceItemId;
    }

    /**
     * Return's the ID of the source item that has been created recently.
     *
     * @return string The entity Id
     */
    public function getLastSourceItemId()
    {
        return $this->lastSourceItemId;
    }

    /**
     * Queries whether or not the SKU/source code has already been processed.
     *
     * @param string $sku        The SKU to check been processed
     * @param string $sourceCode The source code to check been processed
     *
     * @return boolean TRUE if the SKU/source code has been processed, else FALSE
     */
    public function hasSourceBeenProcessed($sku, $sourceCode)
    {
        return isset($this->skuSourceItemIdMapping[$sku][$sourceCode]);
    }

    /**
     * Add the passed SKU/source code => source item ID mapping.
     *
     * @param string $sku        The SKU
     * @param string $sourceCode The source code
     *
     * @return void
     */
    public function addSkuSourceItemIdMapping($sku, $sourceCode)
    {
        $this->skuSourceItemIdMapping[$sku][$sourceCode] = $this->getLastSourceItemId();
    }

    /**
     * Queries whether or not the inventory source with the passed code is available.
     *
     * @param string $sourceCode The code of the inventory source to query for
     *
     * @return boolean TRUE if the inventory source with the passed code is available, FALSE if not
     */
    public function hasInventorySource($sourceCode)
    {
        return isset($this->inventorySources[$sourceCode]);
    }

    /**
     * Returns the inventory source with the passed code.
     *
     * @param string $sourceCode The code of the inventory source to return
     *
     * @return array The inventory source for the passed code
     * @throws \Exception Is thrown, if the inventory source with the passed code is NOT available
     */
    public function getInventorySourceBySourceCode($sourceCode)
    {

        // query whether or not the inventory source is available
        if (isset($this->inventorySources[$sourceCode])) {
            return $this->inventorySources[$sourceCode];
        }

        // throw a new exception
        throw new \Exception(
            $this->appendExceptionSuffix(
                sprintf('Can\'t load inventory source with code "%s"', $sourceCode)
            )
        );
    }

    /**
     * Intializes the previously loaded global data for exactly one bunch.
     *
     * @param string $serial The serial of the actual import
     *
     * @return void
     */
    public function setUp($serial)
    {

        // invoke the parent method
        parent::setUp($serial);

        // load the available inventory sources
        $this->inventorySources = $this->getMsiBunchProcessor()->loadInventorySources();
    }

    /**
     * Clean up the global data after importing the bunch.
     *
     * @param string $serial The serial of the actual import
     *
     * @return void
     */
    public function tearDown($serial)
    {

        // load the registry processor
        $registryProcessor = $this->getRegistryProcessor();

        // update the status
        $registryProcessor->mergeAttributesRecursive(
            RegistryKeys::STATUS,
            array(
                RegistryKeys::SKU_SOURCE_ITEM_ID_MAPPING => $this->skuSourceItemIdMapping
            )
        );

        // invoke the parent method
        parent::tearDown($serial);
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Product\Msi\Subjects\AbstractMsiSubject
5			*
6			* PHP version 7
7			*
8			* @author Tim Wagner <[email protected]>
9			* @copyright 2018 TechDivision GmbH <[email protected]>
10			* @license https://opensource.org/licenses/MIT
11			* @link https://github.com/techdivision/import-product-msi
12			* @link http://www.techdivision.com
13			*/
14
15			namespace TechDivision\Import\Product\Msi\Subjects;
16
17			use League\Event\EmitterInterface;
18			use Doctrine\Common\Collections\Collection;
19			use TechDivision\Import\Product\Subjects\AbstractProductSubject;
20			use TechDivision\Import\Utils\Generators\GeneratorInterface;
21			use TechDivision\Import\Services\RegistryProcessorInterface;
22			use TechDivision\Import\Product\Msi\Utils\RegistryKeys;
23			use TechDivision\Import\Product\Msi\Services\MsiBunchProcessorInterface;
24
25			/**
26			* The abstract subject implementation that provides basic MSI inventory source item
27			* handling business logic.
28			*
29			* @author Tim Wagner <[email protected]>
30			* @copyright 2018 TechDivision GmbH <[email protected]>
31			* @license https://opensource.org/licenses/MIT
32			* @link https://github.com/techdivision/import-product-msi
33			* @link http://www.techdivision.com
34			*/
35			abstract class AbstractMsiSubject extends AbstractProductSubject
36			{
37
38			/**
39			* The ID of the source item that has been created recently.
40			*
41			* @var string
42			*/
43			protected $lastSourceItemId;
44
45			/**
46			* The mapping for the SKU/source code to the created source item IDs.
47			*
48			* @var array
49			*/
50			protected $skuSourceItemIdMapping = array();
51
52			/**
53			* The available inventory sources.
54			*
55			* @var array
56			*/
57			protected $inventorySources = array();
58
59			/**
60			* The MSI bunch processor instance.
61			*
62			* @var \TechDivision\Import\Product\Msi\Services\MsiBunchProcessorInterface
63			*/
64			protected $msiBunchProcessor;
65
66			/**
67			* Initialize the subject instance.
68			*
69			* @param \TechDivision\Import\Services\RegistryProcessorInterface $registryProcessor The registry processor instance
70			* @param \TechDivision\Import\Utils\Generators\GeneratorInterface $coreConfigDataUidGenerator The UID generator for the core config data
71			* @param \Doctrine\Common\Collections\Collection $systemLoggers The array with the system loggers instances
72			* @param \League\Event\EmitterInterface $emitter The event emitter instance
73			* @param \TechDivision\Import\Product\Msi\Services\MsiBunchProcessorInterface $msiBunchProcessor The MSI bunch processor instance
74			*/
75			public function __construct(
76			RegistryProcessorInterface $registryProcessor,
77			GeneratorInterface $coreConfigDataUidGenerator,
78			Collection $systemLoggers,
79			EmitterInterface $emitter,
80			MsiBunchProcessorInterface $msiBunchProcessor
81			) {
82
83			// set the MSI bunch processor instance
84			$this->msiBunchProcessor = $msiBunchProcessor;
85
86			// pass the instances through to the parent instance
87			parent::__construct($registryProcessor, $coreConfigDataUidGenerator, $systemLoggers, $emitter);
88			}
89
90			/**
91			* Returns the MSI bunch processor instance.
92			*
93			* @return \TechDivision\Import\Product\Msi\Services\MsiBunchProcessorInterface The MSI bunch processor instance
94			*/
95			protected function getMsiBunchProcessor()
96			{
97			return $this->msiBunchProcessor;
98			}
99
100			/**
101			* Set's the ID of the source item that has been created recently.
102			*
103			* @param string $lastSourceItemId The entity ID
104			*
105			* @return void
106			*/
107			public function setLastSourceItemId($lastSourceItemId)
108			{
109			$this->lastSourceItemId = $lastSourceItemId;
110			}
111
112			/**
113			* Return's the ID of the source item that has been created recently.
114			*
115			* @return string The entity Id
116			*/
117			public function getLastSourceItemId()
118			{
119			return $this->lastSourceItemId;
120			}
121
122			/**
123			* Queries whether or not the SKU/source code has already been processed.
124			*
125			* @param string $sku The SKU to check been processed
126			* @param string $sourceCode The source code to check been processed
127			*
128			* @return boolean TRUE if the SKU/source code has been processed, else FALSE
129			*/
130			public function hasSourceBeenProcessed($sku, $sourceCode)
131			{
132			return isset($this->skuSourceItemIdMapping[$sku][$sourceCode]);
133			}
134
135			/**
136			* Add the passed SKU/source code => source item ID mapping.
137			*
138			* @param string $sku The SKU
139			* @param string $sourceCode The source code
140			*
141			* @return void
142			*/
143			public function addSkuSourceItemIdMapping($sku, $sourceCode)
144			{
145			$this->skuSourceItemIdMapping[$sku][$sourceCode] = $this->getLastSourceItemId();
146			}
147
148			/**
149			* Queries whether or not the inventory source with the passed code is available.
150			*
151			* @param string $sourceCode The code of the inventory source to query for
152			*
153			* @return boolean TRUE if the inventory source with the passed code is available, FALSE if not
154			*/
155			public function hasInventorySource($sourceCode)
156			{
157			return isset($this->inventorySources[$sourceCode]);
158			}
159
160			/**
161			* Returns the inventory source with the passed code.
162			*
163			* @param string $sourceCode The code of the inventory source to return
164			*
165			* @return array The inventory source for the passed code
166			* @throws \Exception Is thrown, if the inventory source with the passed code is NOT available
167			*/
168			public function getInventorySourceBySourceCode($sourceCode)
169			{
170
171			// query whether or not the inventory source is available
172			if (isset($this->inventorySources[$sourceCode])) {
173			return $this->inventorySources[$sourceCode];
174			}
175
176			// throw a new exception
177			throw new \Exception(
178			$this->appendExceptionSuffix(
179			sprintf('Can\'t load inventory source with code "%s"', $sourceCode)
180			)
181			);
182			}
183
184			/**
185			* Intializes the previously loaded global data for exactly one bunch.
186			*
187			* @param string $serial The serial of the actual import
188			*
189			* @return void
190			*/
191			public function setUp($serial)
192			{
193
194			// invoke the parent method
195			parent::setUp($serial);
196
197			// load the available inventory sources
198			$this->inventorySources = $this->getMsiBunchProcessor()->loadInventorySources();
199			}
200
201			/**
202			* Clean up the global data after importing the bunch.
203			*
204			* @param string $serial The serial of the actual import
205			*
206			* @return void
207			*/
208			public function tearDown($serial)
209			{
210
211			// load the registry processor
212			$registryProcessor = $this->getRegistryProcessor();
213
214			// update the status
215			$registryProcessor->mergeAttributesRecursive(
216			RegistryKeys::STATUS,
217			array(
218			RegistryKeys::SKU_SOURCE_ITEM_ID_MAPPING => $this->skuSourceItemIdMapping
219			)
220			);
221
222			// invoke the parent method
223			parent::tearDown($serial);
224			}
225			}
226

techdivision / import-product-msi

Push — master ( b8b3d1...a7897a )

AbstractMsiSubject::hasSourceBeenProcessed() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like