BundleSelectionPriceObserver::getProductBundleProcessor() - Code Metrics - Inspection of "Merge pull request #15 from wagnert/master" - techdivision/import-product-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a3ab00...b679e8 )

by Tim

created 2017-07-05 11:55 UTC

getProductBundleProcessor() A

↳ Parent: BundleSelectionPriceObserver

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	2

<?php

/**
 * TechDivision\Import\Product\Bundle\Observers\BundleSelectionPriceObserver
 *
 * 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-bundle
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Bundle\Observers;

use TechDivision\Import\Utils\StoreViewCodes;
use TechDivision\Import\Product\Bundle\Utils\ColumnKeys;
use TechDivision\Import\Product\Bundle\Utils\MemberNames;
use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
use TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface;

/**
 * Oberserver that provides functionality for the bundle selection price replace operation.
 *
 * @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-bundle
 * @link      http://www.techdivision.com
 */
class BundleSelectionPriceObserver extends AbstractProductImportObserver
{

    /**
     * The product bundle processor instance.
     *
     * @var \TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface
     */
    protected $productBundleProcessor;

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

    /**
     * Return's the product bundle processor instance.
     *
     * @return \TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface The product bundle processor instance
     */
    protected function getProductBundleProcessor()
    {
        return $this->productBundleProcessor;
    }

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

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


        // load the store view code
        $storeViewCode = $this->getStoreViewCode(StoreViewCodes::ADMIN);

        // check if we're in default store
        if (!$this->isDefaultStore($storeViewCode)) {
            // prepare and initialize the bundle selection price
            $productBundleSelectionPrice = $this->initializeBundleSelectionPrice($this->prepareAttributes());

            // persist the bundle selection price
            $this->persistProductBundleSelectionPrice($productBundleSelectionPrice);
        }
    }

    /**
     * Prepare the attributes of the entity that has to be persisted.
     *
     * @return array The prepared attributes
     */
    protected function prepareAttributes()
    {

        // load the store view code
        $storeViewCode = $this->getStoreViewCode(StoreViewCodes::ADMIN);

        // load the store/website ID
        $store = $this->getStoreByStoreCode($storeViewCode);
        $websiteId = $store[MemberNames::WEBSITE_ID];

        // load the default values
        $selectionPriceValue = $this->getValue(ColumnKeys::BUNDLE_VALUE_PRICE);

        try {
            // try to load the selection price type
            $selectionPriceType = $this->mapPriceType($this->getValue(ColumnKeys::BUNDLE_VALUE_PRICE_TYPE));
        } catch (\Exception $e) {
            throw $this->wrapException(array(ColumnKeys::BUNDLE_VALUE_PRICE_TYPE), $e);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        try {
            // try to load the selection ID for the child SKU
            $selectionId = $this->getChildSkuSelectionMapping($this->getValue(ColumnKeys::BUNDLE_VALUE_SKU));
        } catch (\Exception $e) {
            throw $this->wrapException(array(ColumnKeys::BUNDLE_VALUE_SKU), $e);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        // return the prepared bundle selection price
        return $this->initializeEntity(
            array(
                MemberNames::SELECTION_ID          => $selectionId,
                MemberNames::WEBSITE_ID            => $websiteId,
                MemberNames::SELECTION_PRICE_TYPE  => $selectionPriceType,
                MemberNames::SELECTION_PRICE_VALUE => $selectionPriceValue
            )
        );
    }

    /**
     * Initialize the bundle selection price with the passed attributes and returns an instance.
     *
     * @param array $attr The bundle selection price attributes
     *
     * @return array The initialized bundle selection price
     */
    protected function initializeBundleSelectionPrice(array $attr)
    {
        return $attr;
    }

    /**
     * Return's the mapping for the passed price type.
     *
     * @param string $priceType The price type to map
     *
     * @return integer The mapped price type
     * @throws \Exception Is thrown, if the passed price type can't be mapped
     */
    protected function mapPriceType($priceType)
    {
        return $this->getSubject()->mapPriceType($priceType);
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 selection ID for the passed child SKU.
     *
     * @param string $childSku The child SKU to return the selection ID for
     *
     * @return integer The last created selection ID
     */
    protected function getChildSkuSelectionMapping($childSku)
    {
        return $this->getSubject()->getChildSkuSelectionMapping($childSku);
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.
    }
}
    }

    /**
     * Query whether or not the passed store view code is the default one.
     *
     * @param string $storeViewCode The store view code to be queried
     *
     * @return boolean TRUE if the passed store view code is the default one, else FALSE
     */
    protected function isDefaultStore($storeViewCode)
    {
        return StoreViewCodes::ADMIN === strtolower($storeViewCode);
    }

    /**
     * Return's the store for the passed store code.
     *
     * @param string $storeCode The store code to return the store for
     *
     * @return array The requested store
     * @throws \Exception Is thrown, if the requested store is not available
     */
    protected function getStoreByStoreCode($storeCode)
    {
        return $this->getSubject()->getStoreByStoreCode($storeCode);
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.
    }
}
    }

    /**
     * Persist's the passed product bundle selection price data and return's the ID.
     *
     * @param array $productBundleSelectionPrice The product bundle selection price data to persist
     *
     * @return void
     */
    protected function persistProductBundleSelectionPrice($productBundleSelectionPrice)
    {
        $this->getProductBundleProcessor()->persistProductBundleSelectionPrice($productBundleSelectionPrice);

    }
}


