CacheFilter - Code Metrics - hanneskod/classtools - Measure and Improve Code Quality continuously with Scrutinizer

CacheFilter A
last analyzed 2021-02-15 20:05 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	26
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
wmc	3
lcom	1
cbo	2
dl	0
loc	26
rs	10
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getIterator()	0	8	2

<?php
/**
 * This program is free software. It comes without any warranty, to
 * the extent permitted by applicable law. You can redistribute it
 * and/or modify it under the terms of the Do What The Fuck You Want
 * To Public License, Version 2, as published by Sam Hocevar. See
 * http://www.wtfpl.net/ for more details.
 */

declare(strict_types = 1);

namespace hanneskod\classtools\Iterator\Filter;

use hanneskod\classtools\Iterator\ClassIterator;
use hanneskod\classtools\Iterator\Filter;

/**
 * Cache bound iterator
 *
 * @author Hannes Forsgård <[email protected]>
 */
final class CacheFilter extends ClassIterator implements Filter
{
    use FilterTrait;

    /**
     * @var \ArrayIterator
     */
    private $cache;

    /**
     * Override ClassIterator::__construct
     */
    public function __construct()
    {
        parent::__construct();
    }

    public function getIterator(): iterable
    {
        if (!isset($this->cache)) {
            $this->cache = new \ArrayIterator(iterator_to_array($this->getBoundIterator()));
        }

        return $this->cache;
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());
}
    }
}


1			<?php
2			/**
3			* This program is free software. It comes without any warranty, to
4			* the extent permitted by applicable law. You can redistribute it
5			* and/or modify it under the terms of the Do What The Fuck You Want
6			* To Public License, Version 2, as published by Sam Hocevar. See
7			* http://www.wtfpl.net/ for more details.
8			*/
9
10			declare(strict_types = 1);
11
12			namespace hanneskod\classtools\Iterator\Filter;
13
14			use hanneskod\classtools\Iterator\ClassIterator;
15			use hanneskod\classtools\Iterator\Filter;
16
17			/**
18			* Cache bound iterator
19			*
20			* @author Hannes Forsgård <[email protected]>
21			*/
22			final class CacheFilter extends ClassIterator implements Filter
23			{
24			use FilterTrait;
25
26			/**
27			* @var \ArrayIterator
28			*/
29			private $cache;
30
31			/**
32			* Override ClassIterator::__construct
33			*/
34			public function __construct()
35			{
36			parent::__construct();
37			}
38
39			public function getIterator(): iterable
40			{
41			if (!isset($this->cache)) {
42			$this->cache = new \ArrayIterator(iterator_to_array($this->getBoundIterator()));
43			}
44
45			return $this->cache;
			0 ignored issues – show Bug Best Practice introduced 2018-09-29 22:54 UTC by Report Bug Copy Issue Report The return type of `return $this->cache;` (`ArrayIterator`) is incompatible with the return type of the parent method `hanneskod\classtools\Ite...ssIterator::getIterator` of type `Generator`. 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...
46			}
47			}
48

hanneskod / classtools

CacheFilter A last analyzed 2021-02-15 20:05 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Duplication Side-by-Side

Filter issues like

CacheFilter A
last analyzed 2021-02-15 20:05 UTC