TechDivision\Import\Product\Bundle\Observers\BundleOptionValueObserver

Complexity

Total Complexity

13

Size/Duplication

Total Lines	177
Duplicated Lines	12.43 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

0%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	handle()	0	12	1
B	process()	0	26	3
A	prepareAttributes()	22	22	1
A	initializeBundleOptionValue()	0	4	1
A	addOptionValueStoreMapping()	0	4	1
A	isMapped()	0	4	2
A	getLastOptionId()	0	4	1
A	getOptionIdForName()	0	4	1
A	getStoreByStoreCode()	0	4	1
A	persistProductBundleOptionValue()	0	4	1

<?php

/**
 * TechDivision\Import\Product\Bundle\Observers\BundleOptionValueObserver
 *
 * 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-bundle
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Bundle\Observers;

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

/**
 * Oberserver that provides functionality for the bundle option value replace operation.
 *
 * @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-bundle
 * @link      http://www.techdivision.com
 */
class BundleOptionValueObserver extends AbstractProductImportObserver
{

    /**
     * The option value store mapping.
     *
     * @var array
     */
    protected $optionValueStoreMapping = array();

    /**
     * Will be invoked by the action on the events the listener has been registered for.
     *
     * @param array $row The row to handle
     *
     * @return array The modified row
     * @see \TechDivision\Import\Product\Observers\ImportObserverInterface::handle()
     */
    public function handle(array $row)
    {

        // initialize the row
        $this->setRow($row);

The method setRow() does not seem to exist on object<TechDivision\Import\Product\Bundle\Observers\BundleOptionValueObserver>.

        // process the functionality and return the row
        $this->process();

        // return the processed row
        return $this->getRow();

The method getRow() does not seem to exist on object<TechDivision\Import\Product\Bundle\Observers\BundleOptionValueObserver>.

    }

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

        // prepare the store view code
        $this->prepareStoreViewCode($this->getRow());

The method getRow() does not seem to exist on object<TechDivision\Import\Product\Bundle\Observers\BundleOptionValueObserver>.

        // prepare the attributes
        $attr = $this->prepareAttributes();

        // load store/option ID
        $storeId = $attr[MemberNames::STORE_ID];
        $optionId = $attr[MemberNames::OPTION_ID];

        // if the store has already been mapped, return immediately
        if ($this->isMapped($optionId, $storeId)) {
            return;
        }

        // initialize and save the product bundle option value
        if ($bundleOption = $this->initializeBundleOptionValue($attr)) {
            $this->persistProductBundleOptionValue($bundleOption);
        }

        // add the store => option mapping
        $this->addOptionValueStoreMapping($optionId, $storeId);
    }

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

This method seems to be duplicated in your project.

    {

        // load the product bundle option name
        $name = $this->getValue(ColumnKeys::BUNDLE_VALUE_NAME);

The method getValue() does not seem to exist on object<TechDivision\Import\Product\Bundle\Observers\BundleOptionValueObserver>.

        // load the actual option ID
        $optionId = $this->getLastOptionId();

        // load the store/website ID
        $store = $this->getStoreByStoreCode($this->getStoreViewCode(StoreViewCodes::ADMIN));
        $storeId = $store[MemberNames::STORE_ID];

        // return the prepared product
        return $this->initializeEntity(

The method initializeEntity() does not seem to exist on object<TechDivision\Import\Product\Bundle\Observers\BundleOptionValueObserver>.

            array(
                MemberNames::OPTION_ID => $optionId,
                MemberNames::STORE_ID  => $storeId,
                MemberNames::TITLE     => $name
            )
        );
    }

    /**
     * Initialize the bundle option value with the passed attributes and returns an instance.
     *
     * @param array $attr The bundle option value attributes
     *
     * @return array The initialized bundle option value
     */
    protected function initializeBundleOptionValue(array $attr)
    {
        return $attr;
    }

    /**
     * Add the store => option mapping.
     *
     * @param integer $optionId The option ID to map
     * @param integer $storeId  The store ID to map
     *
     * @return void
     */
    protected function addOptionValueStoreMapping($optionId, $storeId)
    {
        $this->optionValueStoreMapping[$optionId][] = $storeId;
    }

    /**
     * Query whether or not the passed option/store ID combination has already been mapped.
     *
     * @param integer $optionId The option ID to map
     * @param integer $storeId  The store ID to map
     *
     * @return boolean TRUE if the combination has already been mapped, else FALSE
     */
    protected function isMapped($optionId, $storeId)
    {
        return (isset($this->optionValueStoreMapping[$optionId]) && in_array($storeId, $this->optionValueStoreMapping[$optionId]));
    }

    /**
     * Return's the last created option ID.
     *
     * @return integer $optionId The last created option ID
     */
    protected function getLastOptionId()
    {
        return $this->getSubject()->getLastOptionId();
    }

    /**
     * Return's the option ID for the passed name.
     *
     * @param string $name The name to return the option ID for
     *
     * @return integer The option ID for the passed name
     * @throws \Exception Is thrown, if no option ID for the passed name is available
     */
    protected function getOptionIdForName($name)
    {
        return $this->getSubject()->getOptionIdForName($name);
    }

    /**
     * Return's the store for the passed store code.
     *
     * @param string $storeCode The store code to return the store for
     *
     * @return array The requested store
     * @throws \Exception Is thrown, if the requested store is not available
     */
    protected function getStoreByStoreCode($storeCode)
    {
        return $this->getSubject()->getStoreByStoreCode($storeCode);
    }

    /**
     * Persist's the passed product bundle option value data.
     *
     * @param array $productBundleOptionValue The product bundle option value data to persist
     *
     * @return void
     */
    protected function persistProductBundleOptionValue($productBundleOptionValue)
    {
        $this->getSubject()->persistProductBundleOptionValue($productBundleOptionValue);
    }
}