SourceAndTargetDirLoader - 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

SourceAndTargetDirLoader A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	6
lcom	1
cbo	1
dl	0
loc	61
ccs	0
cts	22
cp	0
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	load()	25	4
A	getRegistryProcessor()	4	1

<?php

/**
 * TechDivision\Import\Loaders\SourceAndTargetDirLoader
 *
 * 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\RegistryKeys;
use TechDivision\Import\Services\RegistryProcessorInterface;

/**
 * Loader for the source and target directory.
 *
 * @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 SourceAndTargetDirLoader implements LoaderInterface
{

    /**
     * The registry processor instance.
     *
     * @var \TechDivision\Import\Services\RegistryProcessorInterface
     */
    protected $registryProcessor;

    /**
     * Construct that initializes the iterator with the registry processor instance.
     *
     * @param \TechDivision\Import\Services\RegistryProcessorInterface $registryProcessor The registry processor instance
     */
    public function __construct(RegistryProcessorInterface $registryProcessor)
    {
        $this->registryProcessor = $registryProcessor;
    }

    /**
     * Loads and returns data.
     *
     * @return \ArrayAccess The array with the data
     */
    public function load()
    {

        // initialize the array for the directories that has to be cleared
        $directories = array();

        // load the actual status
        $status = $this->getRegistryProcessor()->getAttribute(RegistryKeys::STATUS);

        // query whether or not the configured source directory is available
        if (is_dir($sourceDir = $status[RegistryKeys::SOURCE_DIRECTORY])) {
            $directories[] = $sourceDir;
        }

        // query whether or not the configured target directory is available
        if (is_dir($targetDir = $status[RegistryKeys::TARGET_DIRECTORY])) {
            // query whether or not the directory has already been added
            if (in_array($targetDir, $directories) === false) {
                $directories[] = $targetDir;
            }
        }

        // return the directories to be cleared
        return $directories;
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 registry processor instance.
     *
     * @return \TechDivision\Import\Services\RegistryProcessorInterface The processor instance
     */
    protected function getRegistryProcessor()
    {
        return $this->registryProcessor;
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Loaders\SourceAndTargetDirLoader
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\RegistryKeys;
24			use TechDivision\Import\Services\RegistryProcessorInterface;
25
26			/**
27			* Loader for the source and target directory.
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 SourceAndTargetDirLoader implements LoaderInterface
36			{
37
38			/**
39			* The registry processor instance.
40			*
41			* @var \TechDivision\Import\Services\RegistryProcessorInterface
42			*/
43			protected $registryProcessor;
44
45			/**
46			* Construct that initializes the iterator with the registry processor instance.
47			*
48			* @param \TechDivision\Import\Services\RegistryProcessorInterface $registryProcessor The registry processor instance
49			*/
50			public function __construct(RegistryProcessorInterface $registryProcessor)
51			{
52			$this->registryProcessor = $registryProcessor;
53			}
54
55			/**
56			* Loads and returns data.
57			*
58			* @return \ArrayAccess The array with the data
59			*/
60			public function load()
61			{
62
63			// initialize the array for the directories that has to be cleared
64			$directories = array();
65
66			// load the actual status
67			$status = $this->getRegistryProcessor()->getAttribute(RegistryKeys::STATUS);
68
69			// query whether or not the configured source directory is available
70			if (is_dir($sourceDir = $status[RegistryKeys::SOURCE_DIRECTORY])) {
71			$directories[] = $sourceDir;
72			}
73
74			// query whether or not the configured target directory is available
75			if (is_dir($targetDir = $status[RegistryKeys::TARGET_DIRECTORY])) {
76			// query whether or not the directory has already been added
77			if (in_array($targetDir, $directories) === false) {
78			$directories[] = $targetDir;
79			}
80			}
81
82			// return the directories to be cleared
83			return $directories;
			0 ignored issues – show Bug Best Practice introduced 2019-10-08 15:47 UTC by Report Bug Copy Issue Report The return type of `return $directories;` (`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			* Return's the registry processor instance.
88			*
89			* @return \TechDivision\Import\Services\RegistryProcessorInterface The processor instance
90			*/
91			protected function getRegistryProcessor()
92			{
93			return $this->registryProcessor;
94			}
95			}
96

techdivision / import

Push — master ( b5c840...3d5461 )

SourceAndTargetDirLoader A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Duplication Side-by-Side

Filter issues like