NoCachePool   A
last analyzed

Complexity

Total Complexity 4

Size/Duplication

Total Lines 32
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 1

Importance

Changes 2
Bugs 0 Features 0
Metric Value
wmc 4
c 2
b 0
f 0
lcom 0
cbo 1
dl 0
loc 32
rs 10

3 Methods

Rating   Name   Duplication   Size   Complexity  
A getItem() 0 4 1
A getItems() 0 8 2
A clear() 0 4 1
1
<?php
2
3
namespace Perry\Cache\NoCache;
4
5
use Psr\Cache\PoolInterface;
6
7
/**
8
 * Class will always return non-hits
9
 *
10
 * @package Perry\Cache\NoCache
11
 */
12
class NoCachePool implements PoolInterface
13
{
14
    /**
15
     * @param string $key
16
     * @return NoCacheItem|\Psr\Cache\ItemInterface
17
     */
18
    public function getItem($key)
19
    {
20
        return new NoCacheItem($key);
21
    }
22
23
    /**
24
     * @param array $keys
25
     * @return array|\Traversable
26
     */
27
    public function getItems(array $keys)
28
    {
29
        $result = [];
30
        foreach ($keys as $key) {
31
            $result[$key] = $this->getItem($key);
32
        }
33
        return $result;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $result; (array) is incompatible with the return type declared by the interface Psr\Cache\PoolInterface::getItems of type Traversable.

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...
34
    }
35
36
    /**
37
     * @return $this|PoolInterface
38
     */
39
    public function clear()
40
    {
41
        return $this;
42
    }
43
}
44