ProductMediaObserver::processImages() - Code Metrics - Inspection of "Merge pull request #22 from wagnert/master" - techdivision/import-product-media - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a13e73...af5cb4 )

by Tim

created 2017-08-07 17:50 UTC

ProductMediaObserver::processImages() B

↳ Parent: ProductMediaObserver

Complexity

Conditions	4
Paths	4

Size

Total Lines	47
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
dl	0
loc	47
ccs	0
cts	33
cp	0
rs	8.6845
c	0
b	0
f	0
cc	4
eloc	25
nc	4
nop	0
crap	20

<?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 default image label.
     *
     * @var string
     */
    const DEFAULT_IMAGE_LABEL = 'Image';

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

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

        // initialize the array for the artefacts
        $this->artefacts = array();

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

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

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

        // iterate over the available image fields
        foreach ($this->getImageTypes() as $imageColumnName => $labelColumnName) {
            // query whether or not, we've a base image
            if ($image = $this->getValue($imageColumnName)) {
                // initialize the label text
                $labelText = $this->getDefaultImageLabel();

                // query whether or not a custom label text has been passed
                if ($this->hasValue($labelColumnName)) {
                    $this->getValue($labelColumnName);
                }

                // 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         => $image,
                        ColumnKeys::IMAGE_PATH_NEW     => $image,
                        ColumnKeys::IMAGE_LABEL        => $labelText
                    ),
                    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::IMAGE_LABEL        => $labelColumnName
                    )
                );

                // append the base image to the artefacts
                $this->artefacts[] = $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->getValue(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'));

            // initialize the images with the found values
            foreach ($additionalImages as $key => $additionalImage) {
                // 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         => $additionalImage,
                        ColumnKeys::IMAGE_PATH_NEW     => $additionalImage,
                        ColumnKeys::IMAGE_LABEL        => isset($additionalImageLabels[$key]) ?
                                                          $additionalImageLabels[$key] :
                                                          $this->getDefaultImageLabel()
                    ),
                    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::IMAGE_LABEL        => ColumnKeys::ADDITIONAL_IMAGE_LABELS
                    )
                );

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

    /**
     * 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 The default image label
     */
    protected function getDefaultImageLabel()
    {
        return ProductMediaObserver::DEFAULT_IMAGE_LABEL;
    }

    /**
     * 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);
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 — master ( a13e73...af5cb4 )

ProductMediaObserver::processImages() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			/**
4			* TechDivision\Import\Product\Media\Observers\ProductMediaObserver
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 2016 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\Observers\AbstractProductImportObserver;
25
26			/**
27			* Observer that extracts theproduct's media data from a CSV file to be added to media specifi CSV file.
28			*
29			* @author Tim Wagner <[email protected]>
30			* @copyright 2016 TechDivision GmbH <[email protected]>
31			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
32			* @link https://github.com/techdivision/import-product-media
33			* @link http://www.techdivision.com
34			*/
35			class ProductMediaObserver extends AbstractProductImportObserver
36			{
37
38			/**
39			* The artefact type.
40			*
41			* @var string
42			*/
43			const ARTEFACT_TYPE = 'media';
44
45			/**
46			* The default image label.
47			*
48			* @var string
49			*/
50			const DEFAULT_IMAGE_LABEL = 'Image';
51
52			/**
53			* The image artefacts that has to be exported.
54			*
55			* @var array
56			*/
57			protected $artefacts = array();
58
59			/**
60			* Process the observer's business logic.
61			*
62			* @return array The processed row
63			*/
64			protected function process()
65			{
66
67			// initialize the array for the artefacts
68			$this->artefacts = array();
69
70			// process the images/additional images
71			$this->processImages();
72			$this->processAdditionalImages();
73
74			// append the artefacts that has to be exported to the subject
75			$this->addArtefacts($this->artefacts);
76			}
77
78			/**
79			* Parses the column and exports the image data to a separate file.
80			*
81			* @return void
82			*/
83			protected function processImages()
84			{
85
86			// load the store view code
87			$storeViewCode = $this->getValue(ColumnKeys::STORE_VIEW_CODE);
88			$attributeSetCode = $this->getValue(ColumnKeys::ATTRIBUTE_SET_CODE);
89
90			// load the parent SKU from the row
91			$parentSku = $this->getValue(ColumnKeys::SKU);
92
93			// iterate over the available image fields
94			foreach ($this->getImageTypes() as $imageColumnName => $labelColumnName) {
95			// query whether or not, we've a base image
96			if ($image = $this->getValue($imageColumnName)) {
97			// initialize the label text
98			$labelText = $this->getDefaultImageLabel();
99
100			// query whether or not a custom label text has been passed
101			if ($this->hasValue($labelColumnName)) {
102			$this->getValue($labelColumnName);
103			}
104
105			// prepare the new base image
106			$artefact = $this->newArtefact(
107			array(
108			ColumnKeys::STORE_VIEW_CODE => $storeViewCode,
109			ColumnKeys::ATTRIBUTE_SET_CODE => $attributeSetCode,
110			ColumnKeys::IMAGE_PARENT_SKU => $parentSku,
111			ColumnKeys::IMAGE_PATH => $image,
112			ColumnKeys::IMAGE_PATH_NEW => $image,
113			ColumnKeys::IMAGE_LABEL => $labelText
114			),
115			array(
116			ColumnKeys::STORE_VIEW_CODE => ColumnKeys::STORE_VIEW_CODE,
117			ColumnKeys::ATTRIBUTE_SET_CODE => ColumnKeys::ATTRIBUTE_SET_CODE,
118			ColumnKeys::IMAGE_PARENT_SKU => ColumnKeys::SKU,
119			ColumnKeys::IMAGE_PATH => $imageColumnName,
120			ColumnKeys::IMAGE_PATH_NEW => $imageColumnName,
121			ColumnKeys::IMAGE_LABEL => $labelColumnName
122			)
123			);
124
125			// append the base image to the artefacts
126			$this->artefacts[] = $artefact;
127			}
128			}
129			}
130
131			/**
132			* Parses the column and exports the additional image data to a separate file.
133			*
134			* @return void
135			*/
136			protected function processAdditionalImages()
137			{
138
139			// load the store view code
140			$storeViewCode = $this->getValue(ColumnKeys::STORE_VIEW_CODE);
141			$attributeSetCode = $this->getValue(ColumnKeys::ATTRIBUTE_SET_CODE);
142
143			// load the parent SKU from the row
144			$parentSku = $this->getValue(ColumnKeys::SKU);
145
146			// query whether or not, we've additional images
147			if ($additionalImages = $this->getValue(ColumnKeys::ADDITIONAL_IMAGES, null, array($this, 'explode'))) {
148			// expand the additional image labels, if available
149			$additionalImageLabels = $this->getValue(ColumnKeys::ADDITIONAL_IMAGE_LABELS, array(), array($this, 'explode'));
150
151			// initialize the images with the found values
152			foreach ($additionalImages as $key => $additionalImage) {
153			// prepare the additional image
154			$artefact = $this->newArtefact(
155			array(
156			ColumnKeys::STORE_VIEW_CODE => $storeViewCode,
157			ColumnKeys::ATTRIBUTE_SET_CODE => $attributeSetCode,
158			ColumnKeys::IMAGE_PARENT_SKU => $parentSku,
159			ColumnKeys::IMAGE_PATH => $additionalImage,
160			ColumnKeys::IMAGE_PATH_NEW => $additionalImage,
161			ColumnKeys::IMAGE_LABEL => isset($additionalImageLabels[$key]) ?
162			$additionalImageLabels[$key] :
163			$this->getDefaultImageLabel()
164			),
165			array(
166			ColumnKeys::STORE_VIEW_CODE => ColumnKeys::STORE_VIEW_CODE,
167			ColumnKeys::ATTRIBUTE_SET_CODE => ColumnKeys::ATTRIBUTE_SET_CODE,
168			ColumnKeys::IMAGE_PARENT_SKU => ColumnKeys::SKU,
169			ColumnKeys::IMAGE_PATH => ColumnKeys::ADDITIONAL_IMAGES,
170			ColumnKeys::IMAGE_PATH_NEW => ColumnKeys::ADDITIONAL_IMAGES,
171			ColumnKeys::IMAGE_LABEL => ColumnKeys::ADDITIONAL_IMAGE_LABELS
172			)
173			);
174
175			// append the additional image to the artefacts
176			$this->artefacts[] = $artefact;
177			}
178			}
179			}
180
181			/**
182			* Return's the array with the available image types and their label columns.
183			*
184			* @return array The array with the available image types
185			*/
186			protected function getImageTypes()
187			{
188			return $this->getSubject()->getImageTypes();
			0 ignored issues – show Bug introduced 2017-08-07 17:48 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...
189			}
190
191			/**
192			* Return's the default image label.
193			*
194			* @return string The default image label
195			*/
196			protected function getDefaultImageLabel()
197			{
198			return ProductMediaObserver::DEFAULT_IMAGE_LABEL;
199			}
200
201			/**
202			* Create's and return's a new empty artefact entity.
203			*
204			* @param array $columns The array with the column data
205			* @param array $originalColumnNames The array with a mapping from the old to the new column names
206			*
207			* @return array The new artefact entity
208			*/
209			protected function newArtefact(array $columns, array $originalColumnNames)
210			{
211			return $this->getSubject()->newArtefact($columns, $originalColumnNames);
			0 ignored issues – show Bug introduced 2017-08-01 17:19 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 `newArtefact()` does only exist in the following implementations of said interface: `TechDivision\Import\Plugins\ExportableSubjectImpl`, `TechDivision\Import\Product\Subjects\BunchSubject`, `TechDivision\Import\Subjects\ExportableTraitImpl`. 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...
212			}
213
214			/**
215			* Add the passed product type artefacts to the product with the
216			* last entity ID.
217			*
218			* @param array $artefacts The product type artefacts
219			*
220			* @return void
221			* @uses \TechDivision\Import\Product\Media\Subjects\MediaSubject::getLastEntityId()
222			*/
223			protected function addArtefacts(array $artefacts)
224			{
225			$this->getSubject()->addArtefacts(ProductMediaObserver::ARTEFACT_TYPE, $artefacts);
			0 ignored issues – show Bug introduced 2017-08-01 17:19 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 `addArtefacts()` does only exist in the following implementations of said interface: `TechDivision\Import\Plugins\ExportableSubjectImpl`, `TechDivision\Import\Product\Subjects\BunchSubject`, `TechDivision\Import\Subjects\ExportableTraitImpl`. 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...
226			}
227			}
228

techdivision / import-product-media

Push — master ( a13e73...af5cb4 )

ProductMediaObserver::processImages() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like