TechDivision\Import\Product\Observers\ProductObserver

Complexity

Total Complexity

13

Size/Duplication

Total Lines	174
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

94.87%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	getProductBunchProcessor()	0	4	1
A	process()	0	13	3
A	prepareAttributes()	0	28	1
A	mergeEntity()	0	9	1
A	initializeProduct()	0	11	2
A	loadProduct()	0	4	1
A	persistProduct()	0	4	1
A	getAttributeSet()	0	4	1
A	setLastEntityId()	0	4	1

<?php

/**
 * TechDivision\Import\Product\Observers\ProductObserver
 *
 * 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 2016 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\Observers\StateDetectorInterface;
use TechDivision\Import\Product\Services\ProductBunchProcessorInterface;

/**
 * Observer that create's the product itself.
 *
 * @author    Tim Wagner <t.wagner@techdivision.com>
 * @copyright 2016 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 ProductObserver extends AbstractProductImportObserver
{

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

    /**
     * Initialize the observer with the passed product bunch processor instance.
     *
     * @param \TechDivision\Import\Product\Services\ProductBunchProcessorInterface $productBunchProcessor The product bunch processor instance
     * @param \TechDivision\Import\Observers\StateDetectorInterface|null           $stateDetector         The state detector instance to use
     */
    public function __construct(ProductBunchProcessorInterface $productBunchProcessor, StateDetectorInterface $stateDetector = null)
    {

        // initialize the bunch processor instance
        $this->productBunchProcessor = $productBunchProcessor;

        // pass the state detector to the parent method
        parent::__construct($stateDetector);

It seems like you code against a specific sub-type and not the parent class TechDivision\Import\Product\Observers\AbstractProductImportObserver as the method __construct() does only exist in the following sub-classes of TechDivision\Import\Product\Observers\AbstractProductImportObserver: TechDivision\Import\Product\Observers\AbstractProductRelationObserver, TechDivision\Import\Product\Observers\AbstractProductRelationUpdateObserver, TechDivision\Import\Product\Observers\CategoryProductObserver, TechDivision\Import\Product\Observers\CategoryProductUpdateObserver, TechDivision\Import\Product\Observers\CleanUpObserver, TechDivision\Import\Product\Observers\ClearProductObserver, TechDivision\Import\Product\Observers\GenericSkuEntityIdMappingObserver, TechDivision\Import\Product\Observers\LastEntityIdObserver, TechDivision\Import\Product\Observers\PreLoadEntityIdObserver, TechDivision\Import\Product\Observers\ProductInventoryObserver, TechDivision\Import\Product\Observers\ProductInventoryUpdateObserver, TechDivision\Import\Product\Observers\ProductObserver, TechDivision\Import\Product\Observers\ProductWebsiteObserver, TechDivision\Import\Product\Observers\ProductWebsiteUpdateObserver, TechDivision\Import\Product\Observers\UrlKeyObserver. Maybe you want to instanceof check for one of these explicitly?

    }

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

    /**
     * Process the observer's business logic.
     *
     * @return void
     */
    protected function process()
    {

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

        // prepare the product and query whether or not it has to be persisted or the row has to be skipped
        if ($this->hasChanges($product = $this->initializeProduct($this->prepareAttributes()))) {

The method hasChanges() does not seem to exist on object<TechDivision\Import\Product\Observers\ProductObserver>.

            $this->persistProduct($product);
        }
    }

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

        // prepare the date format for the created at/updated at dates
        $createdAt = $this->getValue(ColumnKeys::CREATED_AT, date('Y-m-d H:i:s'), array($this, 'formatDate'));
        $updatedAt = $this->getValue(ColumnKeys::UPDATED_AT, date('Y-m-d H:i:s'), array($this, 'formatDate'));

        // initialize the product values
        $sku = $this->getValue(ColumnKeys::SKU);
        $productType = $this->getValue(ColumnKeys::PRODUCT_TYPE);

        // load the product's attribute set ID
        $attributeSet = $this->getAttributeSet();
        $attributeSetId = $attributeSet[MemberNames::ATTRIBUTE_SET_ID];

        // return the prepared product
        return $this->initializeEntity(
            array(
                MemberNames::SKU              => $sku,
                MemberNames::CREATED_AT       => $createdAt,
                MemberNames::UPDATED_AT       => $updatedAt,
                MemberNames::HAS_OPTIONS      => 0,
                MemberNames::REQUIRED_OPTIONS => 0,
                MemberNames::TYPE_ID          => $productType,
                MemberNames::ATTRIBUTE_SET_ID => $attributeSetId
            )
        );
    }

    /**
     * Merge's and return's the entity with the passed attributes and set's the
     * passed status.
     *
     * @param array       $entity        The entity to merge the attributes into
     * @param array       $attr          The attributes to be merged
     * @param string|null $changeSetName The change set name to use
     *
     * @return array The merged entity
     */
    protected function mergeEntity(array $entity, array $attr, $changeSetName = null)
    {

        // temporary persist the entity ID
        $this->setLastEntityId($entity[MemberNames::ENTITY_ID]);

        // merge and return the entity
        return parent::mergeEntity($entity, $attr, $changeSetName);

The call to AbstractProductImportObserver::mergeEntity() has too many arguments starting with $changeSetName.

    }

    /**
     * Initialize the product with the passed attributes and returns an instance.
     *
     * @param array $attr The product attributes
     *
     * @return array The initialized product
     */
    protected function initializeProduct(array $attr)
    {

        // load the product with the passed SKU and merge it with the attributes
        if ($entity = $this->loadProduct($attr[MemberNames::SKU])) {
            return $this->mergeEntity($entity, $attr);
        }

        // otherwise simply return the attributes
        return $attr;
    }

    /**
     * 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);
    }

    /**
     * Persist's the passed product data.
     *
     * @param array $product The product data to persist
     *
     * @return void
     */
    protected function persistProduct($product)
    {
        $this->setLastEntityId($this->getProductBunchProcessor()->persistProduct($product));
    }

    /**
     * Return's the attribute set of the product that has to be created.
     *
     * @return array The attribute set
     */
    protected function getAttributeSet()
    {
        return $this->getSubject()->getAttributeSet();

It seems like you code against a concrete implementation and not the interface TechDivision\Import\Subjects\SubjectInterface as the method getAttributeSet() does only exist in the following implementations of said interface: TechDivision\Import\Observers\EntitySubjectImpl, TechDivision\Import\Product\Subjects\AbstractProductSubject, TechDivision\Import\Product\Subjects\BunchSubject, TechDivision\Import\Subjects\AbstractEavSubject.

    }

    /**
     * Set's the ID of the product that has been created recently.
     *
     * @param string $lastEntityId The entity ID
     *
     * @return void
     */
    protected function setLastEntityId($lastEntityId)
    {
        $this->getSubject()->setLastEntityId($lastEntityId);

It seems like you code against a concrete implementation and not the interface TechDivision\Import\Subjects\SubjectInterface as the method setLastEntityId() does only exist in the following implementations of said interface: TechDivision\Import\Plugins\ExportableSubjectImpl, TechDivision\Import\Product\Subjects\AbstractProductSubject, TechDivision\Import\Product\Subjects\BunchSubject, TechDivision\Import\Subjects\ExportableTraitImpl.

    }
}