StoreViewCodeLoader - Code Metrics - Inspection of "Prepare for milestone 1.4" - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b5c840...3d5461 )

by Marcus

created 2020-08-05 09:06 UTC

StoreViewCodeLoader A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

Importance

Changes

Metric	Value
dl	0
loc	47
c	0
b	0
f	0
wmc	4
lcom	0
cbo	1
ccs	0
cts	15
cp	0
rs	10

3 Methods

Rating	Name	Size	Complexity
A	__construct()	11	2
A	load()	4	1
A	getImportProcessor()	4	1

<?php

/**
 * TechDivision\Import\Loaders\StoreViewCodeLoader
 *
 * 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 store view codes.
 *
 * @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 StoreViewCodeLoader implements LoaderInterface
{

    /**
     * The store view codes.
     *
     * @var array
     */
    protected $stores = 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 stores
        $stores = $importProcessor->getStores();

        // initialize the array with the store websites
        foreach ($stores as $store) {
            $this->stores[] = $store[MemberNames::CODE];
        }
    }

    /**
     * Loads and returns data.
     *
     * @return \ArrayAccess The array with the data
     */
    public function load()
    {
        return $this->stores;
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\StoreViewCodeLoader
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 store view codes.
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 StoreViewCodeLoader implements LoaderInterface
36			{
37
38			/**
39			* The store view codes.
40			*
41			* @var array
42			*/
43			protected $stores = 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 stores
54			$stores = $importProcessor->getStores();
55
56			// initialize the array with the store websites
57			foreach ($stores as $store) {
58			$this->stores[] = $store[MemberNames::CODE];
59			}
60			}
61
62			/**
63			* Loads and returns data.
64			*
65			* @return \ArrayAccess The array with the data
66			*/
67			public function load()
68			{
69			return $this->stores;
			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 $this->stores;` (`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...
70			}
71
72			/**
73			* Return's the import processor instance.
74			*
75			* @return \TechDivision\Import\Services\ImportProcessorInterface The processor instance
76			*/
77			protected function getImportProcessor()
78			{
79			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...
80			}
81			}
82

techdivision / import

Push — master ( b5c840...3d5461 )

StoreViewCodeLoader A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Duplication Side-by-Side

Filter issues like