TechDivision\Import\Product\TierPrice\Services\TierPriceProcessor

Complexity

Total Complexity

18

Size/Duplication

Total Lines	234
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	deleteTierPrice()	0	3	1
A	rollBack()	0	3	1
A	cleanUpTierPrices()	0	17	4
A	getTierPriceRepository()	0	3	1
A	getTierPriceAction()	0	3	1
A	loadTierPrices()	0	3	1
A	beginTransaction()	0	3	1
A	commit()	0	3	1
A	setTierPriceRepository()	0	3	1
A	setConnection()	0	3	1
A	loadTierPriceByEntityIdAndAllGroupsAndCustomerGroupIdAndQtyAndWebsiteId()	0	3	1
A	persistTierPrice()	0	3	1
A	setTierPriceAction()	0	3	1
A	getConnection()	0	3	1

<?php

/**
 * TechDivision\Import\Product\TierPrice\Services\TierPriceProcessor
 *
 * 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    Klaas-Tido Rühl <kr@refusion.com>
 * @author    Tim Wagner <t.wagner@techdivision.com>
 * @copyright 2019 REFUSiON GmbH <info@refusion.com>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-product-tier-price
 * @link      https://www.techdivision.com
 * @link      https://www.refusion.com
 */

namespace TechDivision\Import\Product\TierPrice\Services;

use TechDivision\Import\Actions\ActionInterface;
use TechDivision\Import\Connection\ConnectionInterface;
use TechDivision\Import\Product\TierPrice\Utils\MemberNames;
use TechDivision\Import\Product\Repositories\ProductRepositoryInterface;
use TechDivision\Import\Product\TierPrice\Repositories\TierPriceRepositoryInterface;

/**
 * Default implementation of tier price processor objects, giving access to CRUD methods.
 *
 * @author    Klaas-Tido Rühl <kr@refusion.com>
 * @author    Tim Wagner <t.wagner@techdivision.com>
 * @copyright 2019 REFUSiON GmbH <info@refusion.com>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-product-tier-price
 * @link      https://www.techdivision.com
 * @link      https://www.refusion.com
 */
class TierPriceProcessor implements TierPriceProcessorInterface
{

    /**
     * A \PDO connection used to load data and handle CRUD functionality.
     *
     * @var \TechDivision\Import\Connection\ConnectionInterface
     */
    protected $connection;

    /**
     * The action for tier price  CRUD methods.
     *
     * @var \TechDivision\Import\Actions\ActionInterface
     */
    protected $tierPriceAction;

    /**
     * The repository to load the tier prices with.
     *
     * @var \TechDivision\Import\Product\TierPrice\Repositories\TierPriceRepositoryInterface
     */
    protected $tierPriceRepository;

    /**
     * Caches the existing tier price records referenced by their unique hash.
     *
     * @var array
     */
    protected $tierPricesByHash = null;

    /**
     * Initialize the processor with the necessary assembler and repository instances.
     *
     * @param \TechDivision\Import\Connection\ConnectionInterface                              $connection          The \PDO connnection instance
     * @param \TechDivision\Import\Product\TierPrice\Repositories\TierPriceRepositoryInterface $tierPriceRepository The repository to load the tier prices with
     * @param \TechDivision\Import\Actions\ActionInterface                                     $tierPriceAction     The action for tier price  CRUD methods
     */
    public function __construct(
        ConnectionInterface $connection,
        TierPriceRepositoryInterface $tierPriceRepository,
        ActionInterface $tierPriceAction
    ) {
        $this->setConnection($connection);
        $this->setTierPriceRepository($tierPriceRepository);
        $this->setTierPriceAction($tierPriceAction);
    }

    /**
     * Set's the passed connection.
     *
     * @param \TechDivision\Import\Connection\ConnectionInterface $connection The connection to set
     *
     * @return void
     */
    public function setConnection(ConnectionInterface $connection)
    {
        $this->connection = $connection;
    }

    /**
     * Return's the connection.
     *
     * @return \TechDivision\Import\Connection\ConnectionInterface The connection instance
     */
    public function getConnection()
    {
        return $this->connection;
    }

    /**
     * Turns off autocommit mode. While autocommit mode is turned off, changes made to the database via the PDO
     * object instance are not committed until you end the transaction by calling ProductProcessor::commit().
     * Calling ProductProcessor::rollBack() will roll back all changes to the database and return the connection
     * to autocommit mode.
     *
     * @return boolean Returns TRUE on success or FALSE on failure
     * @link http://php.net/manual/en/pdo.begintransaction.php
     */
    public function beginTransaction()
    {
        return $this->connection->beginTransaction();
    }

