Url - Code Metrics - Inspection of "FilePath Class for DataType and its tests added" - selamiphp/entity - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a15555...8c20cf )

by Mehmet

created 2017-01-19 23:39 UTC

Url A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	46
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	46
loc	46
rs	10
wmc	5
lcom	1
cbo	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	7	7	1
A	assert()	8	8	2
A	normalize()	9	9	2

How to fix Duplicated Code

<?php
declare(strict_types=1);

namespace Selami\Entity\DataType;

use Selami\Entity\Interfaces\DataTypeInterface;
use InvalidArgumentException;

class Url extends DataTypeAbstract implements DataTypeInterface

{
    const DATA_TYPE_ERROR   = 'Assertion failed for value "%s" for "%s" : INVALID_TYPE';

    protected static $defaults = [
        'default' => null
    ];


    /**
     * Url constructor.
     * @param string $key
     * @param mixed $datum
     * @param array $options
     */
    public function __construct(string $key, $datum, array $options = [])
    {
        $this->key = $key;
        $this->datum = $datum;
        $this->checkValidOptions($options);
        $this->options = array_merge(self::$defaults, $options);
    }
    /**
     * {@inheritdoc}
     */
    public function assert()
    {
        if (!filter_var($this->datum, FILTER_VALIDATE_URL)) {
            $this->errorMessageTemplate = self::DATA_TYPE_ERROR;
            $this->throwException();
        }
        return true;
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());
}
    }
    /**
     * {@inheritdoc}
     */
    public function normalize()
    {
        try {
            $this->assert();
            return filter_var($this->datum, FILTER_SANITIZE_URL);
        } catch (InvalidArgumentException $e) {
            return $this->options['default'];
        }
    }
}


1		<?php
2		declare(strict_types=1);
3
4		namespace Selami\Entity\DataType;
5
6		use Selami\Entity\Interfaces\DataTypeInterface;
7		use InvalidArgumentException;
8
9	View Code Duplication	class Url extends DataTypeAbstract implements DataTypeInterface
		0 ignored issues – show Duplication introduced 2017-01-19 23:43 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
10		{
11		const DATA_TYPE_ERROR = 'Assertion failed for value "%s" for "%s" : INVALID_TYPE';
12
13		protected static $defaults = [
14		'default' => null
15		];
16
17
18		/**
19		* Url constructor.
20		* @param string $key
21		* @param mixed $datum
22		* @param array $options
23		*/
24		public function __construct(string $key, $datum, array $options = [])
25		{
26		$this->key = $key;
27		$this->datum = $datum;
28		$this->checkValidOptions($options);
29		$this->options = array_merge(self::$defaults, $options);
30		}
31		/**
32		* {@inheritdoc}
33		*/
34		public function assert()
35		{
36		if (!filter_var($this->datum, FILTER_VALIDATE_URL)) {
37		$this->errorMessageTemplate = self::DATA_TYPE_ERROR;
38		$this->throwException();
39		}
40		return true;
		0 ignored issues – show Bug Best Practice introduced 2017-01-19 23:43 UTC by Report Bug Copy Issue Report The return type of `return true;` (`boolean`) is incompatible with the return type declared by the interface `Selami\Entity\Interfaces\DataTypeInterface::assert` of type `Selami\Entity\Interfaces\true`. 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...
41		}
42		/**
43		* {@inheritdoc}
44		*/
45		public function normalize()
46		{
47		try {
48		$this->assert();
49		return filter_var($this->datum, FILTER_SANITIZE_URL);
50		} catch (InvalidArgumentException $e) {
51		return $this->options['default'];
52		}
53		}
54		}
55

selamiphp / entity

Push — master ( a15555...8c20cf )

Url A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like