Set - Code Metrics - Inspection of "add missing calls to trigger_error in deprecated c..." - Innmind/Immutable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( cad621...d8b57f )

by Baptiste

created 2017-02-04 17:20 UTC

Set A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	290
Duplicated Lines	7.59 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

99%

Importance

Changes

Metric	Value
wmc	29
lcom	1
cbo	8
dl	22
loc	290
ccs	99
cts	100
cp	0.99
rs	10
c	0
b	0
f	0

26 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	type()	0	4	1
A	size()	0	4	1
A	count()	0	4	1
A	toPrimitive()	0	4	1
A	current()	0	4	1
A	key()	0	4	1
A	next()	0	4	1
A	rewind()	0	4	1
A	valid()	0	4	1
A	intersect()	11	11	1
A	add()	0	13	2
A	contains()	0	4	1
A	remove()	0	14	2
A	diff()	11	11	1
A	equals()	0	8	1
A	filter()	0	7	1
A	foreach()	0	6	1
A	groupBy()	0	4	1
A	map()	0	12	1
A	partition()	0	12	1
A	join()	0	4	1
A	sort()	0	4	1
A	merge()	0	11	1
A	reduce()	0	4	1
A	validate()	0	8	2

How to fix Duplicated Code

<?php
declare(strict_types = 1);

namespace Innmind\Immutable;

use Innmind\Immutable\Exception\InvalidArgumentException;

class Set implements SetInterface
{
    use Type;

    private $type;
    private $spec;
    private $values;

    public function __construct(string $type)
    {
        $this->type = new StringPrimitive($type);

        $this->spec = $this->getSpecFor($type);
        $this->values = new Sequence;
    }

    /**
     * {@inheritdoc}
     */
    public function type(): StringPrimitive
    {
        return $this->type;
    }

    /**
     * {@inheritdoc}
     */
    public function size(): int
    {
        return $this->values->size();
    }

    /**
     * {@inheritdoc}
     */
    public function count(): int
    {
        return $this->values->size();
    }

    /**
     * {@inheritdoc}
     */
    public function toPrimitive()
    {
        return $this->values->toPrimitive();
    }

    /**
     * {@inheritdoc}
     */
    public function current()
    {
        return $this->values->current();
    }

    /**
     * {@inheritdoc}
     */
    public function key()
    {
        return $this->values->key();
    }

    /**
     * {@inheritdoc}
     */
    public function next()
    {
        $this->values->next();
    }

    /**
     * {@inheritdoc}
     */
    public function rewind()
    {
        $this->values->rewind();
    }

    /**
     * {@inheritdoc}
     */
    public function valid()
    {
        return $this->values->valid();
    }

    /**
     * {@inheritdoc}
     */
    public function intersect(SetInterface $set): SetInterface

    {
        $this->validate($set);

        $newSet = clone $this;
        $newSet->values = $this->values->intersect(
            new Sequence(...$set->toPrimitive())
        );

        return $newSet;
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 add($element): SetInterface
    {
        $this->spec->validate($element);

        if ($this->contains($element)) {
            return $this;
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());
}
        }

        $set = clone $this;
        $set->values = $this->values->add($element);

        return $set;
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 contains($element): bool
    {
        return $this->values->contains($element);
    }

