Magic360ColumnsObserver::process() - Code Metrics - Inspection of "Refactor to optimize DI integration" - techdivision/import-product-magic360 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#7)

by Tim

created 2017-07-05 14:56 UTC

Magic360ColumnsObserver::process() A

↳ Parent: Magic360ColumnsObserver

Complexity

Conditions	2
Paths	2

Size

Total Lines	22
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
c	0
b	0
f	0
rs	9.2
cc	2
eloc	12
nc	2
nop	0

<?php

/**
 * TechDivision\Import\Product\Magic360\Observers\Magic360ImageObserver
 *
 * 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]>
 * @author    Bernhard Wick <[email protected]>
 * @copyright 2017 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-magic360
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Magic360\Observers;

use TechDivision\Import\Product\Magic360\Utils\ColumnKeys;
use TechDivision\Import\Product\Magic360\Utils\MemberNames;
use TechDivision\Import\Product\Magic360\Services\ProductMagic360ProcessorInterface;
use TechDivision\Import\Product\Observers\AbstractProductImportObserver;

/**
 * Adds the count of the images from within artefacts to the Magic360 tables
 *
 * @author    Tim Wagner <[email protected]>
 * @author    Bernhard Wick <[email protected]>
 * @copyright 2017 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-magic360
 * @link      http://www.techdivision.com
 */
class Magic360ColumnsObserver extends AbstractProductImportObserver
{

    /**
     * The product magic360 processor instance.
     *
     * @var \TechDivision\Import\Product\Services\ProductBunchProcessorInterface
     */
    protected $productMagic360Processor;

    /**
     * Initialize the observer with the passed product magic360 processor instance.
     *
     * @param \TechDivision\Import\Product\Magic360\Services\ProductMagic360ProcessorInterface $productMagic360Processor The product magic360 processor instance
     */
    public function __construct(ProductMagic360ProcessorInterface $productMagic360Processor)
    {
        $this->productMagic360Processor = $productMagic360Processor;

    }

    /**
     * Return's the product magic360 processor instance.
     *
     * @return \TechDivision\Import\Product\Magic360\Services\ProductMagic360ProcessorInterface The product magic360 processor instance
     */
    protected function getProductMagic360Processor()
    {
        return $this->productMagic360Processor;
    }

