SelectCallback::getRowStoreId() - Code Metrics - Inspection of "Refactoring to make existing functionality more ge..." - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#40)

by Tim

created 2017-02-27 15:28 UTC

SelectCallback::getRowStoreId() A

↳ Parent: SelectCallback

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	1
crap	2

<?php

/**
 * TechDivision\Import\Callbacks\SelectCallback
 *
 * 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
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Callbacks;

use TechDivision\Import\Utils\MemberNames;
use TechDivision\Import\Utils\StoreViewCodes;

/**
 * A callback implementation that converts the passed select value.
 *
 * @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
 * @link      http://www.techdivision.com
 */
class SelectCallback extends AbstractCallback
{

    /**
     * Will be invoked by a observer it has been registered for.
     *
     * @param mixed $value The value to handle
     *
     * @return mixed The modified value
     * @see \TechDivision\Import\Product\Callbacks\ProductImportCallbackInterface::handle()
     */
    public function handle($value)
    {

        // load the store ID
        $storeId = $this->getRowStoreId(StoreViewCodes::ADMIN);

        // try to load the attribute option value
        $eavAttributeOptionValue = $this->getEavAttributeOptionValueByOptionValueAndStoreId($value, $storeId);

        // return the option ID
        return $eavAttributeOptionValue[MemberNames::OPTION_ID];
    }

    /**
     * Return's the store ID of the actual row, or of the default store
     * if no store view code is set in the CSV file.
     *
     * @param string|null $default The default store view code to use, if no store view code is set in the CSV file
     *
     * @return integer The ID of the actual store
     * @throws \Exception Is thrown, if the store with the actual code is not available
     */
    public function getRowStoreId($default = null)
    {
        return $this->getSubject()->getRowStoreId($default);
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 attribute option value with the passed value and store ID.
     *
     * @param mixed   $value   The option value
     * @param integer $storeId The ID of the store
     *
     * @return array|boolean The attribute option value instance
     */
    public function getEavAttributeOptionValueByOptionValueAndStoreId($value, $storeId)
    {
        return $this->getSubject()->getEavAttributeOptionValueByOptionValueAndStoreId($value, $storeId);
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\Callbacks\SelectCallback
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
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Callbacks;
22
23			use TechDivision\Import\Utils\MemberNames;
24			use TechDivision\Import\Utils\StoreViewCodes;
25
26			/**
27			* A callback implementation that converts the passed select value.
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
33			* @link http://www.techdivision.com
34			*/
35			class SelectCallback extends AbstractCallback
36			{
37
38			/**
39			* Will be invoked by a observer it has been registered for.
40			*
41			* @param mixed $value The value to handle
42			*
43			* @return mixed The modified value
44			* @see \TechDivision\Import\Product\Callbacks\ProductImportCallbackInterface::handle()
45			*/
46			public function handle($value)
47			{
48
49			// load the store ID
50			$storeId = $this->getRowStoreId(StoreViewCodes::ADMIN);
51
52			// try to load the attribute option value
53			$eavAttributeOptionValue = $this->getEavAttributeOptionValueByOptionValueAndStoreId($value, $storeId);
54
55			// return the option ID
56			return $eavAttributeOptionValue[MemberNames::OPTION_ID];
57			}
58
59			/**
60			* Return's the store ID of the actual row, or of the default store
61			* if no store view code is set in the CSV file.
62			*
63			* @param string\|null $default The default store view code to use, if no store view code is set in the CSV file
64			*
65			* @return integer The ID of the actual store
66			* @throws \Exception Is thrown, if the store with the actual code is not available
67			*/
68			public function getRowStoreId($default = null)
69			{
70			return $this->getSubject()->getRowStoreId($default);
			0 ignored issues – show Bug introduced 2017-02-27 15:33 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 `getRowStoreId()` does only exist in the following implementations of said interface: `TechDivision\Import\Subjects\AbstractEavSubject`. 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...
71			}
72
73			/**
74			* Return's the attribute option value with the passed value and store ID.
75			*
76			* @param mixed $value The option value
77			* @param integer $storeId The ID of the store
78			*
79			* @return array\|boolean The attribute option value instance
80			*/
81			public function getEavAttributeOptionValueByOptionValueAndStoreId($value, $storeId)
82			{
83			return $this->getSubject()->getEavAttributeOptionValueByOptionValueAndStoreId($value, $storeId);
			0 ignored issues – show Bug introduced 2017-02-27 15:33 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 `getEavAttributeOptionVal...OptionValueAndStoreId()` does only exist in the following implementations of said interface: `TechDivision\Import\Subjects\AbstractEavSubject`. 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...
84			}
85			}
86

techdivision / import

Pull Request — master (#40)

SelectCallback::getRowStoreId() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like