    /**
     * {@inheritdoc}
     */
    public function remove($element): SetInterface
    {
        if (!$this->contains($element)) {
            return $this;
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());
}
        }

        $index = $this->values->indexOf($element);
        $set = clone $this;
        $set->values = (new Sequence)
            ->append($this->values->slice(0, $index))
            ->append($this->values->slice($index + 1, $this->size()));

        return $set;
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 diff(SetInterface $set): SetInterface

    {
        $this->validate($set);

        $newSet = clone $this;
        $newSet->values = $this->values->diff(
            new Sequence(...$set->toPrimitive())
        );

        return $newSet;
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 equals(SetInterface $set): bool
    {
        $this->validate($set);

        return $this->values->equals(
            new Sequence(...$set->toPrimitive())
        );
    }

    /**
     * {@inheritdoc}
     */
    public function filter(callable $predicate): SetInterface
    {
        $set = clone $this;
        $set->values = $this->values->filter($predicate);

        return $set;
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 foreach(callable $function): SetInterface
    {
        $this->values->foreach($function);

        return $this;
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 groupBy(callable $discriminator): MapInterface
    {
        return $this->values->groupBy($discriminator);
    }

    /**
     * {@inheritdoc}
     */
    public function map(callable $function): SetInterface
    {
        $set = clone $this;
        $set->values = new Sequence;

        return $this->reduce(
            $set,
            function(self $carry, $value) use ($function): self {
                return $carry->add($function($value));
            }
        );
    }

    /**
     * {@inheritdoc}
     */
    public function partition(callable $predicate): MapInterface
    {
        $truthy = clone $this;
        $falsy = clone $this;
        $partitions = $this->values->partition($predicate);
        $truthy->values = $partitions->get(0);
        $falsy->values = $partitions->get(1);

        return (new Map('bool', SetInterface::class))
            ->put(true, $truthy)
            ->put(false, $falsy);
    }

    /**
     * {@inheritdoc}
     */
    public function join(string $separator): StringPrimitive
    {
        return $this->values->join($separator);
    }

    /**
     * {@inheritdoc}
     */
    public function sort(callable $function): SequenceInterface
    {
        return $this->values->sort($function);
    }

    /**
     * {@inheritdoc}
     */
    public function merge(SetInterface $set): SetInterface
    {
        $this->validate($set);

        return $set->reduce(
            clone $this,
            function(self $carry, $value): self {
                return $carry->add($value);
            }
        );
    }

    /**
     * {@inheritdoc}
     */
    public function reduce($carry, callable $reducer)
    {
        return $this->values->reduce($carry, $reducer);
    }

    /**
     * Make sure the set is compatible with the current one
     *
     * @param SetInterface $set
     *
     * @throws InvalidArgumentException
     *
     * @return void
     */
    private function validate(SetInterface $set)
    {
        if (!$set->type()->equals($this->type)) {
            throw new InvalidArgumentException(
                'The 2 sets does not reference the same type'
            );
        }
    }
}


1			<?php
2			declare(strict_types = 1);
3
4			namespace Innmind\Immutable;
5
6			use Innmind\Immutable\Exception\InvalidArgumentException;
7
8			class Set implements SetInterface
9			{
10			use Type;
11
12			private $type;
13			private $spec;
14			private $values;
15
16	24		public function __construct(string $type)
17			{
18	24		$this->type = new StringPrimitive($type);
			0 ignored issues – show Deprecated Code introduced 2017-02-04 17:24 UTC by Report Bug Copy Issue Report The class `Innmind\Immutable\StringPrimitive` has been deprecated with message: To be removed in 2.0 This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
19	24		$this->spec = $this->getSpecFor($type);
20	24		$this->values = new Sequence;
21	24		}
22
23			/**
24			* {@inheritdoc}
25			*/
26	13		public function type(): StringPrimitive
27			{
28	13		return $this->type;
29			}
30
31			/**
32			* {@inheritdoc}
33			*/
34	2		public function size(): int
35			{
36	2		return $this->values->size();
37			}
38
39			/**
40			* {@inheritdoc}
41			*/
42	1		public function count(): int
43			{
44	1		return $this->values->size();
45			}
46
47			/**
48			* {@inheritdoc}
49			*/
50	13		public function toPrimitive()
51			{
52	13		return $this->values->toPrimitive();
53			}
54
55			/**
56			* {@inheritdoc}
57			*/
58	1		public function current()
59			{
60	1		return $this->values->current();
61			}
62
63			/**
64			* {@inheritdoc}
65			*/
66	1		public function key()
67			{
68	1		return $this->values->key();
69			}
70
71			/**
72			* {@inheritdoc}
73			*/
74	1		public function next()
75			{
76	1		$this->values->next();
77	1		}
78
79			/**
80			* {@inheritdoc}
81			*/
82	1		public function rewind()
83			{
84	1		$this->values->rewind();
85	1		}
86
87			/**
88			* {@inheritdoc}
89			*/
90	1		public function valid()
91			{
92	1		return $this->values->valid();
93			}
94
95			/**
96			* {@inheritdoc}
97			*/
98	2	View Code Duplication	public function intersect(SetInterface $set): SetInterface
			0 ignored issues – show Duplication introduced 2016-03-02 07:42 UTC by Report Bug Copy Issue Report This method 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...
99			{
100	2		$this->validate($set);
101
102	1		$newSet = clone $this;
103	1		$newSet->values = $this->values->intersect(
104	1		new Sequence(...$set->toPrimitive())
105			);
106
107	1		return $newSet;
			1 ignored issue – show Bug Best Practice introduced 2017-02-04 17:24 UTC by Report Bug Copy Issue Report The return type of `return $newSet;` (`Innmind\Immutable\Set`) is incompatible with the return type declared by the interface `Innmind\Immutable\SetInterface::intersect` of type `self`. 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...
108			}
109
110			/**
111			* {@inheritdoc}
112			*/
113	19		public function add($element): SetInterface
114			{
115	19		$this->spec->validate($element);
116
117	18		if ($this->contains($element)) {
118	2		return $this;
			1 ignored issue – show Bug Best Practice introduced 2017-02-04 17:24 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Innmind\Immutable\Set`) is incompatible with the return type declared by the interface `Innmind\Immutable\SetInterface::add` of type `self`. 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...
119			}
120
121	18		$set = clone $this;
122	18		$set->values = $this->values->add($element);
123
124	18		return $set;
			1 ignored issue – show Bug Best Practice introduced 2017-02-04 17:24 UTC by Report Bug Copy Issue Report The return type of `return $set;` (`Innmind\Immutable\Set`) is incompatible with the return type declared by the interface `Innmind\Immutable\SetInterface::add` of type `self`. 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...
125			}
126
127			/**
128			* {@inheritdoc}
129			*/
130	18		public function contains($element): bool
131			{
132	18		return $this->values->contains($element);
133			}
134
135			/**
136			* {@inheritdoc}
137			*/
138	1		public function remove($element): SetInterface
139			{
140	1		if (!$this->contains($element)) {
141			return $this;
			1 ignored issue – show Bug Best Practice introduced 2017-02-04 17:24 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Innmind\Immutable\Set`) is incompatible with the return type declared by the interface `Innmind\Immutable\SetInterface::remove` of type `self`. 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...
142			}
143
144	1		$index = $this->values->indexOf($element);
145	1		$set = clone $this;
146	1		$set->values = (new Sequence)
147	1		->append($this->values->slice(0, $index))
148	1		->append($this->values->slice($index + 1, $this->size()));
149
150	1		return $set;
			1 ignored issue – show Bug Best Practice introduced 2017-02-04 17:24 UTC by Report Bug Copy Issue Report The return type of `return $set;` (`Innmind\Immutable\Set`) is incompatible with the return type declared by the interface `Innmind\Immutable\SetInterface::remove` of type `self`. 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...
151			}
152
153			/**
154			* {@inheritdoc}
155			*/
156	2	View Code Duplication	public function diff(SetInterface $set): SetInterface
			0 ignored issues – show Duplication introduced 2016-03-02 07:42 UTC by Report Bug Copy Issue Report This method 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...
157			{
158	2		$this->validate($set);
159
160	1		$newSet = clone $this;
161	1		$newSet->values = $this->values->diff(
162	1		new Sequence(...$set->toPrimitive())
163			);
164
165	1		return $newSet;
			1 ignored issue – show Bug Best Practice introduced 2017-02-04 17:24 UTC by Report Bug Copy Issue Report The return type of `return $newSet;` (`Innmind\Immutable\Set`) is incompatible with the return type declared by the interface `Innmind\Immutable\SetInterface::diff` of type `self`. 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...
166			}
167
168			/**
169			* {@inheritdoc}
170			*/
171	3		public function equals(SetInterface $set): bool
172			{
173	3		$this->validate($set);
174
175	2		return $this->values->equals(
176	2		new Sequence(...$set->toPrimitive())
177			);
178			}
179
180			/**
181			* {@inheritdoc}
182			*/
183	1		public function filter(callable $predicate): SetInterface
184			{
185	1		$set = clone $this;
186	1		$set->values = $this->values->filter($predicate);
187
188	1		return $set;
			1 ignored issue – show Bug Best Practice introduced 2017-02-04 17:24 UTC by Report Bug Copy Issue Report The return type of `return $set;` (`Innmind\Immutable\Set`) is incompatible with the return type declared by the interface `Innmind\Immutable\SetInterface::filter` of type `self`. 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...
189			}
190
191			/**
192			* {@inheritdoc}
193			*/
194			public function foreach(callable $function): SetInterface
195			{
196	1		$this->values->foreach($function);
197
198	1		return $this;
			1 ignored issue – show Bug Best Practice introduced 2017-02-04 17:24 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Innmind\Immutable\Set`) is incompatible with the return type declared by the interface `Innmind\Immutable\SetInterface::foreach` of type `self`. 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...
199			}
200
201			/**
202			* {@inheritdoc}
203			*/
204	1		public function groupBy(callable $discriminator): MapInterface
205			{
206	1		return $this->values->groupBy($discriminator);
207			}
208
209			/**
210			* {@inheritdoc}
211			*/
212	2		public function map(callable $function): SetInterface
213			{
214	2		$set = clone $this;
215	2		$set->values = new Sequence;
216
217	2		return $this->reduce(
218			$set,
219			function(self $carry, $value) use ($function): self {
220	2		return $carry->add($function($value));
221	2		}
222			);
223			}
224
225			/**
226			* {@inheritdoc}
227			*/
228	1		public function partition(callable $predicate): MapInterface
229			{
230	1		$truthy = clone $this;
231	1		$falsy = clone $this;
232	1		$partitions = $this->values->partition($predicate);
233	1		$truthy->values = $partitions->get(0);
234	1		$falsy->values = $partitions->get(1);
235
236	1		return (new Map('bool', SetInterface::class))
237	1		->put(true, $truthy)
238	1		->put(false, $falsy);
239			}
240
241			/**
242			* {@inheritdoc}
243			*/
244	1		public function join(string $separator): StringPrimitive
245			{
246	1		return $this->values->join($separator);
247			}
248
249			/**
250			* {@inheritdoc}
251			*/
252	1		public function sort(callable $function): SequenceInterface
253			{
254	1		return $this->values->sort($function);
255			}
256
257			/**
258			* {@inheritdoc}
259			*/
260	2		public function merge(SetInterface $set): SetInterface
261			{
262	2		$this->validate($set);
263
264	1		return $set->reduce(
265	1		clone $this,
266	1		function(self $carry, $value): self {
267	1		return $carry->add($value);
268	1		}
269			);
270			}
271
272			/**
273			* {@inheritdoc}
274			*/
275	4		public function reduce($carry, callable $reducer)
276			{
277	4		return $this->values->reduce($carry, $reducer);
278			}
279
280			/**
281			* Make sure the set is compatible with the current one
282			*
283			* @param SetInterface $set
284			*
285			* @throws InvalidArgumentException
286			*
287			* @return void
288			*/
289	8		private function validate(SetInterface $set)
290			{
291	8		if (!$set->type()->equals($this->type)) {
292	4		throw new InvalidArgumentException(
293	4		'The 2 sets does not reference the same type'
294			);
295			}
296	4		}
297			}
298

Innmind / Immutable

GitHub Access Token became invalid

Push — develop ( cad621...d8b57f )

Set A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

26 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like