GenericSkuRowIdMappingObserver - Code Metrics - Inspection of "- Add new generic SKU to row ID mapping observer" - techdivision/import-product-ee - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 14.x ( 185684 )

by Tim

created 2019-08-05 08:35 UTC

GenericSkuRowIdMappingObserver A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	2
lcom	0
cbo	1
dl	0
loc	33
rs	10
c	0
b	0
f	0
ccs	0
cts	9
cp	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	addSkuPkMapping()	0	9	1
A	addSkuRowIdMapping()	0	4	1

<?php

/**
 * TechDivision\Import\Product\Observers\LastEntityAndRowIdObserver
 *
 * 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 2019 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-ee
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Ee\Observers;

use TechDivision\Import\Product\Ee\Utils\MemberNames;
use TechDivision\Import\Product\Observers\GenericSkuEntityIdMappingObserver;

/**
 * A generic oberserver implementation that provides functionality to add the SKU => entity/row ID
 * mapping for products that has not yet been processed or are NOT part of the actual CSV file.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2019 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-ee
 * @link      http://www.techdivision.com
 */
class GenericSkuRowIdMappingObserver extends GenericSkuEntityIdMappingObserver
{

    /**
     * Map the PK for the product with the passed SKU.
     *
     * @param array $product The product to add the SKU => entity ID mapping for
     *
     * @return void
     */
    protected function addSkuPkMapping(array $product)
    {

        // invoke the parent method (add the SKU => entity ID mapping)
        parent::addSkuPkMapping($product);

        // additionally add the SKU => row ID mapping
        $this->addSkuRowIdMapping($product[MemberNames::SKU], $product[MemberNames::ROW_ID]);
    }

    /**
     * Add the passed SKU => row ID mapping.
     *
     * @param string       $sku   The SKU
     * @param integer|null $rowId The optional entity ID, the last processed entity ID is used, if not set
     *
     * @return void
     */
    protected function addSkuRowIdMapping($sku, $rowId = null)
    {
        $this->getSubject()->addSkuRowIdMapping($sku, $rowId);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Product\Observers\LastEntityAndRowIdObserver
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 2019 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-ee
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Product\Ee\Observers;
22
23			use TechDivision\Import\Product\Ee\Utils\MemberNames;
24			use TechDivision\Import\Product\Observers\GenericSkuEntityIdMappingObserver;
25
26			/**
27			* A generic oberserver implementation that provides functionality to add the SKU => entity/row ID
28			* mapping for products that has not yet been processed or are NOT part of the actual CSV file.
29			*
30			* @author Tim Wagner <[email protected]>
31			* @copyright 2019 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-ee
34			* @link http://www.techdivision.com
35			*/
36			class GenericSkuRowIdMappingObserver extends GenericSkuEntityIdMappingObserver
37			{
38
39			/**
40			* Map the PK for the product with the passed SKU.
41			*
42			* @param array $product The product to add the SKU => entity ID mapping for
43			*
44			* @return void
45			*/
46			protected function addSkuPkMapping(array $product)
47			{
48
49			// invoke the parent method (add the SKU => entity ID mapping)
50			parent::addSkuPkMapping($product);
51
52			// additionally add the SKU => row ID mapping
53			$this->addSkuRowIdMapping($product[MemberNames::SKU], $product[MemberNames::ROW_ID]);
54			}
55
56			/**
57			* Add the passed SKU => row ID mapping.
58			*
59			* @param string $sku The SKU
60			* @param integer\|null $rowId The optional entity ID, the last processed entity ID is used, if not set
61			*
62			* @return void
63			*/
64			protected function addSkuRowIdMapping($sku, $rowId = null)
65			{
66			$this->getSubject()->addSkuRowIdMapping($sku, $rowId);
			0 ignored issues – show Bug introduced 2019-08-05 08:44 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TechDivision\Import\Subjects\SubjectInterface` as the method `addSkuRowIdMapping()` does only exist in the following implementations of said interface: `TechDivision\Import\Prod...Subjects\EeBunchSubject`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
67			}
68			}
69

techdivision / import-product-ee

Push — 14.x ( 185684 )

GenericSkuRowIdMappingObserver A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

2 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like