SortProcessor::process() - Code Metrics - view-components/doctrine-data-processing - Measure and Improve Code Quality continuously with Scrutinizer

SortProcessor::process() A
last analyzed 2016-06-14 15:08 UTC

↳ Parent: SortProcessor

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	7
ccs	0
cts	5
cp	0
rs	9.4285
cc	1
eloc	5
nc	1
nop	2
crap	2

<?php

namespace ViewComponents\Doctrine\Processor;

use Doctrine\DBAL\Query\QueryBuilder;
use ViewComponents\ViewComponents\Data\Operation\OperationInterface;
use ViewComponents\ViewComponents\Data\Operation\SortOperation;
use ViewComponents\ViewComponents\Data\Processor\ProcessorInterface;

/**
 * SortOperation processing for DoctrineDataProvider.
 *
 * @see SortOperation
 */
class SortProcessor implements ProcessorInterface
{
    /**
     * Applies operation to data source and returns modified data source.
     *
     * @param QueryBuilder $src
     * @param OperationInterface|SortOperation $operation
     * @return QueryBuilder
     */
    public function process($src, OperationInterface $operation)
    {
        $field = $operation->getField();
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.
    }
}
        $order = $operation->getOrder();
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.
    }
}
        $src->orderBy($field, $order);
        return $src;
    }
}


SortProcessor::process() A
last analyzed 2016-06-14 15:08 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

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\SortOperation;
8			use ViewComponents\ViewComponents\Data\Processor\ProcessorInterface;
9
10			/**
11			* SortOperation processing for DoctrineDataProvider.
12			*
13			* @see SortOperation
14			*/
15			class SortProcessor implements ProcessorInterface
16			{
17			/**
18			* Applies operation to data source and returns modified data source.
19			*
20			* @param QueryBuilder $src
21			* @param OperationInterface\|SortOperation $operation
22			* @return QueryBuilder
23			*/
24			public function process($src, OperationInterface $operation)
25			{
26			$field = $operation->getField();
			0 ignored issues – show Bug introduced 2016-03-28 16:56 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 `getField()` does only exist in the following implementations of said interface: `ViewComponents\ViewCompo...eration\FilterOperation`, `ViewComponents\ViewCompo...Operation\SortOperation`. 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...
27			$order = $operation->getOrder();
			0 ignored issues – show Bug introduced 2016-03-28 16:56 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 `getOrder()` does only exist in the following implementations of said interface: `ViewComponents\ViewCompo...Operation\SortOperation`. 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...
28			$src->orderBy($field, $order);
29			return $src;
30			}
31			}
32

view-components / doctrine-data-processing

SortProcessor::process() A last analyzed 2016-06-14 15:08 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

SortProcessor::process() A
last analyzed 2016-06-14 15:08 UTC