    /**
     * Commits a transaction, returning the database connection to autocommit mode until the next call to
     * ProductProcessor::beginTransaction() starts a new transaction.
     *
     * @return boolean Returns TRUE on success or FALSE on failure
     * @link http://php.net/manual/en/pdo.commit.php
     */
    public function commit()
    {
        return $this->connection->commit();

The expression return $this->connection->commit() returns the type void which is incompatible with the documented return type boolean.

Are you sure the usage of $this->connection->commit() targeting TechDivision\Import\Connection\ConnectionInterface::commit() seems to always return null.

    }

    /**
     * Rolls back the current transaction, as initiated by ProductProcessor::beginTransaction().
     *
     * If the database was set to autocommit mode, this function will restore autocommit mode after it has
     * rolled back the transaction.
     *
     * Some databases, including MySQL, automatically issue an implicit COMMIT when a database definition
     * language (DDL) statement such as DROP TABLE or CREATE TABLE is issued within a transaction. The implicit
     * COMMIT will prevent you from rolling back any other changes within the transaction boundary.
     *
     * @return boolean Returns TRUE on success or FALSE on failure
     * @link http://php.net/manual/en/pdo.rollback.php
     */
    public function rollBack()
    {
        return $this->connection->rollBack();
    }

    /**
     * Sets the action with the tier price CRUD methods.
     *
     * @param \TechDivision\Import\Actions\ActionInterface $tierPriceAction The action with the tier price CRUD methods
     *
     * @return void
     */
    public function setTierPriceAction(ActionInterface $tierPriceAction)
    {
        $this->tierPriceAction = $tierPriceAction;
    }

    /**
     * Returns the action with the tier price CRUD methods.
     *
     * @return \TechDivision\Import\Actions\ActionInterface The action instance
     */
    public function getTierPriceAction()
    {
        return $this->tierPriceAction;
    }

    /**
     * Sets the repository to load the tier prices with.
     *
     * @param \TechDivision\Import\Product\TierPrice\Repositories\TierPriceRepositoryInterface $tierPriceRepository The repository instance
     *
     * @return void
     */
    public function setTierPriceRepository(TierPriceRepositoryInterface $tierPriceRepository)
    {
        $this->tierPriceRepository = $tierPriceRepository;
    }

    /**
     * Returns the repository to load the tier prices with.
     *
     * @return \TechDivision\Import\Product\TierPrice\Repositories\TierPriceRepositoryInterface The repository instance
     */
    public function getTierPriceRepository()
    {
        return $this->tierPriceRepository;
    }

    /**
     * Returns all tier prices.
     *
     * @return array The array with the tier prices
     */
    public function loadTierPrices()
    {
        return $this->getTierPriceRepository()->findAll();
    }

    /**
     * Returns the tier price with the given parameters.
     *
     * @param string  $entityId        The entity ID 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
     */
    public function loadTierPriceByEntityIdAndAllGroupsAndCustomerGroupIdAndQtyAndWebsiteId($entityId, $allGroups, $customerGroupId, $qty, $websiteId)
    {
        return $this->getTierPriceRepository()->findOneByEntityIdAndAllGroupsAndCustomerGroupIdAndQtyAndWebsiteId($entityId, $allGroups, $customerGroupId, $qty, $websiteId);
    }

    /**
     * Persists the tier price with the passed data.
     *
     * @param array       $row  The tier price to persist
     * @param string|null $name The name of the prepared statement that has to be executed
     *
     * @return string The ID of the persisted entity
     */
    public function persistTierPrice($row, $name = null)
    {
        return $this->getTierPriceAction()->persist($row, $name);

The call to TechDivision\Import\Actions\ActionInterface::persist() has too many arguments starting with $name.

Are you sure the usage of $this->getTierPriceAction()->persist($row, $name) targeting TechDivision\Import\Actions\ActionInterface::persist() seems to always return null.

The expression return $this->getTierPriceAction()->persist($row, $name) returns the type void which is incompatible with the documented return type string.

    }

    /**
     * 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
     */
    public function deleteTierPrice($row, $name = null)
    {
        $this->getTierPriceAction()->delete($row, $name);
    }

    /**
     * Clean-Up the tier prices after an add-update operation.
     *
     * @param array $processedTierPrices The array with the IDs of the processed tier prices
     *
     * @return void
     */
    public function cleanUpTierPrices(array $processedTierPrices)
    {

        // load the available + the processed tier prices
        $availableTierPrices = $this->loadTierPrices();

        // iterate over the tier prices and delete the obsolete ones
        foreach ($availableTierPrices as $tierPrice) {
            // if imported, we continue
            if (isset($processedTierPrices[$tierPrice[MemberNames::VALUE_ID]])) {
                // if the product has been touched by the import, delete the tier price
                if (in_array($tierPrice[MemberNames::ENTITY_ID], $processedTierPrices[$tierPrice[MemberNames::VALUE_ID]])) {
                    continue;
                }

                // delete the tier price, because the entity is part of the import but the tier price is NOT available any more
                $this->deleteTierPrice([MemberNames::VALUE_ID => $tierPrice[MemberNames::VALUE_ID]]);
            }
        }
    }
}