DoctrinePaginator - Code Metrics - doctrine/DoctrineORMModule - Measure and Improve Code Quality continuously with Scrutinizer

DoctrinePaginator A
last analyzed 2020-03-08 20:17 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	5
lcom	1
cbo	2
dl	0
loc	44
ccs	0
cts	24
cp	0
rs	10
c	0
b	0
f	0

5 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	setPaginator()	4	1
A	getPaginator()	4	1
A	getItems()	9	1
A	count()	4	1

<?php

declare(strict_types=1);

namespace DoctrineORMModule\Paginator\Adapter;

use Doctrine\ORM\Tools\Pagination\Paginator;
use Laminas\Paginator\Adapter\AdapterInterface;

/**
 * Paginator adapter for the Laminas\Paginator component
 */
class DoctrinePaginator implements AdapterInterface
{
    /** @var Paginator */
    protected $paginator;

    /**
     * Constructor
     */
    public function __construct(Paginator $paginator)
    {
        $this->paginator = $paginator;
    }

    public function setPaginator(Paginator $paginator) : self
    {
        $this->paginator = $paginator;
    }

    public function getPaginator() : Paginator
    {
        return $this->paginator;
    }

    /**
     * {@inheritDoc}
     */
    public function getItems($offset, $itemCountPerPage)
    {
        $this->paginator
             ->getQuery()
             ->setFirstResult($offset)
             ->setMaxResults($itemCountPerPage);

        return $this->paginator->getIterator();
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 count()
    {
        return $this->paginator->count();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace DoctrineORMModule\Paginator\Adapter;
6
7			use Doctrine\ORM\Tools\Pagination\Paginator;
8			use Laminas\Paginator\Adapter\AdapterInterface;
9
10			/**
11			* Paginator adapter for the Laminas\Paginator component
12			*/
13			class DoctrinePaginator implements AdapterInterface
14			{
15			/** @var Paginator */
16			protected $paginator;
17
18			/**
19			* Constructor
20			*/
21			public function __construct(Paginator $paginator)
22			{
23			$this->paginator = $paginator;
24			}
25
26			public function setPaginator(Paginator $paginator) : self
27			{
28			$this->paginator = $paginator;
29			}
30
31			public function getPaginator() : Paginator
32			{
33			return $this->paginator;
34			}
35
36			/**
37			* {@inheritDoc}
38			*/
39			public function getItems($offset, $itemCountPerPage)
40			{
41			$this->paginator
42			->getQuery()
43			->setFirstResult($offset)
44			->setMaxResults($itemCountPerPage);
45
46			return $this->paginator->getIterator();
			0 ignored issues – show Bug Best Practice introduced 2020-01-12 23:06 UTC by Report Bug Copy Issue Report The return type of `return $this->paginator->getIterator();` (`Traversable`) is incompatible with the return type declared by the interface `Laminas\Paginator\Adapte...pterInterface::getItems` of type `array`. 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...
47			}
48
49			/**
50			* {@inheritDoc}
51			*/
52			public function count()
53			{
54			return $this->paginator->count();
55			}
56			}
57

doctrine / DoctrineORMModule

DoctrinePaginator A last analyzed 2020-03-08 20:17 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

Duplication Side-by-Side

Filter issues like

DoctrinePaginator A
last analyzed 2020-03-08 20:17 UTC