AttributeValueLoader - Code Metrics - Inspection of "Add collect-data operation and make attribute opti..." - techdivision/import-attribute - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — pac-209--validate-frontend-typ... ( 8c9ee2...2f829a )

by Tim

created 2021-02-11 09:16 UTC

AttributeValueLoader A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
wmc	4
lcom	1
cbo	1
dl	0
loc	61
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	__construct()	7	1
A	load()	14	2
A	getRegistryLoader()	4	1

<?php

/**
 * TechDivision\Import\Attribute\Loaders\AttributeValueLoader
 *
 * 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-attribute
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Attribute\Loaders;

use TechDivision\Import\Loaders\LoaderInterface;
use TechDivision\Import\Attribute\Utils\MemberNames;

/**
 * Generic loader for product 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-attribute
 * @link      http://www.techdivision.com
 */
class AttributeValueLoader implements LoaderInterface
{

    /**
     * The column name to load the values for.
     *
     * @var string
     */
    protected $columnName;

    /**
     * The registry loader instance.
     *
     * @var \TechDivision\Import\Loaders\LoaderInterface
     */
    protected $registryLoader;

    /**
     * Construct that initializes the iterator with the product processor instance.
     *
     * @param \TechDivision\Import\Loaders\LoaderInterface $registryLoader The registry loader instance
     * @param string                                       $columnName     The column name to load the values for
     */
    public function __construct(LoaderInterface $registryLoader, $columnName = MemberNames::FRONTEND_INPUT)
    {

        // initialize the column name and the registry loader
        $this->columnName = $columnName;
        $this->registryLoader = $registryLoader;
    }

    /**
     * Loads and returns data.
     *
     * @return \ArrayAccess The array with the data
     */
    public function load()
    {
        // load the already processed SKUs from the registry, merge
        // them with the ones from the DB and return them
        $collectedColumns = $this->getRegistryLoader()->load();

        // query whether or not values for the configured column name are available
        if (is_array($collectedColumns[$this->columnName])) {
            return $collectedColumns[$this->columnName];
        }

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

    /**
     * The registry loader instance.
     *
     * @return \TechDivision\Import\Loaders\LoaderInterface The loader instance
     */
    protected function getRegistryLoader()
    {
        return $this->registryLoader;
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Attribute\Loaders\AttributeValueLoader
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-attribute
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Attribute\Loaders;
22
23			use TechDivision\Import\Loaders\LoaderInterface;
24			use TechDivision\Import\Attribute\Utils\MemberNames;
25
26			/**
27			* Generic loader for product values.
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-attribute
33			* @link http://www.techdivision.com
34			*/
35			class AttributeValueLoader implements LoaderInterface
36			{
37
38			/**
39			* The column name to load the values for.
40			*
41			* @var string
42			*/
43			protected $columnName;
44
45			/**
46			* The registry loader instance.
47			*
48			* @var \TechDivision\Import\Loaders\LoaderInterface
49			*/
50			protected $registryLoader;
51
52			/**
53			* Construct that initializes the iterator with the product processor instance.
54			*
55			* @param \TechDivision\Import\Loaders\LoaderInterface $registryLoader The registry loader instance
56			* @param string $columnName The column name to load the values for
57			*/
58			public function __construct(LoaderInterface $registryLoader, $columnName = MemberNames::FRONTEND_INPUT)
59			{
60
61			// initialize the column name and the registry loader
62			$this->columnName = $columnName;
63			$this->registryLoader = $registryLoader;
64			}
65
66			/**
67			* Loads and returns data.
68			*
69			* @return \ArrayAccess The array with the data
70			*/
71			public function load()
72			{
73			// load the already processed SKUs from the registry, merge
74			// them with the ones from the DB and return them
75			$collectedColumns = $this->getRegistryLoader()->load();
76
77			// query whether or not values for the configured column name are available
78			if (is_array($collectedColumns[$this->columnName])) {
79			return $collectedColumns[$this->columnName];
80			}
81
82			// return an empty array otherwise
83			return array();
			0 ignored issues – show Bug Best Practice introduced 2021-02-11 09:24 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...
84			}
85
86			/**
87			* The registry loader instance.
88			*
89			* @return \TechDivision\Import\Loaders\LoaderInterface The loader instance
90			*/
91			protected function getRegistryLoader()
92			{
93			return $this->registryLoader;
94			}
95			}
96

techdivision / import-attribute

Push — pac-209--validate-frontend-typ... ( 8c9ee2...2f829a )

AttributeValueLoader A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Duplication Side-by-Side

Filter issues like