ProductMediaProcessor::deleteProductMediaGallery() - Code Metrics - Inspection of "Add functionality to clean-up media gallery when i..." - techdivision/import-product-media - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#23)

by Tim
created 2017-09-02 11:29 UTC
ProductMediaProcessor::deleteProductMediaGallery() A

↳ Parent: ProductMediaProcessor
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	2
crap	2
<?php

/**
 * TechDivision\Import\Product\Media\Services\ProductMediaProcessor
 *
 * 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 <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-product-media
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Media\Services;

use TechDivision\Import\Connection\ConnectionInterface;
use TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryRepository;
use TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryValueRepository;
use TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryValueToEntityRepository;
use TechDivision\Import\Product\Media\Actions\ProductMediaGalleryValueToEntityAction;
use TechDivision\Import\Product\Media\Actions\ProductMediaGalleryValueVideoAction;
use TechDivision\Import\Product\Media\Actions\ProductMediaGalleryAction;
use TechDivision\Import\Product\Media\Actions\ProductMediaGalleryValueAction;

/**
 * A SLSB providing methods to load product data using a PDO connection.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-product-media
 * @link      http://www.techdivision.com
 */
class ProductMediaProcessor implements ProductMediaProcessorInterface
{

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

    /**
     * The repository to load product media galleries.
     *
     * @var \TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryRepository
     */
    protected $productMediaGalleryRepository;

    /**
     * The repository to load product media gallery to entities.
     *
     * @var \TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryValueToEntityRepository
     */
    protected $productMediaGalleryValueToEntityRepository;

    /**
     * The repository to load product media gallery values.
     *
     * @var \TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryValueRepository
     */
    protected $productMediaGalleryValueRepository;

    /**
     * The action with the product media gallery CRUD methods.
     *
     * @var \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryAction
     */
    protected $productMediaGalleryAction;

    /**
     * The action with the product media gallery value CRUD methods.
     *
     * @var \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryValueAction
     */
    protected $productMediaGalleryValueAction;

    /**
     * The action with the product media gallery value to entity CRUD methods.
     *
     * @var \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryValueToEntityAction
     */
    protected $productMediaGalleryValueToEntityAction;

    /**
     * The action with the product media gallery video CRUD methods.
     *
     * @var \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryValueVideoAction
     */
    protected $productMediaGalleryVideoAction;

