AttributeGroupNameLoader::load() - Code Metrics - Inspection of "Fixded invalid class name from GenericIdentifierAc..." - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 15.x ( b45baa...4ca9b4 )

by Tim

created 2019-12-18 12:46 UTC

AttributeGroupNameLoader::load() A

↳ Parent: AttributeGroupNameLoader

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\Loaders\AttributeGroupNameLoader
 *
 * 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;

/**
 * Loader for attribute group names.
 *
 * @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 AttributeGroupNameLoader implements LoaderInterface
{

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

foreach ($collection as $item) { /** ... */ }
                // load the attribute groups for the attribute set
                $attributeGroups = $importProcessor->getEavAttributeGroupsByAttributeSetId($attributeSet[MemberNames::ATTRIBUTE_SET_ID]);
                // assemble the array with the attribute group names
                foreach ($attributeGroups as $attributeGroup) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

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

    /**
     * Loads and returns the array with the attribute group names.
     *
     * @return \ArrayAccess The array with the data
     */
    public function load()
    {
        return $this->attributeGroupNames;
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());
}
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Loaders\AttributeGroupNameLoader
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
26			/**
27			* Loader for attribute group names.
28			*
29			* @author Tim Wagner <[email protected]>
30			* @copyright 2019 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 AttributeGroupNameLoader implements LoaderInterface
36			{
37
38			/**
39			* The attribute group names.
40			*
41			* @var array
42			*/
43			protected $attributeGroupNames = array();
44
45			/**
46			* Construct that initializes the iterator with the import processor instance.
47			*
48			* @param \TechDivision\Import\Services\ImportProcessorInterface $importProcessor The import processor instance
49			*/
50			public function __construct(ImportProcessorInterface $importProcessor)
51			{
52
53			// load the entity types
54			$entityTypes = $importProcessor->getEavEntityTypes();
55
56			// prepare the array with the attribute sets
57			foreach ($entityTypes as $entityType) {
58			// load the attribute sets for the entity type
59			$attributeSets = $importProcessor->getEavAttributeSetsByEntityTypeId($entityType[MemberNames::ENTITY_TYPE_ID]);
60			// load the attribute sets
61			foreach ($attributeSets as $attributeSet) {
			0 ignored issues – show Bug introduced 2019-12-18 12:48 UTC by Report Bug Copy Issue Report The expression `$attributeSets` 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...
62			// load the attribute groups for the attribute set
63			$attributeGroups = $importProcessor->getEavAttributeGroupsByAttributeSetId($attributeSet[MemberNames::ATTRIBUTE_SET_ID]);
64			// assemble the array with the attribute group names
65			foreach ($attributeGroups as $attributeGroup) {
			0 ignored issues – show Bug introduced 2019-12-18 12:48 UTC by Report Bug Copy Issue Report The expression `$attributeGroups` 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...
66			$this->attributeGroupNames[$entityType[MemberNames::ENTITY_TYPE_CODE]][$attributeSet[MemberNames::ATTRIBUTE_SET_NAME]][] = $attributeGroup[MemberNames::ATTRIBUTE_GROUP_NAME];
67			}
68			}
69			}
70			}
71
72			/**
73			* Loads and returns the array with the attribute group names.
74			*
75			* @return \ArrayAccess The array with the data
76			*/
77			public function load()
78			{
79			return $this->attributeGroupNames;
			0 ignored issues – show Bug Best Practice introduced 2019-12-18 12:48 UTC by Report Bug Copy Issue Report The return type of `return $this->attributeGroupNames;` (`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...
80			}
81			}
82

techdivision / import

Push — 15.x ( b45baa...4ca9b4 )

AttributeGroupNameLoader::load() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like