    /**
     * Process the observer's business logic.
     *
     * @return array The processed row
     *
     * @throws \Exception Possible error in non-debug mode
     */
    protected function process()
    {
        // extract the parent/child ID as well as the link type code from the row
        $sku = $this->getValue(ColumnKeys::SKU);

        // load parent/child IDs and link type ID
        $productId = $this->getSubject()->mapSkuToEntityId($sku);
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.
    }
}

        $images360Path = $this->getValue(ColumnKeys::IMAGES_PATH);
        $mediaFilePath = $this->getSubject()->getMediaDir();
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.
    }
}
        // iterate the images (if any) and initialize an entity for each one
        $images = $this->getSubject()->getFilesystem()->listContents($mediaFilePath . DIRECTORY_SEPARATOR . $images360Path);
        if (count($images) > 0) {
            $entity = $this->initializeMagic360Columns($this->initializeEntity(
                array(
                    MemberNames::PRODUCT_ID => $productId,
                    MemberNames::COLUMNS => count($images)
                )
            ));
            $this->persistMagic360Columns($entity);
        }
    }

    /**
     * Initialize the magic360 column 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 initializeMagic360Columns(array $attr)
    {
        return $attr;
    }

    /**
     * Persists the column data and returns the ID.
     *
     * @param array $productMediaGallery The product media gallery data to persist
     *
     * @return string The ID of the persisted entity
     */
    protected function persistMagic360Columns($productMediaGallery)
    {
        return $this->getProductMagic360Processor()->persistMagic360Columns($productMediaGallery);

    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Product\Magic360\Observers\Magic360ImageObserver
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			* @author Bernhard Wick <[email protected]>
16			* @copyright 2017 TechDivision GmbH <[email protected]>
17			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
18			* @link https://github.com/techdivision/import-product-magic360
19			* @link http://www.techdivision.com
20			*/
21
22			namespace TechDivision\Import\Product\Magic360\Observers;
23
24			use TechDivision\Import\Product\Magic360\Utils\ColumnKeys;
25			use TechDivision\Import\Product\Magic360\Utils\MemberNames;
26			use TechDivision\Import\Product\Magic360\Services\ProductMagic360ProcessorInterface;
27			use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
28
29			/**
30			* Adds the count of the images from within artefacts to the Magic360 tables
31			*
32			* @author Tim Wagner <[email protected]>
33			* @author Bernhard Wick <[email protected]>
34			* @copyright 2017 TechDivision GmbH <[email protected]>
35			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
36			* @link https://github.com/techdivision/import-product-magic360
37			* @link http://www.techdivision.com
38			*/
39			class Magic360ColumnsObserver extends AbstractProductImportObserver
40			{
41
42			/**
43			* The product magic360 processor instance.
44			*
45			* @var \TechDivision\Import\Product\Services\ProductBunchProcessorInterface
46			*/
47			protected $productMagic360Processor;
48
49			/**
50			* Initialize the observer with the passed product magic360 processor instance.
51			*
52			* @param \TechDivision\Import\Product\Magic360\Services\ProductMagic360ProcessorInterface $productMagic360Processor The product magic360 processor instance
53			*/
54			public function __construct(ProductMagic360ProcessorInterface $productMagic360Processor)
55			{
56			$this->productMagic360Processor = $productMagic360Processor;
			0 ignored issues – show Documentation Bug introduced 2017-07-05 14:59 UTC by Report Bug Copy Issue Report It seems like `$productMagic360Processor` of type `object<TechDivision\Impo...c360ProcessorInterface>` is incompatible with the declared type `object<TechDivision\Impo...unchProcessorInterface>` of property `$productMagic360Processor`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
57			}
58
59			/**
60			* Return's the product magic360 processor instance.
61			*
62			* @return \TechDivision\Import\Product\Magic360\Services\ProductMagic360ProcessorInterface The product magic360 processor instance
63			*/
64			protected function getProductMagic360Processor()
65			{
66			return $this->productMagic360Processor;
67			}
68
69			/**
70			* Process the observer's business logic.
71			*
72			* @return array The processed row
73			*
74			* @throws \Exception Possible error in non-debug mode
75			*/
76			protected function process()
77			{
78			// extract the parent/child ID as well as the link type code from the row
79			$sku = $this->getValue(ColumnKeys::SKU);
80
81			// load parent/child IDs and link type ID
82			$productId = $this->getSubject()->mapSkuToEntityId($sku);
			0 ignored issues – show Bug introduced 2017-06-14 14:05 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 `mapSkuToEntityId()` does only exist in the following implementations of said interface: `TechDivision\Import\Prod...ubjects\Magic360Subject`. 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...
83
84			$images360Path = $this->getValue(ColumnKeys::IMAGES_PATH);
85			$mediaFilePath = $this->getSubject()->getMediaDir();
			0 ignored issues – show Bug introduced 2017-06-14 14:05 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 `getMediaDir()` does only exist in the following implementations of said interface: `TechDivision\Import\Prod...ubjects\Magic360Subject`. 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...
86			// iterate the images (if any) and initialize an entity for each one
87			$images = $this->getSubject()->getFilesystem()->listContents($mediaFilePath . DIRECTORY_SEPARATOR . $images360Path);
88			if (count($images) > 0) {
89			$entity = $this->initializeMagic360Columns($this->initializeEntity(
90			array(
91			MemberNames::PRODUCT_ID => $productId,
92			MemberNames::COLUMNS => count($images)
93			)
94			));
95			$this->persistMagic360Columns($entity);
96			}
97			}
98
99			/**
100			* Initialize the magic360 column with the passed attributes and returns an instance.
101			*
102			* @param array $attr The product media gallery attributes
103			*
104			* @return array The initialized product media gallery
105			*/
106			protected function initializeMagic360Columns(array $attr)
107			{
108			return $attr;
109			}
110
111			/**
112			* Persists the column data and returns the ID.
113			*
114			* @param array $productMediaGallery The product media gallery data to persist
115			*
116			* @return string The ID of the persisted entity
117			*/
118			protected function persistMagic360Columns($productMediaGallery)
119			{
120			return $this->getProductMagic360Processor()->persistMagic360Columns($productMediaGallery);
			0 ignored issues – show Bug introduced 2017-07-05 14:59 UTC by Report Bug Copy Issue Report The method `persistMagic360Columns()` does not seem to exist on `object<TechDivision\Impo...unchProcessorInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
121			}
122			}
123

techdivision / import-product-magic360

Pull Request — master (#7)

Magic360ColumnsObserver::process() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like