GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.
Completed
Push — master ( ff3008...d4aa5e )
by Nicholas
03:20
created

InMemoryRepository::getByCodepoints()   A

Complexity

Conditions 3
Paths 4

Size

Total Lines 13
Code Lines 8

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
c 1
b 0
f 1
dl 0
loc 13
rs 9.4285
cc 3
eloc 8
nc 4
nop 1
1
<?php
2
3
namespace UCD\Infrastructure\Repository\CharacterRepository;
4
5
use UCD\Unicode\Character;
6
use UCD\Unicode\Character\Collection;
7
use UCD\Unicode\Codepoint;
8
use UCD\Unicode\Character\Repository\CharacterNotFoundException;
9
use UCD\Unicode\Character\WritableRepository;
10
use UCD\Unicode\Character\Repository;
11
use UCD\Unicode\CodepointAssigned;
12
13
class InMemoryRepository implements WritableRepository
14
{
15
    use Repository\Capability\Notify;
16
    use Repository\Capability\BlockSearchByIteration;
17
18
    /**
19
     * @var array
20
     */
21
    private $characters = [];
22
23
    /**
24
     * {@inheritDoc}
25
     */
26
    public function getByCodepoint(Codepoint $codepoint)
27
    {
28
        $index = $this->indexFromCodepoint($codepoint);
29
30
        if (array_key_exists($index, $this->characters) === false) {
31
            throw CharacterNotFoundException::withCodepoint($codepoint);
32
        }
33
34
        return $this->characters[$index];
35
    }
36
37
    /**
38
     * {@inheritDoc}
39
     */
40
    public function getByCodepoints(Codepoint\Collection $codepoints)
41
    {
42
        $results = [];
43
44
        foreach ($codepoints as $codepoint) {
45
            try {
46
                $character = $this->getByCodepoint($codepoint);
47
                array_push($results, $character);
48
            } catch (CharacterNotFoundException $e) { }
0 ignored issues
show
Coding Style Comprehensibility introduced by
Consider adding a comment why this CATCH block is empty.
Loading history...
49
        }
50
51
        return Character\Collection::fromArray($results);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return \UCD\Unicode\Char...n::fromArray($results); (UCD\Unicode\Character\Collection) is incompatible with the return type declared by the interface UCD\Unicode\Character\Repository::getByCodepoints of type UCD\Unicode\CodepointAssigned[].

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
    /**
55
     * {@inheritDoc}
56
     */
57
    public function addMany(Collection $characters)
58
    {
59
        $characters->traverseWith(function (CodepointAssigned $c) {
60
            $codepoint = $c->getCodepoint();
61
            $index = $this->indexFromCodepoint($codepoint);
62
            $this->characters[$index] = $c;
63
            $this->notify();
64
        });
65
    }
66
67
    /**
68
     * {@inheritDoc}
69
     */
70
    public function getAll()
71
    {
72
        return Collection::fromArray($this->characters);
73
    }
74
75
    /**
76
     * {@inheritDoc}
77
     */
78
    public function count()
79
    {
80
        return count($this->characters);
81
    }
82
83
    /**
84
     * @param Codepoint $codepoint
85
     * @return int
86
     */
87
    private function indexFromCodepoint(Codepoint $codepoint)
88
    {
89
        return $codepoint->getValue();
90
    }
91
}