ProductMediaObserver - Code Metrics - Inspection of "* Add #PAC-47: Add entity merger implementation to..." - techdivision/import-product-media - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 23.x ( b390a3...481f59 )

by Tim

created 2020-05-29 21:01 UTC

ProductMediaObserver A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	383
Duplicated Lines	5.74 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	34
lcom	1
cbo	1
dl	22
loc	383
ccs	0
cts	161
cp	0
rs	9.68
c	0
b	0
f	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	process()	0	27	2
A	getImageValue()	0	13	4
B	processImages()	0	69	8
B	processAdditionalImages()	0	57	8
A	loadImagesToHide()	11	11	2
A	loadImagesToDisable()	11	11	2
A	getImageTypes()	0	4	1
A	getDefaultImageLabel()	0	4	1
A	getDefaultImagePosition()	0	4	1
A	getImageMapping()	0	4	1
A	getInversedImageMapping()	0	4	1
A	getMediaRoles()	0	4	1
A	newArtefact()	0	4	1
A	addArtefacts()	0	4	1

How to fix Duplicated Code

<?php

/**
 * TechDivision\Import\Product\Media\Observers\ProductMediaObserver
 *
 * 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\Observers;

use TechDivision\Import\Product\Media\Utils\ColumnKeys;
use TechDivision\Import\Product\Observers\AbstractProductImportObserver;

/**
 * Observer that extracts theproduct's media data from a CSV file to be added to media specifi CSV file.
 *
 * @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 ProductMediaObserver extends AbstractProductImportObserver
{

    /**
     * The artefact type.
     *
     * @var string
     */
    const ARTEFACT_TYPE = 'media';

    /**
     * The the default image label.
     *
     * @var string
     */
    const DEFAULT_IMAGE_LABEL = 'Image';

    /**
     * The default image position.
     *
     * @var int
     */
    const DEFAULT_IMAGE_POSITION = 0;

    /**
     * The array with the image information of on row before they'll be converted into artefacts.
     *
     * @var array
     */
    protected $images = array();

    /**
     * The image artefacts that has to be exported.
     *
     * @var array
     */
    protected $artefacts = array();

    /**
     * The array with names of the images that should be hidden on the product detail page.
     *
     * @var array
     */
    protected $imagesToHide = array();

    /**
     * The array with names of the images that has to be disabled.
     *
     * @var array
     */
    protected $disabledImages = array();

    /**
     * Holds the image values of the main row.
     *
     * @var array
     */
    protected $mainRow = array();

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

        // reset the values of the parent row, if the SKU changes
        if ($this->isLastSku($this->getValue(ColumnKeys::SKU)) === false) {
            $this->mainRow = array();
        }

        // initialize the arrays for the images, the artefacts,
        // the hidden as well as the disabled images
        $this->images = array();
        $this->artefacts = array();
        $this->imagesToHide = array();
        $this->disabledImages = array();

        // load the images that has to be hidden on product
        // detail page or completely disabled
        $this->loadImagesToHide();
        $this->loadImagesToDisable();

        // process the images/additional images
        $this->processImages();
        $this->processAdditionalImages();

        // append the artefacts that has to be exported to the subject
        $this->addArtefacts($this->artefacts);
    }

    /**
     * Resolve's the value with the passed colum name from the actual row. If a callback will
     * be passed, the callback will be invoked with the found value as parameter. If
     * the value is NULL or empty, the default value will be returned.
     *
     * @param string        $name     The name of the column to return the value for
     * @param mixed|null    $default  The default value, that has to be returned, if the row's value is empty
     * @param callable|null $callback The callback that has to be invoked on the value, e. g. to format it
     *
     * @return mixed|null The, almost formatted, value
     * @see \TechDivision\Import\Observers\AbstractObserver::getValue()
     */
    protected function getImageValue($name, $default = null, callable $callback = null)
    {

        // query whether or not the a image value is available, return it if yes
        if ($this->hasValue($name) && $this->isLastSku($this->getValue(ColumnKeys::SKU)) === false) {
            return $this->mainRow[$name] = $this->getValue($name, $default, $callback);
        }

        // try to load it from the parent rows
        if (isset($this->mainRow[$name])) {
            return $this->mainRow[$name];
        }
    }

    /**
     * Parses the column and exports the image data to a separate file.
     *
     * @return void
     */
    protected function processImages()
    {

        // load the store view code
        $storeViewCode = $this->getValue(ColumnKeys::STORE_VIEW_CODE);
        $attributeSetCode = $this->getValue(ColumnKeys::ATTRIBUTE_SET_CODE);

        // load the parent SKU from the row
        $parentSku = $this->getValue(ColumnKeys::SKU);

        // load the media roles
        $mediaRoles = $this->getMediaRoles();

        // iterate over the available image fields
        foreach ($mediaRoles as $mediaAttrColumnNames) {
            // query whether or not the column contains an image name
            if ($image = $this->getImageValue($imageColumnName = $mediaAttrColumnNames[ColumnKeys::IMAGE_PATH])) {
                // load the original image path and query whether or not an image with the name already exists
                if (isset($this->artefacts[$imagePath = $this->getInversedImageMapping($image)])) {
                    continue;
                }

                // initialize the label text
                $labelText = null;
                // query whether or not a custom label text has been passed
                if ($this->hasValue($labelColumnName = $mediaAttrColumnNames[ColumnKeys::IMAGE_LABEL])) {
                    $labelText = $this->getValue($mediaAttrColumnNames[ColumnKeys::IMAGE_LABEL]);
                }

                // initialize the default image position
                $position = null;
                // query and retrieve optional image position
                if ($this->hasValue($mediaAttrColumnNames[ColumnKeys::IMAGE_POSITION])) {
                    $position = $this->getValue($mediaAttrColumnNames[ColumnKeys::IMAGE_POSITION]);
                }

                // prepare the new base image
                $artefact = $this->newArtefact(
                    array(
                        ColumnKeys::STORE_VIEW_CODE        => $storeViewCode,
                        ColumnKeys::ATTRIBUTE_SET_CODE     => $attributeSetCode,
                        ColumnKeys::IMAGE_PARENT_SKU       => $parentSku,
                        ColumnKeys::IMAGE_PATH             => $imagePath,
                        ColumnKeys::IMAGE_PATH_NEW         => $image,
                        ColumnKeys::HIDE_FROM_PRODUCT_PAGE => in_array($image, $this->imagesToHide) ? 1 : 0,
                        ColumnKeys::MEDIA_TYPE             => 'image',
                        ColumnKeys::IMAGE_LABEL            => $labelText,
                        ColumnKeys::IMAGE_POSITION         => $position,
                        ColumnKeys::IMAGE_DISABLED         => in_array($image, $this->disabledImages) ? 1 : 0,
                    ),
                    array(
                        ColumnKeys::STORE_VIEW_CODE        => ColumnKeys::STORE_VIEW_CODE,
                        ColumnKeys::ATTRIBUTE_SET_CODE     => ColumnKeys::ATTRIBUTE_SET_CODE,
                        ColumnKeys::IMAGE_PARENT_SKU       => ColumnKeys::SKU,
                        ColumnKeys::IMAGE_PATH             => $imageColumnName,
                        ColumnKeys::IMAGE_PATH_NEW         => $imageColumnName,
                        ColumnKeys::HIDE_FROM_PRODUCT_PAGE => ColumnKeys::HIDE_FROM_PRODUCT_PAGE,
                        ColumnKeys::MEDIA_TYPE             => null,
                        ColumnKeys::IMAGE_LABEL            => $labelColumnName,
                        ColumnKeys::IMAGE_POSITION         => $mediaAttrColumnNames[ColumnKeys::IMAGE_POSITION],
                        ColumnKeys::IMAGE_DISABLED         => ColumnKeys::DISABLED_IMAGES
                    )
                );

                // append the base image to the artefacts
                $this->artefacts[$imagePath] = $artefact;
            }
        }
    }

    /**
     * Parses the column and exports the additional image data to a separate file.
     *
     * @return void
     */
    protected function processAdditionalImages()
    {

        // load the store view code
        $storeViewCode = $this->getValue(ColumnKeys::STORE_VIEW_CODE);
        $attributeSetCode = $this->getValue(ColumnKeys::ATTRIBUTE_SET_CODE);

        // load the parent SKU from the row
        $parentSku = $this->getValue(ColumnKeys::SKU);

        // query whether or not, we've additional images
        if ($additionalImages = $this->getImageValue(ColumnKeys::ADDITIONAL_IMAGES, null, array($this, 'explode'))) {
            // expand the additional image labels, if available
            $additionalImageLabels = $this->getValue(ColumnKeys::ADDITIONAL_IMAGE_LABELS, array(), array($this, 'explode'));
            // retrieve the additional image positions
            $additionalImagePositions = $this->getValue(ColumnKeys::ADDITIONAL_IMAGE_POSITIONS, array(), array($this, 'explode'));

            // initialize the images with the found values
            foreach ($additionalImages as $key => $additionalImage) {
                // load the original image path and query whether or not an image with the name already exists
                if (isset($this->artefacts[$imagePath = $this->getInversedImageMapping($additionalImage)])) {
                    continue;
                }

                // prepare the additional image
                $artefact = $this->newArtefact(
                    array(
                        ColumnKeys::STORE_VIEW_CODE        => $storeViewCode,
                        ColumnKeys::ATTRIBUTE_SET_CODE     => $attributeSetCode,
                        ColumnKeys::IMAGE_PARENT_SKU       => $parentSku,
                        ColumnKeys::IMAGE_PATH             => $imagePath,
                        ColumnKeys::IMAGE_PATH_NEW         => $additionalImage,
                        ColumnKeys::HIDE_FROM_PRODUCT_PAGE => in_array($additionalImage, $this->imagesToHide) ? 1 : 0,
                        ColumnKeys::MEDIA_TYPE             => 'image',
                        ColumnKeys::IMAGE_LABEL            => isset($additionalImageLabels[$key]) ? $additionalImageLabels[$key] : null,
                        ColumnKeys::IMAGE_POSITION         => isset($additionalImagePositions[$key]) ? $additionalImagePositions[$key] : null,
                        ColumnKeys::IMAGE_DISABLED         => in_array($additionalImage, $this->disabledImages) ? 1 : 0
                    ),
                    array(
                        ColumnKeys::STORE_VIEW_CODE        => ColumnKeys::STORE_VIEW_CODE,
                        ColumnKeys::ATTRIBUTE_SET_CODE     => ColumnKeys::ATTRIBUTE_SET_CODE,
                        ColumnKeys::IMAGE_PARENT_SKU       => ColumnKeys::SKU,
                        ColumnKeys::IMAGE_PATH             => ColumnKeys::ADDITIONAL_IMAGES,
                        ColumnKeys::IMAGE_PATH_NEW         => ColumnKeys::ADDITIONAL_IMAGES,
                        ColumnKeys::HIDE_FROM_PRODUCT_PAGE => ColumnKeys::HIDE_FROM_PRODUCT_PAGE,
                        ColumnKeys::MEDIA_TYPE             => null,
                        ColumnKeys::IMAGE_LABEL            => ColumnKeys::ADDITIONAL_IMAGE_LABELS,
                        ColumnKeys::IMAGE_POSITION         => ColumnKeys::ADDITIONAL_IMAGE_POSITIONS,
                        ColumnKeys::IMAGE_DISABLED         => ColumnKeys::DISABLED_IMAGES
                    )
                );

                // append the additional image to the artefacts
                $this->artefacts[$imagePath] = $artefact;
            }
        }
    }

    /**
     * Load the images that has to be hidden on the product detail page.
     *
     * @return void
     */
    protected function loadImagesToHide()

    {

        // load the array with the images that has to be hidden
        $hideFromProductPage = $this->getValue(ColumnKeys::HIDE_FROM_PRODUCT_PAGE, array(), array($this, 'explode'));

        // map the image names, because probably they have been renamed by the upload functionality
        foreach ($hideFromProductPage as $filename) {
            $this->imagesToHide[] = $this->getImageMapping($filename);
        }
    }

    /**
     * Load the images that has to be disabled
     *
     * @return void
     */
    protected function loadImagesToDisable()

    {

        // load the array with the images that has to be disabled
        $disabledImages = $this->getValue(ColumnKeys::DISABLED_IMAGES, array(), array($this, 'explode'));

        // map the image names, because probably they have been renamed by the upload functionality
        foreach ($disabledImages as $filename) {
            $this->disabledImages[] = $this->getImageMapping($filename);
        }
    }

    /**
     * Return's the array with the available image types and their label columns.
     *
     * @return array The array with the available image types
     */
    protected function getImageTypes()
    {
        return $this->getSubject()->getImageTypes();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Return's the default image label.
     *
     * @return string|null The default image label
     * @deprecated Since 23.0.0
     */
    protected function getDefaultImageLabel()
    {
        return ProductMediaObserver::DEFAULT_IMAGE_LABEL;
    }

    /**
     * Returns the default image position.
     *
     * @return int The default image position
     * @deprecated Since 23.0.0
     */
    protected function getDefaultImagePosition()
    {
        return ProductMediaObserver::DEFAULT_IMAGE_POSITION;
    }

    /**
     * Returns the mapped filename (which is the new filename).
     *
     * @param string $filename The filename to map
     *
     * @return string The mapped filename
     */
    protected function getImageMapping($filename)
    {
        return $this->getSubject()->getImageMapping($filename);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Returns the original filename for passed one (which is the new filename).
     *
     * @param string $newFilename The new filename to return the original one for
     *
     * @return string The original filename
     */
    protected function getInversedImageMapping($newFilename)
    {
        return $this->getSubject()->getInversedImageMapping($newFilename);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Returns the media roles of the subject.
     *
     * @return mixed
     */
    protected function getMediaRoles()
    {
        return $this->getSubject()->getMediaRoles();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Create's and return's a new empty artefact entity.
     *
     * @param array $columns             The array with the column data
     * @param array $originalColumnNames The array with a mapping from the old to the new column names
     *
     * @return array The new artefact entity
     */
    protected function newArtefact(array $columns, array $originalColumnNames)
    {
        return $this->getSubject()->newArtefact($columns, $originalColumnNames);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Add the passed product type artefacts to the product with the
     * last entity ID.
     *
     * @param array $artefacts The product type artefacts
     *
     * @return void
     * @uses \TechDivision\Import\Product\Media\Subjects\MediaSubject::getLastEntityId()
     */
    protected function addArtefacts(array $artefacts)
    {
        $this->getSubject()->addArtefacts(ProductMediaObserver::ARTEFACT_TYPE, $artefacts, false);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }
}


Push — 23.x ( b390a3...481f59 )

ProductMediaObserver A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

14 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

techdivision / import-product-media

Push — 23.x ( b390a3...481f59 )

ProductMediaObserver A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

14 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like