ValidationLoader::__construct() - 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

ValidationLoader::__construct() A

↳ Parent: ValidationLoader

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php

/**
 * TechDivision\Import\Loaders\ValidationLoader
 *
 * 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;

/**
 * Specific loader for the validation data.
 *
 * @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 ValidationLoader implements LoaderInterface
{

    /**
     * The loader instance used to load the validations from the registry.
     *
     * @var \TechDivision\Import\Loaders\LoaderInterface
     */
    protected $loader;

    /**
     * Construct that initializes the iterator with the loader instance.
     *
     * @param \TechDivision\Import\Loaders\LoaderInterface $loader The loader instance
     */
    public function __construct(LoaderInterface $loader)
    {
        $this->loader = $loader;
    }

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

        // initialize the array for the assembled validations
        $data = array();

        // load the validations from the wrapped loader
        if (is_array($validations = $this->getLoader()->load())) {
            foreach ($validations as $filename => $attributes) {
                foreach ($attributes as $line => $errors) {
                    foreach ($errors as $attributeCode => $message) {
                        $data[] = array(
                            'File'   => $filename,
                            'Line'   => $line,
                            'Column' => $attributeCode,
                            'Error'  => $message
                        );
                    }
                }
            }
        }

        // return the assembled validation data
        return $data;
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 loader instance
     *
     * @return \TechDivision\Import\Loaders\LoaderInterface The loader instance
     */
    protected function getLoader()
    {
        return $this->loader;
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Loaders\ValidationLoader
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			/**
24			* Specific loader for the validation data.
25			*
26			* @author Tim Wagner <[email protected]>
27			* @copyright 2019 TechDivision GmbH <[email protected]>
28			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
29			* @link https://github.com/techdivision/import
30			* @link http://www.techdivision.com
31			*/
32			class ValidationLoader implements LoaderInterface
33			{
34
35			/**
36			* The loader instance used to load the validations from the registry.
37			*
38			* @var \TechDivision\Import\Loaders\LoaderInterface
39			*/
40			protected $loader;
41
42			/**
43			* Construct that initializes the iterator with the loader instance.
44			*
45			* @param \TechDivision\Import\Loaders\LoaderInterface $loader The loader instance
46			*/
47			public function __construct(LoaderInterface $loader)
48			{
49			$this->loader = $loader;
50			}
51
52			/**
53			* Loads and returns data.
54			*
55			* @return \ArrayAccess The array with the data
56			*/
57			public function load()
58			{
59
60			// initialize the array for the assembled validations
61			$data = array();
62
63			// load the validations from the wrapped loader
64			if (is_array($validations = $this->getLoader()->load())) {
65			foreach ($validations as $filename => $attributes) {
66			foreach ($attributes as $line => $errors) {
67			foreach ($errors as $attributeCode => $message) {
68			$data[] = array(
69			'File' => $filename,
70			'Line' => $line,
71			'Column' => $attributeCode,
72			'Error' => $message
73			);
74			}
75			}
76			}
77			}
78
79			// return the assembled validation data
80			return $data;
			0 ignored issues – show Bug Best Practice introduced 2019-10-29 09:23 UTC by Report Bug Copy Issue Report The return type of `return $data;` (`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...
81			}
82
83			/**
84			* Return's the loader instance
85			*
86			* @return \TechDivision\Import\Loaders\LoaderInterface The loader instance
87			*/
88			protected function getLoader()
89			{
90			return $this->loader;
91			}
92			}
93

techdivision / import

Push — master ( b5c840...3d5461 )

ValidationLoader::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like