TechDivision\Import\Product\Media\Observers\MediaGalleryObserver

Complexity

Total Complexity

22

Size/Duplication

Total Lines	295
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getProductMediaProcessor()	0	4	1
A	process()	0	29	4
A	prepareProductMediaGalleryAttributes()	0	22	1
A	prepareProductMediaGalleryValueToEntityAttributes()	0	11	1
A	initializeProductMediaGallery()	0	4	1
A	initializeProductMediaGalleryValueToEntity()	0	4	1
A	mapParentSku()	0	4	1
A	setParentValueId()	0	4	1
A	mapSkuToEntityId()	0	4	1
A	setParentId()	0	4	1
A	getParentId()	0	4	1
A	isParentId()	0	4	1
A	isParentStoreViewCode()	0	4	1
A	getDefaultStoreViewCode()	0	4	1
A	resetPositionCounter()	0	4	1
A	getEavAttributeByAttributeCode()	0	4	1
A	persistProductMediaGallery()	0	4	1
A	persistProductMediaGalleryValueToEntity()	0	4	1

<?php

/**
 * TechDivision\Import\Product\Media\Observers\MediaGalleryObserver
 *
 * 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-media
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Media\Observers;

use TechDivision\Import\Product\Media\Utils\ColumnKeys;
use TechDivision\Import\Product\Media\Utils\MemberNames;
use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
use TechDivision\Import\Product\Media\Services\ProductMediaProcessorInterface;

/**
 * Observer that creates/updates the product's media gallery information.
 *
 * @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-media
 * @link      http://www.techdivision.com
 */
class MediaGalleryObserver extends AbstractProductImportObserver
{

    /**
     * The media gallery attribute code.
     *
     * @var string
     */
    const ATTRIBUTE_CODE = 'media_gallery';

    /**
     * The ID of the parent product the media is related to.
     *
     * @var integer
     */
    protected $parentId;

    /**
     * The ID of the persisted media gallery entity.
     *
     * @var integer
     */
    protected $valueId;

    /**
     * The product media processor instance.
     *
     * @var \TechDivision\Import\Product\Media\Services\ProductMediaProcessorInterface
     */
    protected $productMediaProcessor;

    /**
     * Initialize the observer with the passed product media processor instance.
     *
     * @param \TechDivision\Import\Product\Media\Services\ProductMediaProcessorInterface $productMediaProcessor The product media processor instance
     */
    public function __construct(ProductMediaProcessorInterface $productMediaProcessor)
    {
        $this->productMediaProcessor = $productMediaProcessor;
    }

    /**
     * Return's the product media processor instance.
     *
     * @return \TechDivision\Import\Product\Media\Services\ProductMediaProcessorInterface The product media processor instance
     */
    protected function getProductMediaProcessor()
    {
        return $this->productMediaProcessor;
    }

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

        // try to load the product SKU and map it the entity ID and
        $this->parentId = $this->getValue(ColumnKeys::IMAGE_PARENT_SKU, null, array($this, 'mapParentSku'));

        // reset the position counter, if either a new PK or store view code has been found
        if (!$this->isParentStoreViewCode($this->getValue(ColumnKeys::STORE_VIEW_CODE, $this->getDefaultStoreViewCode())) ||
            !$this->isParentId($this->parentId)
        ) {
            $this->resetPositionCounter();
        }

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

The call to MediaGalleryObserver::prepareStoreViewCode() has too many arguments starting with $this->getRow().

The method TechDivision\Import\Observers\AbstractObserver::prepareStoreViewCode() has been deprecated with message: Will be removed with version 1.0.0, use subject method instead

        // initialize and persist the product media gallery
        $productMediaGallery = $this->initializeProductMediaGallery($this->prepareProductMediaGalleryAttributes());
        $this->valueId = $this->persistProductMediaGallery($productMediaGallery);

The property $valueId was declared of type integer, but $this->persistProductMediaGallery($productMediaGallery) is of type string. Maybe add a type cast?