    /**
     * Initialize the processor with the necessary assembler and repository instances.
     *
     * @param \TechDivision\Import\Connection\ConnectionInterface                                        $connection                                 The connection to use
     * @param \TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryRepository              $productMediaGalleryRepository              The product media gallery repository to use
     * @param \TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryValueRepository         $productMediaGalleryValueRepository         The product media gallery value repository to use
     * @param \TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryValueToEntityRepository $productMediaGalleryValueToEntityRepository The product media gallery value to entity repository to use
     * @param \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryAction                       $productMediaGalleryAction                  The product media gallery action to use
     * @param \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryValueAction                  $productMediaGalleryValueAction             The product media gallery value action to use
     * @param \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryValueToEntityAction          $productMediaGalleryValueToEntityAction     The product media gallery value to entity action to use
     * @param \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryValueVideoAction             $productMediaGalleryValueVideoAction        The product media gallery value video action to use
     */
    public function __construct(
        ConnectionInterface $connection,
        ProductMediaGalleryRepository $productMediaGalleryRepository,
        ProductMediaGalleryValueRepository $productMediaGalleryValueRepository,
        ProductMediaGalleryValueToEntityRepository $productMediaGalleryValueToEntityRepository,
        ProductMediaGalleryAction $productMediaGalleryAction,
        ProductMediaGalleryValueAction $productMediaGalleryValueAction,
        ProductMediaGalleryValueToEntityAction $productMediaGalleryValueToEntityAction,
        ProductMediaGalleryValueVideoAction $productMediaGalleryValueVideoAction
    ) {
        $this->setConnection($connection);
        $this->setProductMediaGalleryRepository($productMediaGalleryRepository);
        $this->setProductMediaGalleryValueRepository($productMediaGalleryValueRepository);
        $this->setProductMediaGalleryValueToEntityRepository($productMediaGalleryValueToEntityRepository);
        $this->setProductMediaGalleryAction($productMediaGalleryAction);
        $this->setProductMediaGalleryValueAction($productMediaGalleryValueAction);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->setProductMediaGalleryValueToEntityAction($productMediaGalleryValueToEntityAction);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->setProductMediaGalleryValueVideoAction($productMediaGalleryValueVideoAction);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

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

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

    /**
     * Set's the repository to load product media gallery data.
     *
     * @param \TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryRepository $productMediaGalleryRepository The repository instance
     *
     * @return void
     */
    public function setProductMediaGalleryRepository($productMediaGalleryRepository)
    {
        $this->productMediaGalleryRepository = $productMediaGalleryRepository;
    }

    /**
     * Return's the repository to load product media gallery data.
     *
     * @return \TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryRepository The repository instance
     */
    public function getProductMediaGalleryRepository()
    {
        return $this->productMediaGalleryRepository;
    }

    /**
     * Set's the repository to load product media gallery value to entity data.
     *
     * @param \TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryValueToEntityRepository $productMediaGalleryValueToEntityRepository The repository instance
     *
     * @return void
     */
    public function setProductMediaGalleryValueToEntityRepository($productMediaGalleryValueToEntityRepository)
    {
        $this->productMediaGalleryValueToEntityRepository = $productMediaGalleryValueToEntityRepository;
    }

    /**
     * Return's the repository to load product media gallery value to entity data.
     *
     * @return \TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryValueToEntityRepository The repository instance
     */
    public function getProductMediaGalleryValueToEntityRepository()
    {
        return $this->productMediaGalleryValueToEntityRepository;
    }

    /**
     * Set's the repository to load product media gallery value data.
     *
     * @param \TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryValueRepository $productMediaGalleryValueRepository The repository instance
     *
     * @return void
     */
    public function setProductMediaGalleryValueRepository($productMediaGalleryValueRepository)
    {
        $this->productMediaGalleryValueRepository = $productMediaGalleryValueRepository;
    }

    /**
     * Return's the repository to load product media gallery value data.
     *
     * @return \TechDivision\Import\Product\Media\Repositories\ProductMediaGalleryValueRepository The repository instance
     */
    public function getProductMediaGalleryValueRepository()
    {
        return $this->productMediaGalleryValueRepository;
    }

    /**
     * Set's the action with the product media gallery CRUD methods.
     *
     * @param \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryAction $productMediaGalleryAction The action with the product media gallery CRUD methods
     *
     * @return void
     */
    public function setProductMediaGalleryAction($productMediaGalleryAction)
    {
        $this->productMediaGalleryAction = $productMediaGalleryAction;
    }

    /**
     * Return's the action with the product media gallery CRUD methods.
     *
     * @return \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryAction The action with the product media gallery CRUD methods
     */
    public function getProductMediaGalleryAction()
    {
        return $this->productMediaGalleryAction;
    }

    /**
     * Set's the action with the product media gallery valueCRUD methods.
     *
     * @param \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryAction $productMediaGalleryValueAction The action with the product media gallery value CRUD methods
     *
     * @return void
     */
    public function setProductMediaGalleryValueAction($productMediaGalleryValueAction)
    {
        $this->productMediaGalleryValueAction = $productMediaGalleryValueAction;

    }

    /**
     * Return's the action with the product media gallery valueCRUD methods.
     *
     * @return \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryAction The action with the product media gallery value CRUD methods
     */
    public function getProductMediaGalleryValueAction()
    {
        return $this->productMediaGalleryValueAction;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Set's the action with the product media gallery value to entity CRUD methods.
     *
     * @param \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryAction $productMediaGalleryValueToEntityAction The action with the product media gallery value to entity CRUD methods
     *
     * @return void
     */
    public function setProductMediaGalleryValueToEntityAction($productMediaGalleryValueToEntityAction)
    {
        $this->productMediaGalleryValueToEntityAction = $productMediaGalleryValueToEntityAction;

    }

    /**
     * Return's the action with the product media gallery value to entity CRUD methods.
     *
     * @return \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryAction $productMediaGalleryAction The action with the product media gallery value to entity CRUD methods
     */
    public function getProductMediaGalleryValueToEntityAction()
    {
        return $this->productMediaGalleryValueToEntityAction;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Set's the action with the product media gallery value video CRUD methods.
     *
     * @param \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryAction $productMediaGalleryValueVideoAction The action with the product media gallery value video CRUD methods
     *
     * @return void
     */
    public function setProductMediaGalleryValueVideoAction($productMediaGalleryValueVideoAction)
    {
        $this->productMediaGalleryValueVideoAction = $productMediaGalleryValueVideoAction;

    }

    /**
     * Return's the action with the product media gallery value video CRUD methods.
     *
     * @return \TechDivision\Import\Product\Media\Actions\ProductMediaGalleryAction The action with the product media gallery value video CRUD methods
     */
    public function getProductMediaGalleryValueVideoAction()
    {
        return $this->productMediaGalleryValueVideoAction;

    }

    /**
     * Load's the product media gallery with the passed attribute ID + value.
     *
     * @param integer $attributeId The attribute ID of the product media gallery to load
     * @param string  $value       The value of the product media gallery to load
     *
     * @return array The product media gallery
     */
    public function loadProductMediaGallery($attributeId, $value)
    {
        return $this->getProductMediaGalleryRepository()->findOneByAttributeIdAndValue($attributeId, $value);
    }

    /**
     * Load's the product media gallery with the passed value/entity ID.
     *
     * @param integer $valueId  The value ID of the product media gallery value to entity to load
     * @param integer $entityId The entity ID of the product media gallery value to entity to load
     *
     * @return array The product media gallery
     */
    public function loadProductMediaGalleryValueToEntity($valueId, $entityId)
    {
        return $this->getProductMediaGalleryValueToEntityRepository()->findOneByValueIdAndEntityId($valueId, $entityId);
    }

    /**
     * Load's the product media gallery value with the passed value/store/parent ID.
     *
     * @param integer $valueId  The value ID of the product media gallery value to load
     * @param string  $storeId  The store ID of the product media gallery value to load
     * @param string  $entityId The entity ID of the parent product of the product media gallery value to load
     *
     * @return array The product media gallery value
     */
    public function loadProductMediaGalleryValue($valueId, $storeId, $entityId)
    {
        return $this->getProductMediaGalleryValueRepository()->findOneByValueIdAndStoreIdAndEntityId($valueId, $storeId, $entityId);
    }

    /**
     * Load's the product media gallery entities with the passed SKU.
     *
     * @param string $sku The SKU to load the media gallery entities for
     *
     * @return array The product media gallery entities
     */
    public function getProductMediaGalleriesBySku($sku)
    {
        return $this->getProductMediaGalleryRepository()->findAllBySku($sku);
    }

    /**
     * Persist's the passed product media gallery data and return's the ID.
     *
     * @param array       $productMediaGallery The product media 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 persistProductMediaGallery($productMediaGallery, $name = null)
    {
        return $this->getProductMediaGalleryAction()->persist($productMediaGallery, $name);

    }

    /**
     * Persist's the passed product media gallery value data.
     *
     * @param array       $productMediaGalleryValue The product media gallery value data to persist
     * @param string|null $name                     The name of the prepared statement that has to be executed
     *
     * @return void
     */
    public function persistProductMediaGalleryValue($productMediaGalleryValue, $name = null)
    {
        $this->getProductMediaGalleryValueAction()->persist($productMediaGalleryValue, $name);

    }

    /**
     * Persist's the passed product media gallery value to entity data.
     *
     * @param array       $productMediaGalleryValuetoEntity The product media gallery value to entity data to persist
     * @param string|null $name                             The name of the prepared statement that has to be executed
     *
     * @return void
     */
    public function persistProductMediaGalleryValueToEntity($productMediaGalleryValuetoEntity, $name = null)
    {
        $this->getProductMediaGalleryValueToEntityAction()->persist($productMediaGalleryValuetoEntity, $name);

    }

    /**
     * Persist's the passed product media gallery value video data.
     *
     * @param array       $productMediaGalleryValueVideo The product media gallery value video data to persist
     * @param string|null $name                          The name of the prepared statement that has to be executed
     *
     * @return void
     */
    public function persistProductMediaGalleryValueVideo($productMediaGalleryValueVideo, $name = null)
    {
        $this->getProductMediaGalleryValueVideoAction()->persist($productMediaGalleryValueVideo, $name);

    }

    /**
     * Delete's the passed product media gallery data.
     *
     * @param array       $row  The product media gallery data to be deleted
     * @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 deleteProductMediaGallery(array $row, $name = null)
    {
        return $this->getProductMediaGalleryAction()->delete($row, $name);
    }
}

techdivision / import-product-media

Pull Request — master (#23)

ProductMediaProcessor::deleteProductMediaGallery() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
