PaginationIterator::getIterator() - Code Metrics - Inspection of "Merge branch 'release/1.0.1'" - GermaniaKG/Pagination - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2ec996...9cbdc1 )

by Carsten

created 2019-03-14 13:16 UTC

PaginationIterator::getIterator() A

↳ Parent: PaginationIterator

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	6
cts	6
cp	1
rs	9.8666
c	0
b	0
f	0
cc	2
nc	2
nop	0
crap	2

<?php
namespace Germania\Pagination;

class PaginationIterator implements \IteratorAggregate, \Countable
{

	/**
	 * @var Traversable
	 */
	public $items;

	/**
	 * @var PaginationInterface
	 */
	public $pagination;


	/**
	 * @param \Traversable        $items
	 * @param PaginationInterface $pagination
	 */
	public function __construct( \Traversable $items, PaginationInterface $pagination)
	{
		$this->pagination = $pagination;
		$this->items = $items;

	}


	public function getIterator()
	{
		if ($this->pagination->isActive()):

	    	$offset = $this->calculateOffset();
	    	$length = $this->calculateLength();
	    	return new \LimitIterator( new \IteratorIterator($this->items), $offset, $length);

	    endif;

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


	public function count()
	{
		$iterator = $this->getIterator();
		return iterator_count( $iterator );
	}



	protected function calculateOffset()
	{
		$current_page_size = $this->pagination->getPageSize();
		$page_number = $this->pagination->getCurrent();

		return $current_page_size * $page_number;
	}


	protected function calculateLength()
	{
		return $this->pagination->getPageSize();
	}
}

1		<?php
2		namespace Germania\Pagination;
3
4		class PaginationIterator implements \IteratorAggregate, \Countable
5		{
6
7		/**
8		* @var Traversable
9		*/
10		public $items;
11
12		/**
13		* @var PaginationInterface
14		*/
15		public $pagination;
16
17
18		/**
19		* @param \Traversable $items
20		* @param PaginationInterface $pagination
21		*/
22	8	public function __construct( \Traversable $items, PaginationInterface $pagination)
23		{
24	8	$this->pagination = $pagination;
25	8	$this->items = $items;
		0 ignored issues – show Documentation Bug introduced 2019-03-14 11:46 UTC by Report Bug Copy Issue Report It seems like `$items` of type `object<Traversable>` is incompatible with the declared type `object<Germania\Pagination\Traversable>` of property `$items`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
26	8	}
27
28
29	8	public function getIterator()
30		{
31	8	if ($this->pagination->isActive()):
32
33	4	$offset = $this->calculateOffset();
34	4	$length = $this->calculateLength();
35	4	return new \LimitIterator( new \IteratorIterator($this->items), $offset, $length);
36
37		endif;
38
39	4	return $this->items;
		0 ignored issues – show Bug Best Practice introduced 2019-03-14 11:46 UTC by Report Bug Copy Issue Report The return type of `return $this->items;` (`Germania\Pagination\Traversable`) is incompatible with the return type declared by the interface `IteratorAggregate::getIterator` 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...
40		}
41
42
43	8	public function count()
44		{
45	8	$iterator = $this->getIterator();
46	8	return iterator_count( $iterator );
47		}
48
49
50
51	4	protected function calculateOffset()
52		{
53	4	$current_page_size = $this->pagination->getPageSize();
54	4	$page_number = $this->pagination->getCurrent();
55
56	4	return $current_page_size * $page_number;
57		}
58
59
60	4	protected function calculateLength()
61		{
62	4	return $this->pagination->getPageSize();
63		}
64		}

GermaniaKG / Pagination

Push — master ( 2ec996...9cbdc1 )

PaginationIterator::getIterator() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like