EavAttributeOptionValueLoader::reset() - 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

EavAttributeOptionValueLoader::reset() A

↳ Parent: EavAttributeOptionValueLoader

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	14
ccs	0
cts	9
cp	0
rs	9.7998
c	0
b	0
f	0
cc	3
nc	3
nop	0
crap	12

<?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 ResetAwareLoaderInterface
{

    /**
     * The import processor instance.
     *
     * @var \TechDivision\Import\Services\ImportProcessorInterface
     */
    protected $importProcessor;

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

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

        // set the import processor instance
        $this->importProcessor = $importProcessor;

        // reset the loader instance
        $this->reset();
    }

    /**
     * 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());
}
    }

    /**
     * Reset's the loader instance.
     *
     * @return void
     */
    public function reset()
    {

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

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

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


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			class EavAttributeOptionValueLoader implements ResetAwareLoaderInterface
37			{
38
39			/**
40			* The import processor instance.
41			*
42			* @var \TechDivision\Import\Services\ImportProcessorInterface
43			*/
44			protected $importProcessor;
45
46			/**
47			* The attribute option values.
48			*
49			* @var array
50			*/
51			protected $eavAttributeOptionValues;
52
53			/**
54			* Construct that initializes the iterator with the import processor instance.
55			*
56			* @param \TechDivision\Import\Services\ImportProcessorInterface $importProcessor The import processor instance
57			*/
58			public function __construct(ImportProcessorInterface $importProcessor)
59			{
60
61			// set the import processor instance
62			$this->importProcessor = $importProcessor;
63
64			// reset the loader instance
65			$this->reset();
66			}
67
68			/**
69			* Loads and returns data the custom validation data.
70			*
71			* @param \TechDivision\Import\Configuration\ParamsConfigurationInterface $configuration The configuration instance to load the validations from
72			*
73			* @return \ArrayAccess The array with the data
74			*/
75			public function load(SubjectConfigurationInterface $configuration = null)
76			{
77
78			// load the entity type code from the passed subject configuration
79			$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...
80
81			// return the available attribute option values for the entity type
82			if (isset($this->eavAttributeOptionValues[$entityTypeCode])) {
83			return $this->eavAttributeOptionValues[$entityTypeCode];
84			}
85
86			// return an empty array otherwise
87			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...
88			}
89
90			/**
91			* Reset's the loader instance.
92			*
93			* @return void
94			*/
95			public function reset()
96			{
97
98			// load the entity types
99			$entityTypes = $this->getImportProcessor()->getEavEntityTypes();
100
101			// prepare the array with the attribute sets
102			foreach ($entityTypes as $entityType) {
103			// prepare the array with the attribute sets
104			foreach ($this->getImportProcessor()->getEavAttributeOptionValuesByEntityTypeIdAndStoreId($entityType[MemberNames::ENTITY_TYPE_ID], 0) as $eavAttributeOptionValue) {
105			$this->eavAttributeOptionValues[$entityType[MemberNames::ENTITY_TYPE_CODE]][$eavAttributeOptionValue[MemberNames::ATTRIBUTE_CODE]][] = $eavAttributeOptionValue[MemberNames::VALUE];
106			}
107			}
108			}
109
110			/**
111			* Return's the import processor instance.
112			*
113			* @return \TechDivision\Import\Services\ImportProcessorInterface The processor instance
114			*/
115			protected function getImportProcessor()
116			{
117			return $this->importProcessor;
118			}
119			}
120

techdivision / import

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

EavAttributeOptionValueLoader::reset() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like