TechDivision\Import\Product\Magic360\Services\ProductMagic360Processor

Complexity

Total Complexity

20

Size/Duplication

Total Lines	292
Duplicated Lines	0 %

Coupling/Cohesion

Components	5
Dependencies	4

Importance

Changes

0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
A	setConnection()	0	4	1
A	getConnection()	0	4	1
A	beginTransaction()	0	4	1
A	commit()	0	4	1
A	rollBack()	0	4	1
A	setProductMagic360GalleryRepository()	0	4	1
A	getProductMagic360GalleryRepository()	0	4	1
A	setProductMagic360ColumnsRepository()	0	4	1
A	getProductMagic360ColumnsRepository()	0	4	1
A	setMagic360GalleryAction()	0	4	1
A	getMagic360GalleryAction()	0	4	1
A	setMagic360ColumnsAction()	0	4	1
A	getMagic360ColumnsAction()	0	4	1
A	persistMagic360Gallery()	0	4	1
A	persistMagic360Columns()	0	4	1
A	deleteMagic360Gallery()	0	4	1
A	deleteMagic360Columns()	0	4	1
A	loadMagic360Gallery()	0	4	1
A	loadMagic360Columns()	0	4	1

<?php

/**
 * TechDivision\Import\Product\Magic360\Services\ProductMagic360Processor
 *
 * 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>
 * @author    Bernhard Wick <b.wick@techdivision.com>
 * @copyright 2017 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-magic360
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Magic360\Services;

use TechDivision\Import\Product\Magic360\Actions\Magic360GalleryAction;
use TechDivision\Import\Product\Magic360\Actions\Magic360ColumnsAction;
use TechDivision\Import\Product\Magic360\Repositories\ProductMagic360GalleryRepository;
use TechDivision\Import\Product\Magic360\Repositories\ProductMagic360ColumnsRepository;

/**
 * A processor implementation that provides methods to load product data using a PDO connection.
 *
 * @author    Tim Wagner <t.wagner@techdivision.com>
 * @author    Bernhard Wick <b.wick@techdivision.com>
 * @copyright 2017 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-magic360
 * @link      http://www.techdivision.com
 */
class ProductMagic360Processor implements ProductMagic360ProcessorInterface
{

    /**
     * A PDO connection initialized with the values from the Doctrine EntityManager.
     *
     * @var \PDO
     */
    protected $connection;

    /**
     * The repository to load magic360 galleries.
     *
     * @var \TechDivision\Import\Product\Magic360\Repositories\ProductMagic360GalleryRepository
     */
    protected $productMagic360GalleryRepository;

    /**
     * The repository to load magic360 gallery to entities.
     *
     * @var \TechDivision\Import\Product\Magic360\Repositories\ProductMagic360ColumnsRepository
     */
    protected $productMagic360ColumnsRepository;

    /**
     * The action with the magic360 gallery CRUD methods.
     *
     * @var \TechDivision\Import\Product\Magic360\Actions\Magic360GalleryAction
     */
    protected $magic360GalleryAction;

    /**
     * The action with the magic360 gallery value CRUD methods.
     *
     * @var \TechDivision\Import\Product\Magic360\Actions\Magic360ColumnsAction
     */
    protected $magic360ColumnsAction;

    /**
     * Initialize the processor with the necessary assembler and repository instances.
     *
     * @param \PDO                                                                                $connection                       The PDO connection to use
     * @param \TechDivision\Import\Product\Magic360\Repositories\ProductMagic360GalleryRepository $productMagic360GalleryRepository The product magic 360 gallery repository to use
     * @param \TechDivision\Import\Product\Magic360\Repositories\ProductMagic360ColumnsRepository $productMagic360ColumnsRepository The product magic 360 columns repository to use
     * @param \TechDivision\Import\Product\Magic360\Actions\Magic360GalleryAction                 $magic360GalleryAction            The product magic 360 gallery action to use
     * @param \TechDivision\Import\Product\Magic360\Actions\Magic360ColumnsAction                 $magic360ColumnsAction            The product magic 360 columns action to use
     */
    public function __construct(
        \PDO $connection,
        ProductMagic360GalleryRepository $productMagic360GalleryRepository,
        ProductMagic360ColumnsRepository $productMagic360ColumnsRepository,
        Magic360GalleryAction $magic360GalleryAction,
        Magic360ColumnsAction $magic360ColumnsAction
    ) {
        $this->setConnection($connection);
        $this->setProductMagic360GalleryRepository($productMagic360GalleryRepository);
        $this->setProductMagic360ColumnsRepository($productMagic360ColumnsRepository);
        $this->setMagic360GalleryAction($magic360GalleryAction);
        $this->setMagic360ColumnsAction($magic360ColumnsAction);
    }

    /**
     * Sets the passed connection.
     *
     * @param \PDO $connection The connection to set
     *
     * @return void
     */
    public function setConnection(\PDO $connection)
    {
        $this->connection = $connection;
    }

