TechDivision\Import\Product\Observers\GenericSkuEntityIdMappingObserver

Complexity

Total Complexity

9

Size/Duplication

Total Lines	107
Duplicated Lines	25.23 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getProductBunchProcessor()	0	4	1
A	getSkuColumnName()	0	4	1
A	process()	27	27	4
A	addSkuPkMapping()	0	4	1
A	loadProduct()	0	4	1

<?php

/**
 * TechDivision\Import\Product\Observers\GenericSkuEntityIdMappingObserver
 *
 * 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 <t.wagner@techdivision.com>
 * @copyright 2019 TechDivision GmbH <info@techdivision.com>
 * @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\Services\ProductBunchProcessorInterface;

/**
 * A generic oberserver implementation that provides functionality to add the SKU => entity ID
 * mapping for products that has not yet been processed or are NOT part of the actual CSV file.
 *
 * @author    Tim Wagner <t.wagner@techdivision.com>
 * @copyright 2019 TechDivision GmbH <info@techdivision.com>
 * @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 GenericSkuEntityIdMappingObserver extends AbstractProductImportObserver
{

    /**
     * The product bunch processor instance.
     *
     * @var \TechDivision\Import\Product\Services\ProductBunchProcessorInterface
     */
    protected $productBunchProcessor;

    /**
     * The column name with the SKU to map the entity ID for.
     *
     * @var string
     */
    protected $skuColumnName;

    /**
     * Initialize the observer with the passed product bunch processor instance.
     *
     * @param \TechDivision\Import\Product\Services\ProductBunchProcessorInterface $productBunchProcessor The product bunch processor instance
     * @param string                                                               $skuColumnName         The column name with the SKU to map the entity ID for
     */
    public function __construct(
        ProductBunchProcessorInterface $productBunchProcessor,
        $skuColumnName = ColumnKeys::SKU
    ) {
        $this->productBunchProcessor = $productBunchProcessor;
        $this->skuColumnName = $skuColumnName;
    }

    /**
     * Return's the product bunch processor instance.
     *
     * @return \TechDivision\Import\Product\Services\ProductBunchProcessorInterface The product bunch processor instance
     */
    protected function getProductBunchProcessor()
    {
        return $this->productBunchProcessor;
    }

    /**
     * Returns the column name with the SKU to map the entity ID for.
     *
     * @return string The column name
     */
    protected function getSkuColumnName()
    {
        return $this->skuColumnName;
    }

    /**
     * Process the observer's business logic.
     *
     * @return void
     * @throws \Exception Is thrown, if the product with the SKU can not be loaded
     */
    protected function process()

This method seems to be duplicated in your project.

    {

        // load the SKU from the column
        $sku = $this->getValue($this->getSkuColumnName());

        // query whether or not the product has already been processed
        if ($this->hasBeenProcessed($sku)) {
            return;
        }

        // try to load it and map the entity ID of the product with the passed SKU otherwise
        if ($product = $this->loadProduct($sku)) {
            $this->addSkuPkMapping($product);
        } else {
            // initialize the error message
            $message = sprintf('Can\'t load product with SKU "%s"', $sku);
            // load the subject
            $subject = $this->getSubject();
            // query whether or not debug mode has been enabled
            if ($subject->isDebugMode()) {
                $subject->getSystemLogger()->warning($subject->appendExceptionSuffix($message));
            } else {
                throw new \Exception($message);
            }
        }
    }

    /**
     * Map the PK for the product with the passed SKU.
     *
     * @param array $product The product to add the SKU => entity ID mapping for
     */
    protected function addSkuPkMapping(array $product)
    {
        $this->addSkuEntityIdMapping($product[MemberNames::SKU], $product[MemberNames::ENTITY_ID]);
    }

    /**
     * Load's and return's the product with the passed SKU.
     *
     * @param string $sku The SKU of the product to load
     *
     * @return array The product
     */
    protected function loadProduct($sku)
    {
        return $this->getProductBunchProcessor()->loadProduct($sku);
    }
}