FantaPaginatorAdapter - Code Metrics - FriendsOfSymfony/FOSElasticaBundle - Measure and Improve Code Quality continuously with Scrutinizer

FantaPaginatorAdapter A
last analyzed 2021-03-12 13:55 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
dl	0
loc	64
c	0
b	0
f	0
wmc	6
lcom	1
cbo	2
ccs	13
cts	13
cp	1
rs	10

6 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	getNbResults()	4	1
A	getAggregations()	4	1
A	getSuggests()	4	1
A	getSlice()	4	1
A	getMaxScore()	4	1

<?php

/*
 * This file is part of the FOSElasticaBundle package.
 *
 * (c) FriendsOfSymfony <https://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\ElasticaBundle\Paginator;

use Pagerfanta\Adapter\AdapterInterface;

class FantaPaginatorAdapter implements AdapterInterface
{
    private $adapter;

    public function __construct(PaginatorAdapterInterface $adapter)
    {
        $this->adapter = $adapter;
    }

    /**
     * Returns the number of results.
     *
     * @return int The number of results
     */
    public function getNbResults()
    {
        return $this->adapter->getTotalHits();
    }

    /**
     * Returns Aggregations.
     *
     * @return mixed
     *
     * @api
     */
    public function getAggregations()
    {
        return $this->adapter->getAggregations();
    }

    /**
     * Returns Suggestions.
     *
     * @return mixed
     *
     * @api
     */
    public function getSuggests()
    {
        return $this->adapter->getSuggests();
    }

    /**
     * Returns a slice of the results.
     *
     * @param int $offset The offset
     * @param int $length The length
     *
     * @return array|\Traversable The slice
     */
    public function getSlice($offset, $length)
    {
        return $this->adapter->getResults($offset, $length)->toArray();
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 getMaxScore()
    {
        return $this->adapter->getMaxScore();
    }
}


1		<?php
2
3		/*
4		* This file is part of the FOSElasticaBundle package.
5		*
6		* (c) FriendsOfSymfony <https://friendsofsymfony.github.com/>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace FOS\ElasticaBundle\Paginator;
13
14		use Pagerfanta\Adapter\AdapterInterface;
15
16		class FantaPaginatorAdapter implements AdapterInterface
17		{
18		private $adapter;
19
20	7	public function __construct(PaginatorAdapterInterface $adapter)
21		{
22	7	$this->adapter = $adapter;
23	7	}
24
25		/**
26		* Returns the number of results.
27		*
28		* @return int The number of results
29		*/
30	1	public function getNbResults()
31		{
32	1	return $this->adapter->getTotalHits();
33		}
34
35		/**
36		* Returns Aggregations.
37		*
38		* @return mixed
39		*
40		* @api
41		*/
42	1	public function getAggregations()
43		{
44	1	return $this->adapter->getAggregations();
45		}
46
47		/**
48		* Returns Suggestions.
49		*
50		* @return mixed
51		*
52		* @api
53		*/
54	1	public function getSuggests()
55		{
56	1	return $this->adapter->getSuggests();
57		}
58
59		/**
60		* Returns a slice of the results.
61		*
62		* @param int $offset The offset
63		* @param int $length The length
64		*
65		* @return array\|\Traversable The slice
66		*/
67	1	public function getSlice($offset, $length)
68		{
69	1	return $this->adapter->getResults($offset, $length)->toArray();
		0 ignored issues – show Bug Best Practice introduced 2020-06-23 20:46 UTC by Report Bug Copy Issue Report The return type of `return $this->adapter->g...t, $length)->toArray();` (`array`) is incompatible with the return type declared by the interface `Pagerfanta\Adapter\AdapterInterface::getSlice` of type `Pagerfanta\Adapter\iterable`. 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...
70		}
71
72		/**
73		* {@inheritdoc}
74		*/
75	1	public function getMaxScore()
76		{
77	1	return $this->adapter->getMaxScore();
78		}
79		}
80

FriendsOfSymfony / FOSElasticaBundle

FantaPaginatorAdapter A last analyzed 2021-03-12 13:55 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Duplication Side-by-Side

Filter issues like

FantaPaginatorAdapter A
last analyzed 2021-03-12 13:55 UTC