RmaCallback::getRmaKeys() - Code Metrics - Inspection of "Fixed techdivision/import-product-ee#57" - techdivision/import-product-ee - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 17.x ( 672baa...236655 )

by Tim

created 2020-02-13 19:17 UTC

RmaCallback::getRmaKeys() A

↳ Parent: RmaCallback

Complexity

Conditions	1
Paths	1

Size

Total Lines

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
nc	1
nop	0
crap	2

<?php

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

namespace TechDivision\Import\Product\Ee\Callbacks;

use TechDivision\Import\Product\Ee\Utils\ColumnKeys;
use TechDivision\Import\Product\Ee\Utils\RmaKeysInterface;
use TechDivision\Import\Product\Callbacks\AbstractProductImportCallback;
use TechDivision\Import\Observers\AttributeCodeAndValueAwareObserverInterface;

/**
 * A callback implementation that converts the passed RMA key.
 *
 * @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-ee
 * @link      http://www.techdivision.com
 */
class RmaCallback extends AbstractProductImportCallback
{

    /**
     * The utility instance with the RMA keys.
     *
     * @var \TechDivision\Import\Product\Ee\Utils\RmaKeysInterface
     */
    protected $rmaKeys;

    /**
     * Initializes the callback with the RMA keys instance.
     *
     * @param \TechDivision\Import\Product\Ee\Utils\RmaKeysInterface $rmaKeys The instance
     */
    public function __construct(RmaKeysInterface $rmaKeys)
    {
        $this->rmaKeys = $rmaKeys;
    }

    /**
     * Will be invoked by a observer it has been registered for.
     *
     * @param \TechDivision\Import\Observers\AttributeCodeAndValueAwareObserverInterface|null $observer The observer
     *
     * @return int The converted value
     */
    public function handle(AttributeCodeAndValueAwareObserverInterface $observer = null) : int
    {

        // set the observer
        $this->setObserver($observer);
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}

        // replace the passed attribute value into the visibility ID
        return $this->getRmaKeys()->get($this->getValue(ColumnKeys::IS_RETURNABLE));
    }

    /**
     * Return's the instance with the RMA keys.
     *
     * @return \TechDivision\Import\Product\Ee\Utils\RmaKeysInterface The instance
     */
    protected function getRmaKeys() : RmaKeysInterface
    {
        return $this->rmaKeys;
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Product\Ee\Callbacks\RmaCallback
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-ee
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Product\Ee\Callbacks;
22
23			use TechDivision\Import\Product\Ee\Utils\ColumnKeys;
24			use TechDivision\Import\Product\Ee\Utils\RmaKeysInterface;
25			use TechDivision\Import\Product\Callbacks\AbstractProductImportCallback;
26			use TechDivision\Import\Observers\AttributeCodeAndValueAwareObserverInterface;
27
28			/**
29			* A callback implementation that converts the passed RMA key.
30			*
31			* @author Tim Wagner <[email protected]>
32			* @copyright 2020 TechDivision GmbH <[email protected]>
33			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
34			* @link https://github.com/techdivision/import-product-ee
35			* @link http://www.techdivision.com
36			*/
37			class RmaCallback extends AbstractProductImportCallback
38			{
39
40			/**
41			* The utility instance with the RMA keys.
42			*
43			* @var \TechDivision\Import\Product\Ee\Utils\RmaKeysInterface
44			*/
45			protected $rmaKeys;
46
47			/**
48			* Initializes the callback with the RMA keys instance.
49			*
50			* @param \TechDivision\Import\Product\Ee\Utils\RmaKeysInterface $rmaKeys The instance
51			*/
52			public function __construct(RmaKeysInterface $rmaKeys)
53			{
54			$this->rmaKeys = $rmaKeys;
55			}
56
57			/**
58			* Will be invoked by a observer it has been registered for.
59			*
60			* @param \TechDivision\Import\Observers\AttributeCodeAndValueAwareObserverInterface\|null $observer The observer
61			*
62			* @return int The converted value
63			*/
64			public function handle(AttributeCodeAndValueAwareObserverInterface $observer = null) : int
65			{
66
67			// set the observer
68			$this->setObserver($observer);
			0 ignored issues – show Bug introduced 2020-02-13 16:19 UTC by Report Bug Copy Issue Report It seems like `$observer` defined by parameter `$observer` on line `64` can be `null`; however, `TechDivision\Import\Call...Callback::setObserver()` does not accept `null`, maybe add an additional type check? It seems like you allow that null is being passed for a parameter, however the function which is called does not seem to accept null. We recommend to add an additional type check (or disallow null for the parameter): function notNullable(stdClass $x) { } // Unsafe function withoutCheck(stdClass $x = null) { notNullable($x); } // Safe - Alternative 1: Adding Additional Type-Check function withCheck(stdClass $x = null) { if ($x instanceof stdClass) { notNullable($x); } } // Safe - Alternative 2: Changing Parameter function withNonNullableParam(stdClass $x) { notNullable($x); } Loading history...
69
70			// replace the passed attribute value into the visibility ID
71			return $this->getRmaKeys()->get($this->getValue(ColumnKeys::IS_RETURNABLE));
72			}
73
74			/**
75			* Return's the instance with the RMA keys.
76			*
77			* @return \TechDivision\Import\Product\Ee\Utils\RmaKeysInterface The instance
78			*/
79			protected function getRmaKeys() : RmaKeysInterface
80			{
81			return $this->rmaKeys;
82			}
83			}
84

techdivision / import-product-ee

Push — 17.x ( 672baa...236655 )

RmaCallback::getRmaKeys() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like