EavAttributeOptionValueLoader - Code Metrics - Inspection of "Add functionality to render recommendations for pe..." - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 15.x ( 1a3897...0b1d63 )

by Tim

created 2019-10-28 10:07 UTC

EavAttributeOptionValueLoader A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	62
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	6
lcom	1
cbo	1
dl	62
loc	62
ccs	0
cts	21
cp	0
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	14	14	3
A	load()	14	14	2
A	getImportProcessor()	4	4	1

How to fix Duplicated Code

<?php

/**
 * TechDivision\Import\Loaders\EavAttributeOptionValueLoader
 *
 * 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 2019 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\Loaders;

use TechDivision\Import\Utils\MemberNames;
use TechDivision\Import\Services\ImportProcessorInterface;
use TechDivision\Import\Configuration\SubjectConfigurationInterface;

/**
 * Loader for available option values.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2019 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 EavAttributeOptionValueLoader implements LoaderInterface

{

    /**
     * The attribute option values.
     *
     * @var array
     */
    protected $eavAttributeOptionValues = array();

    /**
     * Construct that initializes the iterator with the import processor instance.
     *
     * @param \TechDivision\Import\Services\ImportProcessorInterface $importProcessor The import processor instance
     */
    public function __construct(ImportProcessorInterface $importProcessor)
    {

        // load the entity types
        $entityTypes = $importProcessor->getEavEntityTypes();

        // prepare the array with the attribute sets
        foreach ($entityTypes as $entityType) {
            // prepare the array with the attribute sets
            foreach ($importProcessor->getEavAttributeOptionValuesByEntityTypeIdAndStoreId($entityType[MemberNames::ENTITY_TYPE_ID], 0) as $eavAttributeOptionValue) {
                $this->eavAttributeOptionValues[$entityType[MemberNames::ENTITY_TYPE_CODE]][$eavAttributeOptionValue[MemberNames::ATTRIBUTE_CODE]][] = $eavAttributeOptionValue[MemberNames::VALUE];
            }
        }
    }

    /**
     * Loads and returns data the custom validation data.
     *
     * @param \TechDivision\Import\Configuration\ParamsConfigurationInterface $configuration The configuration instance to load the validations from
     *
     * @return \ArrayAccess The array with the data
     */
    public function load(SubjectConfigurationInterface $configuration = null)
    {

        // load the entity type code from the passed subject configuration
        $entityTypeCode = $configuration->getExecutionContext()->getEntityTypeCode();
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}

        // return the available attribute option values for the entity type
        if (isset($this->eavAttributeOptionValues[$entityTypeCode])) {
            return $this->eavAttributeOptionValues[$entityTypeCode];
        }

        // return an empty array otherwise
        return array();
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Return's the import processor instance.
     *
     * @return \TechDivision\Import\Services\ImportProcessorInterface The processor instance
     */
    protected function getImportProcessor()
    {
        return $this->importProcessor;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }
}


1		<?php
2
3		/**
4		* TechDivision\Import\Loaders\EavAttributeOptionValueLoader
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 2019 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\Loaders;
22
23		use TechDivision\Import\Utils\MemberNames;
24		use TechDivision\Import\Services\ImportProcessorInterface;
25		use TechDivision\Import\Configuration\SubjectConfigurationInterface;
26
27		/**
28		* Loader for available option values.
29		*
30		* @author Tim Wagner <[email protected]>
31		* @copyright 2019 TechDivision GmbH <[email protected]>
32		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
33		* @link https://github.com/techdivision/import
34		* @link http://www.techdivision.com
35		*/
36	View Code Duplication	class EavAttributeOptionValueLoader implements LoaderInterface
		0 ignored issues – show Duplication introduced 2019-10-28 10:10 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
37		{
38
39		/**
40		* The attribute option values.
41		*
42		* @var array
43		*/
44		protected $eavAttributeOptionValues = array();
45
46		/**
47		* Construct that initializes the iterator with the import processor instance.
48		*
49		* @param \TechDivision\Import\Services\ImportProcessorInterface $importProcessor The import processor instance
50		*/
51		public function __construct(ImportProcessorInterface $importProcessor)
52		{
53
54		// load the entity types
55		$entityTypes = $importProcessor->getEavEntityTypes();
56
57		// prepare the array with the attribute sets
58		foreach ($entityTypes as $entityType) {
59		// prepare the array with the attribute sets
60		foreach ($importProcessor->getEavAttributeOptionValuesByEntityTypeIdAndStoreId($entityType[MemberNames::ENTITY_TYPE_ID], 0) as $eavAttributeOptionValue) {
61		$this->eavAttributeOptionValues[$entityType[MemberNames::ENTITY_TYPE_CODE]][$eavAttributeOptionValue[MemberNames::ATTRIBUTE_CODE]][] = $eavAttributeOptionValue[MemberNames::VALUE];
62		}
63		}
64		}
65
66		/**
67		* Loads and returns data the custom validation data.
68		*
69		* @param \TechDivision\Import\Configuration\ParamsConfigurationInterface $configuration The configuration instance to load the validations from
70		*
71		* @return \ArrayAccess The array with the data
72		*/
73		public function load(SubjectConfigurationInterface $configuration = null)
74		{
75
76		// load the entity type code from the passed subject configuration
77		$entityTypeCode = $configuration->getExecutionContext()->getEntityTypeCode();
		0 ignored issues – show Bug introduced 2019-10-28 10:10 UTC by Report Bug Copy Issue Report It seems like `$configuration` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
78
79		// return the available attribute option values for the entity type
80		if (isset($this->eavAttributeOptionValues[$entityTypeCode])) {
81		return $this->eavAttributeOptionValues[$entityTypeCode];
82		}
83
84		// return an empty array otherwise
85		return array();
		0 ignored issues – show Bug Best Practice introduced 2019-10-28 10:10 UTC by Report Bug Copy Issue Report The return type of `return array();` (`array`) is incompatible with the return type declared by the interface `TechDivision\Import\Loaders\LoaderInterface::load` of type `ArrayAccess`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
86		}
87
88		/**
89		* Return's the import processor instance.
90		*
91		* @return \TechDivision\Import\Services\ImportProcessorInterface The processor instance
92		*/
93		protected function getImportProcessor()
94		{
95		return $this->importProcessor;
		0 ignored issues – show Bug introduced 2019-10-28 10:10 UTC by Report Bug Copy Issue Report The property `importProcessor` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
96		}
97		}
98

techdivision / import

Push — 15.x ( 1a3897...0b1d63 )

EavAttributeOptionValueLoader A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like