Enum::normalize() - 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

Enum::normalize() A

↳ Parent: Enum

Complexity

Conditions	2
Paths	3

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	6
c	0
b	0
f	0
nc	3
nop	0
dl	0
loc	9
rs	9.6666

<?php
declare(strict_types=1);

namespace Selami\Entity\DataType;

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

class Enum extends DataTypeAbstract implements DataTypeInterface
{
    const DATA_TYPE_ERROR   = 'Assertion failed for value "%s" for "%s" : INVALID_TYPE';

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


    /**
     * Enum constructor.
     * @param string $key
     * @param mixed $datum
     * @param array $options
     * @throws InvalidArgumentException;
     *
     */
    public function __construct(string $key, $datum, array $options = [])
    {
        $this->key = $key;
        $this->datum = $datum;
        $this->checkValidOptions($options);
        $this->options = array_merge(self::$defaults, $options);
        if ($this->options['values'] === null
            || !is_array($this->options['values'])
            || count($this->options['values']) < 3
        ) {
            throw new InvalidArgumentException('$options[values] must be an array has at least two elements');
        }
    }

    /**
     * {@inheritdoc}
     */
    public function assert()
    {

        if (!in_array($this->datum, $this->options['values'], true)) {
            $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_UNSAFE_RAW);
        } catch (InvalidArgumentException $e) {
            return filter_var($this->options['default'], FILTER_UNSAFE_RAW);
        }
    }
}


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			class Enum extends DataTypeAbstract implements DataTypeInterface
10			{
11			const DATA_TYPE_ERROR = 'Assertion failed for value "%s" for "%s" : INVALID_TYPE';
12
13			protected static $defaults = [
14			'default' => false,
15			'values' => null
16			];
17
18
19			/**
20			* Enum constructor.
21			* @param string $key
22			* @param mixed $datum
23			* @param array $options
24			* @throws InvalidArgumentException;
25			*
26			*/
27			public function __construct(string $key, $datum, array $options = [])
28			{
29			$this->key = $key;
30			$this->datum = $datum;
31			$this->checkValidOptions($options);
32			$this->options = array_merge(self::$defaults, $options);
33			if ($this->options['values'] === null
34			\|\| !is_array($this->options['values'])
35			\|\| count($this->options['values']) < 3
36			) {
37			throw new InvalidArgumentException('$options[values] must be an array has at least two elements');
38			}
39			}
40
41			/**
42			* {@inheritdoc}
43			*/
44			public function assert()
45			{
46
47			if (!in_array($this->datum, $this->options['values'], true)) {
48			$this->errorMessageTemplate = self::DATA_TYPE_ERROR;
49			$this->throwException();
50			}
51			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...
52			}
53			/**
54			* {@inheritdoc}
55			*/
56			public function normalize()
57			{
58			try {
59			$this->assert();
60			return filter_var($this->datum, FILTER_UNSAFE_RAW);
61			} catch (InvalidArgumentException $e) {
62			return filter_var($this->options['default'], FILTER_UNSAFE_RAW);
63			}
64			}
65			}
66

selamiphp / entity

Push — master ( a15555...8c20cf )

Enum::normalize() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like