    /**
     * Returns the connection.
     *
     * @return \PDO 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();
    }

    /**
     * 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 repository to load magic360 gallery data.
     *
     * @param \TechDivision\Import\Product\Magic360\Repositories\ProductMagic360GalleryRepository $productMagic360GalleryRepository The repository instance
     *
     * @return void
     */
    public function setProductMagic360GalleryRepository($productMagic360GalleryRepository)
    {
        $this->productMagic360GalleryRepository = $productMagic360GalleryRepository;
    }

    /**
     * Returns the repository to load magic360 gallery data.
     *
     * @return \TechDivision\Import\Product\Magic360\Repositories\ProductMagic360GalleryRepository The repository instance
     */
    public function getProductMagic360GalleryRepository()
    {
        return $this->productMagic360GalleryRepository;
    }

    /**
     * Sets the repository to load magic360 column data.
     *
     * @param \TechDivision\Import\Product\Magic360\Repositories\ProductMagic360ColumnsRepository $productMagic360ColumnsRepository The repository instance
     *
     * @return void
     */
    public function setProductMagic360ColumnsRepository($productMagic360ColumnsRepository)
    {
        $this->productMagic360ColumnsRepository = $productMagic360ColumnsRepository;
    }

    /**
     * Returns the repository to load magic360 column data.
     *
     * @return \TechDivision\Import\Product\Magic360\Repositories\ProductMagic360ColumnsRepository The repository instance
     */
    public function getProductMagic360ColumnsRepository()
    {
        return $this->productMagic360ColumnsRepository;
    }

    /**
     * Sets the action with the magic360 gallery CRUD methods.
     *
     * @param \TechDivision\Import\Product\Magic360\Actions\Magic360GalleryAction $magic360GalleryAction The action with the magic360 gallery CRUD methods
     *
     * @return void
     */
    public function setMagic360GalleryAction($magic360GalleryAction)
    {
        $this->magic360GalleryAction = $magic360GalleryAction;
    }

    /**
     * Returns the action with the magic360 gallery CRUD methods.
     *
     * @return \TechDivision\Import\Product\Magic360\Actions\Magic360GalleryAction $magic360GalleryAction The action with the magic360 gallery CRUD methods
     */
    public function getMagic360GalleryAction()
    {
        return $this->magic360GalleryAction;
    }

    /**
     * Sets the action with the magic360 column CRUD methods.
     *
     * @param \TechDivision\Import\Product\Magic360\Actions\Magic360ColumnsAction $magic360ColumnsAction The action with the magic360 column CRUD methods
     *
     * @return void
     */
    public function setMagic360ColumnsAction($magic360ColumnsAction)
    {
        $this->magic360ColumnsAction = $magic360ColumnsAction;
    }

    /**
     * Returns the action with the magic360 column CRUD methods.
     *
     * @return \TechDivision\Import\Product\Magic360\Actions\Magic360ColumnsAction The action with the magic360 column CRUD methods
     */
    public function getMagic360ColumnsAction()
    {
        return $this->magic360ColumnsAction;
    }

    /**
     * Persists the passed magic360 gallery data and returns the ID.
     *
     * @param array       $galleryEntry The magic360 gallery data 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 persistMagic360Gallery($galleryEntry, $name = null)
    {
        return $this->getMagic360GalleryAction()->persist($galleryEntry, $name);

The call to Magic360GalleryAction::persist() has too many arguments starting with $name.

    }

    /**
     * Persists the passed magic360 column data.
     *
     * @param array       $magic360Columns The magic360 gallery value data to persist
     * @param string|null $name            The name of the prepared statement that has to be executed
     *
     * @return void
     */
    public function persistMagic360Columns($magic360Columns, $name = null)
    {
        $this->getMagic360ColumnsAction()->persist($magic360Columns, $name);

The call to Magic360ColumnsAction::persist() has too many arguments starting with $name.

    }

    /**
     * Persists the passed magic360 gallery data and returns the ID.
     *
     * @param array       $row  The magic360 gallery data to persist
     * @param string|null $name The name of the prepared statement that has to be executed
     *
     * @return void
     */
    public function deleteMagic360Gallery($row, $name = null)
    {
        $this->getMagic360GalleryAction()->delete($row, $name);
    }

    /**
     * Persists the passed magic360 column data.
     *
     * @param array       $row  The magic360 column data to persist
     * @param string|null $name The name of the prepared statement that has to be executed
     *
     * @return void
     */
    public function deleteMagic360Columns($row, $name = null)
    {
        $this->getMagic360ColumnsAction()->delete($row, $name);
    }

    /**
     * Loads the magic360 gallery with the passed product ID and position
     *
     * @param integer $productId The product ID of the magic360 gallery to load
     * @param string  $position  The position of the magic360 gallery entry to load
     *
     * @return array The magic360 gallery
     */
    public function loadMagic360Gallery($productId, $position)
    {
        return $this->getProductMagic360GalleryRepository()->findOneByProductIdAndPosition($productId, $position);
    }

    /**
     * Loads the magic360 gallery with the passed product ID.
     *
     * @param integer $productId The product ID of the magic360 column to load
     *
     * @return array The magic360 gallery
     */
    public function loadMagic360Columns($productId)
    {
        return $this->getProductMagic360ColumnsRepository()->findOneByProductId($productId);
    }
}