PaginateProcessor - Code Metrics - view-components/doctrine-data-processing - Measure and Improve Code Quality continuously with Scrutinizer

PaginateProcessor A
last analyzed 2016-06-14 15:08 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	16
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
wmc	1
c	2
b	0
f	1
lcom	0
cbo	2
dl	0
loc	16
ccs	0
cts	3
cp	0
rs	10

1 Method

Rating	Name	Duplication	Size	Complexity
A	process()	0	6	1

<?php

namespace ViewComponents\Doctrine\Processor;

use Doctrine\DBAL\Query\QueryBuilder;
use ViewComponents\ViewComponents\Data\Operation\OperationInterface;
use ViewComponents\ViewComponents\Data\Operation\PaginateOperation;
use ViewComponents\ViewComponents\Data\Processor\AbstractPaginateProcessor;

/**
 * PaginateOperation processing for DoctrineDataProvider.
 *
 * @see PaginateOperation
 */
class PaginateProcessor extends AbstractPaginateProcessor
{
    /**
     * Applies operation to data source and returns modified data source.
     *
     * @param QueryBuilder $src
     * @param OperationInterface|PaginateOperation $operation
     * @return QueryBuilder
     */
    public function process($src, OperationInterface $operation)
    {
        return $src
            ->setFirstResult($this->getOffset($operation))

            ->setMaxResults($operation->getPageSize());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }
}


1			<?php
2
3			namespace ViewComponents\Doctrine\Processor;
4
5			use Doctrine\DBAL\Query\QueryBuilder;
6			use ViewComponents\ViewComponents\Data\Operation\OperationInterface;
7			use ViewComponents\ViewComponents\Data\Operation\PaginateOperation;
8			use ViewComponents\ViewComponents\Data\Processor\AbstractPaginateProcessor;
9
10			/**
11			* PaginateOperation processing for DoctrineDataProvider.
12			*
13			* @see PaginateOperation
14			*/
15			class PaginateProcessor extends AbstractPaginateProcessor
16			{
17			/**
18			* Applies operation to data source and returns modified data source.
19			*
20			* @param QueryBuilder $src
21			* @param OperationInterface\|PaginateOperation $operation
22			* @return QueryBuilder
23			*/
24			public function process($src, OperationInterface $operation)
25			{
26			return $src
27			->setFirstResult($this->getOffset($operation))
			0 ignored issues – show Compatibility introduced 2016-03-28 16:56 UTC by Report Bug Copy Issue Report `$operation` of type `object<ViewComponents\Vi...ion\OperationInterface>` is not a sub-type of `object<ViewComponents\Vi...tion\PaginateOperation>`. It seems like you assume a concrete implementation of the interface `ViewComponents\ViewCompo...tion\OperationInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
28			->setMaxResults($operation->getPageSize());
			0 ignored issues – show Bug introduced 2016-05-24 15:49 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `ViewComponents\ViewCompo...tion\OperationInterface` as the method `getPageSize()` does only exist in the following implementations of said interface: `ViewComponents\ViewCompo...ation\PaginateOperation`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
29			}
30			}
31

view-components / doctrine-data-processing

PaginateProcessor A last analyzed 2016-06-14 15:08 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

1 Method

Available Fixes

Duplication Side-by-Side

Filter issues like

PaginateProcessor A
last analyzed 2016-06-14 15:08 UTC