CustomValidationsLoader - Code Metrics - Inspection of "Add techdivision/import#162" - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 15.x ( 84e4c2...66410f )

by Tim

created 2019-10-23 16:47 UTC

CustomValidationsLoader A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	35
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

Importance

Changes

Metric	Value
dl	0
loc	35
c	0
b	0
f	0
wmc	5
lcom	0
cbo	3
ccs	0
cts	17
cp	0
rs	10

1 Method

Rating	Name	Duplication	Size	Complexity
A	load()	0	24	5

<?php

/**
 * TechDivision\Import\Loaders\CustomValidationsLoader
 *
 * 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\ConfigurationKeys;
use TechDivision\Import\Configuration\ParamsConfigurationInterface;
use TechDivision\Import\Configuration\PluginConfigurationInterface;
use TechDivision\Import\Configuration\SubjectConfigurationInterface;

/**
 * Loader for import artefacts.
 *
 * @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 CustomValidationsLoader implements LoaderInterface
{

    /**
     * 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(ParamsConfigurationInterface $configuration = null)
    {

        // return an empty array if the param has NOT been set
        $customValidations = array();

        if ($configuration === null) {
            return $customValidations;
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());
}
        }

        if ($configuration instanceof PluginConfigurationInterface) {
            $customValidations = array_merge($customValidations, $this->load($configuration->getConfiguration()));
        }

        if ($configuration instanceof SubjectConfigurationInterface) {
            $customValidations = array_merge($customValidations, $this->load($configuration->getPluginConfiguration()));
        }

        if ($configuration->hasParam($name = ConfigurationKeys::CUSTOM_VALIDATIONS)) {
            $customValidations = array_merge($configuration->getParam($name));
        }

        return $customValidations;
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\CustomValidationsLoader
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\ConfigurationKeys;
24			use TechDivision\Import\Configuration\ParamsConfigurationInterface;
25			use TechDivision\Import\Configuration\PluginConfigurationInterface;
26			use TechDivision\Import\Configuration\SubjectConfigurationInterface;
27
28			/**
29			* Loader for import artefacts.
30			*
31			* @author Tim Wagner <[email protected]>
32			* @copyright 2019 TechDivision GmbH <[email protected]>
33			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
34			* @link https://github.com/techdivision/import
35			* @link http://www.techdivision.com
36			*/
37			class CustomValidationsLoader implements LoaderInterface
38			{
39
40			/**
41			* Loads and returns data the custom validation data.
42			*
43			* @param \TechDivision\Import\Configuration\ParamsConfigurationInterface $configuration The configuration instance to load the validations from
44			*
45			* @return \ArrayAccess The array with the data
46			*/
47			public function load(ParamsConfigurationInterface $configuration = null)
48			{
49
50			// return an empty array if the param has NOT been set
51			$customValidations = array();
52
53			if ($configuration === null) {
54			return $customValidations;
			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 $customValidations;` (`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...
55			}
56
57			if ($configuration instanceof PluginConfigurationInterface) {
58			$customValidations = array_merge($customValidations, $this->load($configuration->getConfiguration()));
59			}
60
61			if ($configuration instanceof SubjectConfigurationInterface) {
62			$customValidations = array_merge($customValidations, $this->load($configuration->getPluginConfiguration()));
63			}
64
65			if ($configuration->hasParam($name = ConfigurationKeys::CUSTOM_VALIDATIONS)) {
66			$customValidations = array_merge($configuration->getParam($name));
67			}
68
69			return $customValidations;
			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 $customValidations;` (`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

techdivision / import

Push — 15.x ( 84e4c2...66410f )

CustomValidationsLoader A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

1 Method

Duplication Side-by-Side

Filter issues like