ColumnNameLoader::__construct() - Code Metrics - Inspection of "Add compiler implementations for dynamic column ha..." - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 15.x ( 39dd4d...e89609 )

by Tim

created 2020-03-20 16:44 UTC

ColumnNameLoader::__construct() A

↳ Parent: ColumnNameLoader

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\ColumnNameLoader
 *
 * 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 2020 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;

/**
 * Loader for table column names.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2020 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 ColumnNameLoader implements LoaderInterface
{

    /**
     * The column metadata loader instance.
     *
     * @var \TechDivision\Import\Loaders\LoaderInterface
     */
    protected $columnMetadataLoader;

    /**
     * Construct a new instance.
     *
     * @param \TechDivision\Import\Loaders\LoaderInterface $columnMetadataLoader The column metadata loader instance
     */
    public function __construct(LoaderInterface $columnMetadataLoader)
    {
        $this->columnMetadataLoader = $columnMetadataLoader;
    }

    /**
     * Loads and returns data.
     *
     * @param string $tableName The table name to return the list for
     *
     * @return \ArrayAccess The array with the data
     */
    public function load($tableName = null)
    {
        return array_keys($this->columnMetadataLoader->load($tableName));
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\ColumnNameLoader
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 2020 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			* Loader for table column names.
25			*
26			* @author Tim Wagner <[email protected]>
27			* @copyright 2020 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 ColumnNameLoader implements LoaderInterface
33			{
34
35			/**
36			* The column metadata loader instance.
37			*
38			* @var \TechDivision\Import\Loaders\LoaderInterface
39			*/
40			protected $columnMetadataLoader;
41
42			/**
43			* Construct a new instance.
44			*
45			* @param \TechDivision\Import\Loaders\LoaderInterface $columnMetadataLoader The column metadata loader instance
46			*/
47			public function __construct(LoaderInterface $columnMetadataLoader)
48			{
49			$this->columnMetadataLoader = $columnMetadataLoader;
50			}
51
52			/**
53			* Loads and returns data.
54			*
55			* @param string $tableName The table name to return the list for
56			*
57			* @return \ArrayAccess The array with the data
58			*/
59			public function load($tableName = null)
60			{
61			return array_keys($this->columnMetadataLoader->load($tableName));
			0 ignored issues – show Unused Code introduced 2020-03-20 16:47 UTC by Report Bug Copy Issue Report The call to `LoaderInterface::load()` has too many arguments starting with `$tableName`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history... Bug Best Practice introduced 2020-03-20 16:47 UTC by Report Bug Copy Issue Report The return type of `return array_keys($this-...der->load($tableName));` (`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...
62			}
63			}
64

techdivision / import

Push — 15.x ( 39dd4d...e89609 )

ColumnNameLoader::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like