Push — master ( a3ab00...b679e8 )

getProductBundleProcessor() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			/**
4			* TechDivision\Import\Product\Bundle\Observers\BundleSelectionPriceObserver
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-bundle
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Product\Bundle\Observers;
22
23			use TechDivision\Import\Utils\StoreViewCodes;
24			use TechDivision\Import\Product\Bundle\Utils\ColumnKeys;
25			use TechDivision\Import\Product\Bundle\Utils\MemberNames;
26			use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
27			use TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface;
28
29			/**
30			* Oberserver that provides functionality for the bundle selection price replace operation.
31			*
32			* @author Tim Wagner <[email protected]>
33			* @copyright 2016 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-bundle
36			* @link http://www.techdivision.com
37			*/
38			class BundleSelectionPriceObserver extends AbstractProductImportObserver
39			{
40
41			/**
42			* The product bundle processor instance.
43			*
44			* @var \TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface
45			*/
46			protected $productBundleProcessor;
47
48			/**
49			* Initialize the observer with the passed product bundle processor instance.
50			*
51			* @param \TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface $productBundleProcessor The product bundle processor instance
52			*/
53			public function __construct(ProductBundleProcessorInterface $productBundleProcessor)
54			{
55			$this->productBundleProcessor = $productBundleProcessor;
56			}
57
58			/**
59			* Return's the product bundle processor instance.
60			*
61			* @return \TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface The product bundle processor instance
62			*/
63			protected function getProductBundleProcessor()
64			{
65			return $this->productBundleProcessor;
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			// prepare the store view code
77			$this->prepareStoreViewCode($this->getRow());
			0 ignored issues – show Unused Code introduced 2017-01-09 18:01 UTC by Report Bug Copy Issue Report The call to `BundleSelectionPriceObse...:prepareStoreViewCode()` has too many arguments starting with `$this->getRow()`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
78
79			// load the store view code
80			$storeViewCode = $this->getStoreViewCode(StoreViewCodes::ADMIN);
81
82			// check if we're in default store
83			if (!$this->isDefaultStore($storeViewCode)) {
84			// prepare and initialize the bundle selection price
85			$productBundleSelectionPrice = $this->initializeBundleSelectionPrice($this->prepareAttributes());
86
87			// persist the bundle selection price
88			$this->persistProductBundleSelectionPrice($productBundleSelectionPrice);
89			}
90			}
91
92			/**
93			* Prepare the attributes of the entity that has to be persisted.
94			*
95			* @return array The prepared attributes
96			*/
97			protected function prepareAttributes()
98			{
99
100			// load the store view code
101			$storeViewCode = $this->getStoreViewCode(StoreViewCodes::ADMIN);
102
103			// load the store/website ID
104			$store = $this->getStoreByStoreCode($storeViewCode);
105			$websiteId = $store[MemberNames::WEBSITE_ID];
106
107			// load the default values
108			$selectionPriceValue = $this->getValue(ColumnKeys::BUNDLE_VALUE_PRICE);
109
110			try {
111			// try to load the selection price type
112			$selectionPriceType = $this->mapPriceType($this->getValue(ColumnKeys::BUNDLE_VALUE_PRICE_TYPE));
113			} catch (\Exception $e) {
114			throw $this->wrapException(array(ColumnKeys::BUNDLE_VALUE_PRICE_TYPE), $e);
			0 ignored issues – show Documentation introduced 2017-03-22 22:02 UTC by Report Bug Copy Issue Report `array(\TechDivision\Impo...UNDLE_VALUE_PRICE_TYPE)` is of type `array<integer,?>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
115			}
116
117			try {
118			// try to load the selection ID for the child SKU
119			$selectionId = $this->getChildSkuSelectionMapping($this->getValue(ColumnKeys::BUNDLE_VALUE_SKU));
120			} catch (\Exception $e) {
121			throw $this->wrapException(array(ColumnKeys::BUNDLE_VALUE_SKU), $e);
			0 ignored issues – show Documentation introduced 2017-03-22 22:02 UTC by Report Bug Copy Issue Report `array(\TechDivision\Impo...Keys::BUNDLE_VALUE_SKU)` is of type `array<integer,?>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
122			}
123
124			// return the prepared bundle selection price
125			return $this->initializeEntity(
126			array(
127			MemberNames::SELECTION_ID => $selectionId,
128			MemberNames::WEBSITE_ID => $websiteId,
129			MemberNames::SELECTION_PRICE_TYPE => $selectionPriceType,
130			MemberNames::SELECTION_PRICE_VALUE => $selectionPriceValue
131			)
132			);
133			}
134
135			/**
136			* Initialize the bundle selection price with the passed attributes and returns an instance.
137			*
138			* @param array $attr The bundle selection price attributes
139			*
140			* @return array The initialized bundle selection price
141			*/
142			protected function initializeBundleSelectionPrice(array $attr)
143			{
144			return $attr;
145			}
146
147			/**
148			* Return's the mapping for the passed price type.
149			*
150			* @param string $priceType The price type to map
151			*
152			* @return integer The mapped price type
153			* @throws \Exception Is thrown, if the passed price type can't be mapped
154			*/
155			protected function mapPriceType($priceType)
156			{
157			return $this->getSubject()->mapPriceType($priceType);
			0 ignored issues – show Bug introduced 2017-05-19 19:56 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 `mapPriceType()` does only exist in the following implementations of said interface: `TechDivision\Import\Prod...\Subjects\BundleSubject`. 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...
158			}
159
160			/**
161			* Return's the selection ID for the passed child SKU.
162			*
163			* @param string $childSku The child SKU to return the selection ID for
164			*
165			* @return integer The last created selection ID
166			*/
167			protected function getChildSkuSelectionMapping($childSku)
168			{
169			return $this->getSubject()->getChildSkuSelectionMapping($childSku);
			0 ignored issues – show Bug introduced 2017-05-19 19:56 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 `getChildSkuSelectionMapping()` does only exist in the following implementations of said interface: `TechDivision\Import\Prod...\Subjects\BundleSubject`. 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...
170			}
171
172			/**
173			* Query whether or not the passed store view code is the default one.
174			*
175			* @param string $storeViewCode The store view code to be queried
176			*
177			* @return boolean TRUE if the passed store view code is the default one, else FALSE
178			*/
179			protected function isDefaultStore($storeViewCode)
180			{
181			return StoreViewCodes::ADMIN === strtolower($storeViewCode);
182			}
183
184			/**
185			* Return's the store for the passed store code.
186			*
187			* @param string $storeCode The store code to return the store for
188			*
189			* @return array The requested store
190			* @throws \Exception Is thrown, if the requested store is not available
191			*/
192			protected function getStoreByStoreCode($storeCode)
193			{
194			return $this->getSubject()->getStoreByStoreCode($storeCode);
			0 ignored issues – show Bug introduced 2017-05-19 19:56 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 `getStoreByStoreCode()` does only exist in the following implementations of said interface: `TechDivision\Import\Prod...\Subjects\BundleSubject`. 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...
195			}
196
197			/**
198			* Persist's the passed product bundle selection price data and return's the ID.
199			*
200			* @param array $productBundleSelectionPrice The product bundle selection price data to persist
201			*
202			* @return void
203			*/
204			protected function persistProductBundleSelectionPrice($productBundleSelectionPrice)
205			{
206			$this->getProductBundleProcessor()->persistProductBundleSelectionPrice($productBundleSelectionPrice);
			0 ignored issues – show Bug introduced 2016-12-09 13:24 UTC by Report Bug Copy Issue Report The method `persistProductBundleSelectionPrice()` does not exist on `TechDivision\Import\Prod...undleProcessorInterface`. Did you maybe mean `persistProductBundleSelection()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
207			}
208			}
209

techdivision / import-product-bundle

Push — master ( a3ab00...b679e8 )

getProductBundleProcessor() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like