CleanUpMediaGalleryObserver::process() - Code Metrics - Inspection of "Update minimum-stability" - techdivision/import-product-media - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 31bba2...d233b4 )

by Marcus

created 2020-08-05 14:43 UTC

CleanUpMediaGalleryObserver::process() C

↳ Parent: CleanUpMediaGalleryObserver

Complexity

Conditions	13
Paths	43

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	83
rs	5.6642
c	0
b	0
f	0
cc	13
nc	43
nop	0

How to fix Long Method Complexity

<?php

/**
 * TechDivision\Import\Product\Media\Observers\CleanUpMediaGalleryObserver
 *
 * 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 2020 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\Media\Utils\MemberNames;
use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
use TechDivision\Import\Product\Media\Services\ProductMediaProcessorInterface;
use TechDivision\Import\Product\Media\Utils\ConfigurationKeys;

/**
 * Observer that cleaned up a product's media gallery information.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2020 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 CleanUpMediaGalleryObserver extends AbstractProductImportObserver
{

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

        // query whether or not the media gallery has to be cleaned up
        if ($this->getSubject()->getConfiguration()->hasParam(ConfigurationKeys::CLEAN_UP_MEDIA_GALLERY) &&
            $this->getSubject()->getConfiguration()->getParam(ConfigurationKeys::CLEAN_UP_MEDIA_GALLERY)
        ) {
            // initialize the array for the actual images
            $actualImageNames = array();

            // iterate over the available image fields
            foreach (array_keys($this->getImageTypes()) as $imageColumnName) {
                if ($this->hasValue($imageColumnName) && !in_array($imageName = $this->getValue($imageColumnName), $actualImageNames)) {
                    $actualImageNames[] = $imageName;
                }
            }

            // query whether or not, we've additional images
            if ($additionalImages = $this->getValue(ColumnKeys::ADDITIONAL_IMAGES, null, array($this, 'explode'))) {
                foreach ($additionalImages as $additionalImageName) {
                    // do nothing if the image has already been added, e. g. it is the base image
                    if (in_array($additionalImageName, $actualImageNames)) {
                        continue;
                    }

                    // else, add the image to the array
                    $actualImageNames[] = $additionalImageName;
                }
            }

            // load the existing media gallery entities for the produdct with the given SKU
            $existingProductMediaGalleries = $this->getProductMediaProcessor()
                                                  ->getProductMediaGalleriesBySku($sku = $this->getValue(ColumnKeys::SKU));

            // remove the images that are NOT longer available in the CSV file
            foreach ($existingProductMediaGalleries as $existingProductMediaGallery) {
                // do nothing if the file still exists
                if (in_array($existingImageName = $existingProductMediaGallery[MemberNames::VALUE], $actualImageNames)) {
                    continue;
                }

                try {
                    // remove the old image from the database
                    $this->getProductMediaProcessor()
                         ->deleteProductMediaGallery(array(MemberNames::VALUE_ID => $existingProductMediaGallery[MemberNames::VALUE_ID]));

                    // log a debug message that the image has been removed
                    $this->getSubject()
                         ->getSystemLogger()
                         ->warning(
                             $this->getSubject()->appendExceptionSuffix(
                                 sprintf(
                                     'Successfully removed image "%s" from media gallery for product with SKU "%s"',
                                     $existingImageName,
                                     $sku
                                 )
                             )
                         );
                } catch (\Exception $e) {
                    // log a warning if debug mode has been enabled and the file is NOT available
                    if ($this->getSubject()->isDebugMode()) {
                        $this->getSubject()
                             ->getSystemLogger()
                             ->warning($this->getSubject()->appendExceptionSuffix($e->getMessage()));
                    } else {
                        throw $e;
                    }
                }
            }

            // log a message that the images has been cleaned-up
            $this->getSubject()
                 ->getSystemLogger()
                 ->debug(
                     $this->getSubject()->appendExceptionSuffix(
                         sprintf(
                             'Successfully cleaned-up media gallery for product with SKU "%s"',
                             $sku
                         )
                     )
                 );
        }
    }

    /**
     * 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
     */
    protected function getProductMediaGalleriesBySku($sku)
    {
        return $this->getProductMediaProcessor()->getProductMediaGalleriesBySku($sku);
    }

    /**
     * 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.
    }
}
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Product\Media\Observers\CleanUpMediaGalleryObserver
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 2020 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link https://github.com/techdivision/import-product-media
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Product\Media\Observers;
22
23			use TechDivision\Import\Product\Media\Utils\ColumnKeys;
24			use TechDivision\Import\Product\Media\Utils\MemberNames;
25			use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
26			use TechDivision\Import\Product\Media\Services\ProductMediaProcessorInterface;
27			use TechDivision\Import\Product\Media\Utils\ConfigurationKeys;
28
29			/**
30			* Observer that cleaned up a product's media gallery information.
31			*
32			* @author Tim Wagner <[email protected]>
33			* @copyright 2020 TechDivision GmbH <[email protected]>
34			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
35			* @link https://github.com/techdivision/import-product-media
36			* @link http://www.techdivision.com
37			*/
38			class CleanUpMediaGalleryObserver extends AbstractProductImportObserver
39			{
40
41			/**
42			* The product media processor instance.
43			*
44			* @var \TechDivision\Import\Product\Media\Services\ProductMediaProcessorInterface
45			*/
46			protected $productMediaProcessor;
47
48			/**
49			* Initialize the observer with the passed product media processor instance.
50			*
51			* @param \TechDivision\Import\Product\Media\Services\ProductMediaProcessorInterface $productMediaProcessor The product media processor instance
52			*/
53			public function __construct(ProductMediaProcessorInterface $productMediaProcessor)
54			{
55			$this->productMediaProcessor = $productMediaProcessor;
56			}
57
58			/**
59			* Return's the product media processor instance.
60			*
61			* @return \TechDivision\Import\Product\Media\Services\ProductMediaProcessorInterface The product media processor instance
62			*/
63			protected function getProductMediaProcessor()
64			{
65			return $this->productMediaProcessor;
66			}
67
68			/**
69			* Process the observer's business logic.
70			*
71			* @return array The processed row
72			*/
73			protected function process()
74			{
75
76			// query whether or not the media gallery has to be cleaned up
77			if ($this->getSubject()->getConfiguration()->hasParam(ConfigurationKeys::CLEAN_UP_MEDIA_GALLERY) &&
78			$this->getSubject()->getConfiguration()->getParam(ConfigurationKeys::CLEAN_UP_MEDIA_GALLERY)
79			) {
80			// initialize the array for the actual images
81			$actualImageNames = array();
82
83			// iterate over the available image fields
84			foreach (array_keys($this->getImageTypes()) as $imageColumnName) {
85			if ($this->hasValue($imageColumnName) && !in_array($imageName = $this->getValue($imageColumnName), $actualImageNames)) {
86			$actualImageNames[] = $imageName;
87			}
88			}
89
90			// query whether or not, we've additional images
91			if ($additionalImages = $this->getValue(ColumnKeys::ADDITIONAL_IMAGES, null, array($this, 'explode'))) {
92			foreach ($additionalImages as $additionalImageName) {
93			// do nothing if the image has already been added, e. g. it is the base image
94			if (in_array($additionalImageName, $actualImageNames)) {
95			continue;
96			}
97
98			// else, add the image to the array
99			$actualImageNames[] = $additionalImageName;
100			}
101			}
102
103			// load the existing media gallery entities for the produdct with the given SKU
104			$existingProductMediaGalleries = $this->getProductMediaProcessor()
105			->getProductMediaGalleriesBySku($sku = $this->getValue(ColumnKeys::SKU));
106
107			// remove the images that are NOT longer available in the CSV file
108			foreach ($existingProductMediaGalleries as $existingProductMediaGallery) {
109			// do nothing if the file still exists
110			if (in_array($existingImageName = $existingProductMediaGallery[MemberNames::VALUE], $actualImageNames)) {
111			continue;
112			}
113
114			try {
115			// remove the old image from the database
116			$this->getProductMediaProcessor()
117			->deleteProductMediaGallery(array(MemberNames::VALUE_ID => $existingProductMediaGallery[MemberNames::VALUE_ID]));
118
119			// log a debug message that the image has been removed
120			$this->getSubject()
121			->getSystemLogger()
122			->warning(
123			$this->getSubject()->appendExceptionSuffix(
124			sprintf(
125			'Successfully removed image "%s" from media gallery for product with SKU "%s"',
126			$existingImageName,
127			$sku
128			)
129			)
130			);
131			} catch (\Exception $e) {
132			// log a warning if debug mode has been enabled and the file is NOT available
133			if ($this->getSubject()->isDebugMode()) {
134			$this->getSubject()
135			->getSystemLogger()
136			->warning($this->getSubject()->appendExceptionSuffix($e->getMessage()));
137			} else {
138			throw $e;
139			}
140			}
141			}
142
143			// log a message that the images has been cleaned-up
144			$this->getSubject()
145			->getSystemLogger()
146			->debug(
147			$this->getSubject()->appendExceptionSuffix(
148			sprintf(
149			'Successfully cleaned-up media gallery for product with SKU "%s"',
150			$sku
151			)
152			)
153			);
154			}
155			}
156
157			/**
158			* Load's the product media gallery entities with the passed SKU.
159			*
160			* @param string $sku The SKU to load the media gallery entities for
161			*
162			* @return array The product media gallery entities
163			*/
164			protected function getProductMediaGalleriesBySku($sku)
165			{
166			return $this->getProductMediaProcessor()->getProductMediaGalleriesBySku($sku);
167			}
168
169			/**
170			* Return's the array with the available image types and their label columns.
171			*
172			* @return array The array with the available image types
173			*/
174			protected function getImageTypes()
175			{
176			return $this->getSubject()->getImageTypes();
			0 ignored issues – show Bug introduced 2017-09-02 11:35 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TechDivision\Import\Subjects\SubjectInterface` as the method `getImageTypes()` does only exist in the following implementations of said interface: `TechDivision\Import\Prod...a\Subjects\MediaSubject`, `TechDivision\Import\Prod...\AbstractProductSubject`, `TechDivision\Import\Product\Subjects\BunchSubject`. Let’s take a look at an example: 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. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
177			}
178			}
179

techdivision / import-product-media

Push — master ( 31bba2...d233b4 )

CleanUpMediaGalleryObserver::process() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like