AttributeSetLoader::__construct() - Code Metrics - Inspection of "Add techdivision/import#162" - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 15.x ( 84e4c2...66410f )

by Tim

created 2019-10-23 16:47 UTC

AttributeSetLoader::__construct() A

↳ Parent: AttributeSetLoader

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	13
c	0
b	0
f	0
ccs	0
cts	9
cp	0
rs	9.8333
cc	3
nc	3
nop	1
crap	12

<?php

/**
 * TechDivision\Import\Loaders\AttributeSetLoader
 *
 * 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\ParamsConfigurationInterface;
use TechDivision\Import\Configuration\SubjectConfigurationInterface;

/**
 * Loader for attribute sets.
 *
 * @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 AttributeSetLoader implements LoaderInterface
{

    /**
     * The attribute sets.
     *
     * @var array
     */
    protected $attributeSets = 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) {
            foreach ($importProcessor->getEavAttributeSetsByEntityTypeId($entityType[MemberNames::ENTITY_TYPE_ID]) as $attributeSet) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                $this->attributeSets[$entityType[MemberNames::ENTITY_TYPE_CODE]][] = $attributeSet[MemberNames::ATTRIBUTE_SET_NAME];
            }
        }
    }

    /**
     * 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)
    {

        $entityTypeCode = $configuration->getExecutionContext()->getEntityTypeCode();
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}

        if (isset($this->attributeSets[$entityTypeCode])) {
            return $this->attributeSets[$entityTypeCode];
        }

        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\AttributeSetLoader
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\ParamsConfigurationInterface;
26			use TechDivision\Import\Configuration\SubjectConfigurationInterface;
27
28			/**
29			* Loader for attribute sets.
30			*
31			* @author Tim Wagner <[email protected]>
32			* @copyright 2019 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
35			* @link http://www.techdivision.com
36			*/
37			class AttributeSetLoader implements LoaderInterface
38			{
39
40			/**
41			* The attribute sets.
42			*
43			* @var array
44			*/
45			protected $attributeSets = array();
46
47			/**
48			* Construct that initializes the iterator with the import processor instance.
49			*
50			* @param \TechDivision\Import\Services\ImportProcessorInterface $importProcessor The import processor instance
51			*/
52			public function __construct(ImportProcessorInterface $importProcessor)
53			{
54
55			// load the entity types
56			$entityTypes = $importProcessor->getEavEntityTypes();
57
58			// prepare the array with the attribute sets
59			foreach ($entityTypes as $entityType) {
60			foreach ($importProcessor->getEavAttributeSetsByEntityTypeId($entityType[MemberNames::ENTITY_TYPE_ID]) as $attributeSet) {
			0 ignored issues – show Bug introduced 2019-10-23 16:49 UTC by Report Bug Copy Issue Report The expression `$importProcessor->getEav...Names::ENTITY_TYPE_ID])` of type `array\|boolean` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
61			$this->attributeSets[$entityType[MemberNames::ENTITY_TYPE_CODE]][] = $attributeSet[MemberNames::ATTRIBUTE_SET_NAME];
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			$entityTypeCode = $configuration->getExecutionContext()->getEntityTypeCode();
			0 ignored issues – show Bug introduced 2019-10-23 16:49 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...
77
78			if (isset($this->attributeSets[$entityTypeCode])) {
79			return $this->attributeSets[$entityTypeCode];
80			}
81
82			return array();
			0 ignored issues – show Bug Best Practice introduced 2019-10-23 16:49 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...
83			}
84
85			/**
86			* Return's the import processor instance.
87			*
88			* @return \TechDivision\Import\Services\ImportProcessorInterface The processor instance
89			*/
90			protected function getImportProcessor()
91			{
92			return $this->importProcessor;
			0 ignored issues – show Bug introduced 2019-10-23 16:49 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...
93			}
94			}
95

techdivision / import

Push — 15.x ( 84e4c2...66410f )

AttributeSetLoader::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like