TechDivision\Import\Product\TierPrice\Observers\ClearTierPriceObserver

Complexity

Total Complexity

13

Size/Duplication

Total Lines	179
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getStoreWebsiteIdByCode()	0	3	1
A	deleteTierPrice()	0	3	1
A	isValueType()	0	3	1
A	getCustomerGroupIdByCode()	0	3	1
A	loadProduct()	0	3	1
A	isAllGroups()	0	3	1
A	loadTierPriceByPkAndAllGroupsAndCustomerGroupIdAndQtyAndWebsiteId()	0	3	1
A	getValueTypes()	0	3	1
A	__construct()	0	8	1
A	process()	0	39	4

<?php

/**
 * TechDivision\Import\Product\TierPrice\Observers\ClearTierPriceObserver
 *
 * PHP version 7
 *
 * @author    Tim Wagner <t.wagner@techdivision.com>
 * @license   https://opensource.org/licenses/MIT
 * @link      https://github.com/techdivision/import-product-tier-price
 * @link      https://www.techdivision.com
 */

namespace TechDivision\Import\Product\TierPrice\Observers;

use TechDivision\Import\Product\TierPrice\Utils\MemberNames;
use TechDivision\Import\Product\TierPrice\Utils\ValueTypesInterface;
use TechDivision\Import\Product\TierPrice\Services\TierPriceProcessorInterface;
use TechDivision\Import\Utils\RegistryKeys;

/**
 * Observer for deleting tier prices from the database.
 *
 * @author    Tim Wagner <t.wagner@techdivision.com>
 * @license   https://opensource.org/licenses/MIT
 * @link      https://github.com/techdivision/import-product-tier-price
 * @link      https://www.techdivision.com
 */
class ClearTierPriceObserver extends AbstractProductTierPriceObserver
{

    /**
     * The trait that prepares the tier price data.
     *
     * @var \TechDivision\Import\Product\TierPrice\Observers\PrepareTierPriceTrait
     */
    use PrepareTierPriceTrait;

    /**
     * The available tier price value types.
     *
     * @var \TechDivision\Import\Product\TierPrice\Utils\ValueTypesInterface
     */
    protected $valueTypes;

    /**
     * Initialize the observer with the passed product tier price processor instance.
     *
     * @param \TechDivision\Import\Product\TierPrice\Services\TierPriceProcessorInterface $tierPriceProcessor The processor instance
     * @param \TechDivision\Import\Product\TierPrice\Utils\ValueTypesInterface            $valueTypes         The tier price value types
     */
    public function __construct(TierPriceProcessorInterface $tierPriceProcessor, ValueTypesInterface $valueTypes)
    {

        // pass the tier price processor through to the parent instance
        parent::__construct($tierPriceProcessor);

        // set the value types
        $this->valueTypes = $valueTypes;
    }

    /**
     * Returns the tier price value types.
     *
     * @return \TechDivision\Import\Product\TierPrice\Utils\ValueTypesInterface The tier price value types
     */
    protected function getValueTypes()
    {
        return $this->valueTypes;
    }

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

        try {
            // prepare the tier price attributes of the actual row
            $tierPrice = $this->prepareAttributes();

            // load the values for loading the actual tier price
            $pk = $tierPrice[$this->getPrimaryKeyMemberName()];
            $qty = $tierPrice[MemberNames::QTY];
            $allGroups = $tierPrice[MemberNames::ALL_GROUPS];
            $websiteId = $tierPrice[MemberNames::WEBSITE_ID];
            $customerGroupId = $tierPrice[MemberNames::CUSTOMER_GROUP_ID];

            // delete the tier price if available
            if ($tierPrice = $this->loadTierPriceByPkAndAllGroupsAndCustomerGroupIdAndQtyAndWebsiteId($pk, $allGroups, $customerGroupId, $qty, $websiteId)) {
                $this->deleteTierPrice(array(MemberNames::VALUE_ID => $tierPrice[MemberNames::VALUE_ID]));
            }
        } catch (\Exception $e) {
            // query whether or not we're in no-strict mode
            if (!$this->getSubject()->isStrictMode()) {
                $this->getSubject()->getSystemLogger()->warning($e->getMessage());
                $this->mergeStatus(
                    array(
                        RegistryKeys::NO_STRICT_VALIDATIONS => array(
                            basename($this->getFilename()) => array(
                                $this->getLineNumber() => array(
                                    MemberNames::SKU => $e->getMessage()
                                )
                            )
                        )
                    )
                );
                $this->skipRow();
                return;
            }

            // throw the exception agatin in strict mode
            throw $e;
        }
    }

    /**
     * Loads and returns 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->getTierPriceProcessor()->loadProduct($sku);

The method loadProduct() does not exist on TechDivision\Import\Product\TierPrice\Services\TierPriceProcessorInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to TechDivision\Import\Product\TierPrice\Services\TierPriceProcessorInterface.

    }

    /**
     * Returns the tier price with the given parameters.
     *
     * @param string  $pk              The PK of the product relation
     * @param integer $allGroups       The flag if all groups are affected or not
     * @param integer $customerGroupId The customer group ID
     * @param integer $qty             The tier price quantity
     * @param integer $websiteId       The website ID the tier price is related to
     *
     * @return array The tier price
     */
    protected function loadTierPriceByPkAndAllGroupsAndCustomerGroupIdAndQtyAndWebsiteId($pk, $allGroups, $customerGroupId, $qty, $websiteId)
    {
        return $this->getTierPriceProcessor()->loadTierPriceByPkAndAllGroupsAndCustomerGroupIdAndQtyAndWebsiteId($pk, $allGroups, $customerGroupId, $qty, $websiteId);
    }

    /**
     * Deletes the tierprice with the passed attributes.
     *
     * @param array       $row  The attributes of the entity to delete
     * @param string|null $name The name of the prepared statement that has to be executed
     *
     * @return void
     */
    protected function deleteTierPrice($row, $name = null)
    {
        $this->getTierPriceProcessor()->deleteTierPrice($row, $name);
    }

    /**
     * Returns the customer group ID for the given code, if it exists.
     *
     * @param string $code The code of the requested customer group
     *
     * @return integer|null The ID of the customer group
     */
    protected function getCustomerGroupIdByCode($code)
    {
        return $this->getSubject()->getCustomerGroupIdByCode($code);
    }

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

    /**
     * Query whether or not the passed value type is valid.
     *
     * @param string $valueType The value type to query for
     *
     * @return boolean TRUE if the value type is valid, else FALSE
     */
    protected function isValueType($valueType)
    {
        return $this->getValueTypes()->isValueType($valueType);
    }

    /**
     * Queries whether or not the passed customer group code matches all groups or not.
     *
     * @param string $code The customer group code to query for
     *
     * @return boolean TRUE if the customer group code matches, else FALSE
     */
    protected function isAllGroups($code)
    {
        return $this->getSubject()->isAllGroups($code);
    }
}