        // persist the product media gallery to entity data
        if ($productMediaGalleryValueToEntity = $this->initializeProductMediaGalleryValueToEntity($this->prepareProductMediaGalleryValueToEntityAttributes())) {
            $this->persistProductMediaGalleryValueToEntity($productMediaGalleryValueToEntity);
        }

        // temporarily persist parent/value ID
        $this->setParentId($this->parentId);
        $this->setParentValueId($this->valueId);
    }

    /**
     * Prepare the product media gallery that has to be persisted.
     *
     * @return array The prepared product media gallery attributes
     */
    protected function prepareProductMediaGalleryAttributes()
    {

        // load the attribute ID of the media gallery EAV attribute
        $mediaGalleryAttribute = $this->getEavAttributeByAttributeCode(MediaGalleryObserver::ATTRIBUTE_CODE);
        $attributeId = $mediaGalleryAttribute[MemberNames::ATTRIBUTE_ID];

        // initialize the gallery data
        $disabled = 0;
        $mediaType = 'image';
        $image = $this->getValue(ColumnKeys::IMAGE_PATH_NEW);

        // initialize and return the entity
        return $this->initializeEntity(
            array(
                MemberNames::ATTRIBUTE_ID => $attributeId,
                MemberNames::VALUE        => $image,
                MemberNames::MEDIA_TYPE   => $mediaType,
                MemberNames::DISABLED     => $disabled
            )
        );
    }

    /**
     * Prepare the product media gallery value to entity that has to be persisted.
     *
     * @return array The prepared product media gallery value to entity attributes
     */
    protected function prepareProductMediaGalleryValueToEntityAttributes()
    {

        // initialize and return the entity
        return $this->initializeEntity(
            array(
                MemberNames::VALUE_ID  => $this->valueId,
                MemberNames::ENTITY_ID => $this->parentId
            )
        );
    }

    /**
     * Initialize the product media gallery with the passed attributes and returns an instance.
     *
     * @param array $attr The product media gallery attributes
     *
     * @return array The initialized product media gallery
     */
    protected function initializeProductMediaGallery(array $attr)
    {
        return $attr;
    }

    /**
     * Initialize the product media gallery value to entity with the passed attributes and returns an instance.
     *
     * @param array $attr The product media gallery value to entity attributes
     *
     * @return array|null The initialized product media gallery value to entity, or NULL if the product media gallery value to entity already exists
     */
    protected function initializeProductMediaGalleryValueToEntity(array $attr)
    {
        return $attr;
    }

    /**
     * Map's the passed SKU of the parent product to it's PK.
     *
     * @param string $parentSku The SKU of the parent product
     *
     * @return integer The primary key used to create relations
     */
    protected function mapParentSku($parentSku)
    {
        return $this->mapSkuToEntityId($parentSku);
    }

    /**
     * Set's the value ID of the created media gallery entry.
     *
     * @param integer $parentValueId The ID of the created media gallery entry
     *
     * @return void
     */
    protected function setParentValueId($parentValueId)
    {
        $this->getSubject()->setParentValueId($parentValueId);

It seems like you code against a concrete implementation and not the interface TechDivision\Import\Subjects\SubjectInterface as the method setParentValueId() does only exist in the following implementations of said interface: TechDivision\Import\Product\Media\Subjects\MediaSubject.

    }

    /**
     * Return the entity ID for the passed SKU.
     *
     * @param string $sku The SKU to return the entity ID for
     *
     * @return integer The mapped entity ID
     * @throws \Exception Is thrown if the SKU is not mapped yet
     */
    protected function mapSkuToEntityId($sku)
    {
        return $this->getSubject()->mapSkuToEntityId($sku);

It seems like you code against a concrete implementation and not the interface TechDivision\Import\Subjects\SubjectInterface as the method mapSkuToEntityId() does only exist in the following implementations of said interface: TechDivision\Import\Product\Media\Subjects\MediaSubject.

    }

    /**
     * Set's the ID of the parent product to relate the variant with.
     *
     * @param integer $parentId The ID of the parent product
     *
     * @return void
     */
    protected function setParentId($parentId)
    {
        $this->getSubject()->setParentId($parentId);

It seems like you code against a concrete implementation and not the interface TechDivision\Import\Subjects\SubjectInterface as the method setParentId() does only exist in the following implementations of said interface: TechDivision\Import\Product\Media\Subjects\MediaSubject.

    }

    /**
     * Return's the ID of the parent product to relate the variant with.
     *
     * @return integer The ID of the parent product
     */
    protected function getParentId()
    {
        return $this->getSubject()->getParentId();

It seems like you code against a concrete implementation and not the interface TechDivision\Import\Subjects\SubjectInterface as the method getParentId() does only exist in the following implementations of said interface: TechDivision\Import\Product\Media\Subjects\MediaSubject.

    }

    /**
     * Query whether or not this is the parent ID.
     *
     * @param integer $parentId The PK of the parent image
     *
     * @return boolean TRUE if the PK euqals, else FALSE
     */
    protected function isParentId($parentId)
    {
        return $this->getParentId() === $parentId;
    }

    /**
     * Query whether or not this is the parent store view code.
     *
     * @param string $storeViewCode The actual store view code
     *
     * @return boolean TRUE if the store view code equals, else FALSE
     */
    protected function isParentStoreViewCode($storeViewCode)
    {
        return $this->getStoreViewCode() === $storeViewCode;

The method TechDivision\Import\Observers\AbstractObserver::getStoreViewCode() has been deprecated with message: Will be removed with version 1.0.0, use subject method instead

    }

    /**
     * Return's the default store view code.
     *
     * @return array The default store view code
     */
    protected function getDefaultStoreViewCode()
    {
        return $this->getSubject()->getDefaultStoreViewCode();
    }

    /**
     * Reset the position counter to 1.
     *
     * @return void
     */
    protected function resetPositionCounter()
    {
        $this->getSubject()->resetPositionCounter();

It seems like you code against a concrete implementation and not the interface TechDivision\Import\Subjects\SubjectInterface as the method resetPositionCounter() does only exist in the following implementations of said interface: TechDivision\Import\Product\Media\Subjects\MediaSubject.

    }

    /**
     * Return's the EAV attribute with the passed attribute code.
     *
     * @param string $attributeCode The attribute code
     *
     * @return array The array with the EAV attribute
     * @throws \Exception Is thrown if the attribute with the passed code is not available
     */
    protected function getEavAttributeByAttributeCode($attributeCode)
    {
        return $this->getSubject()->getEavAttributeByAttributeCode($attributeCode);

It seems like you code against a concrete implementation and not the interface TechDivision\Import\Subjects\SubjectInterface as the method getEavAttributeByAttributeCode() does only exist in the following implementations of said interface: TechDivision\Import\Observers\EntitySubjectImpl, TechDivision\Import\Product\Media\Subjects\MediaSubject, TechDivision\Import\Product\Subjects\AbstractProductSubject, TechDivision\Import\Product\Subjects\BunchSubject, TechDivision\Import\Subjects\AbstractEavSubject.

    }

    /**
     * Persist's the passed product media gallery data and return's the ID.
     *
     * @param array $productMediaGallery The product media gallery data to persist
     *
     * @return string The ID of the persisted entity
     */
    protected function persistProductMediaGallery($productMediaGallery)
    {
        return $this->getProductMediaProcessor()->persistProductMediaGallery($productMediaGallery);
    }

    /**
     * Persist's the passed product media gallery value to entity data.
     *
     * @param array $productMediaGalleryValueToEntity The product media gallery value to entity data to persist
     *
     * @return void
     */
    protected function persistProductMediaGalleryValueToEntity($productMediaGalleryValueToEntity)
    {
        $this->getProductMediaProcessor()->persistProductMediaGalleryValueToEntity($productMediaGalleryValueToEntity);
    }
}