OrderByProcessor::field() - Code Metrics - Inspection of "Order by relation field" - rambler-digital-solutions/hydrogen - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5)

by Anton

created 2018-06-09 08:02 UTC

OrderByProcessor::field() A

↳ Parent: OrderByProcessor

Complexity

Conditions	3
Paths	4

Size

Total Lines	15
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	15
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	8
nc	4
nop	1

<?php
/**
 * This file is part of Hydrogen package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
declare(strict_types=1);

namespace RDS\Hydrogen\Processor\DatabaseProcessor;

use Doctrine\ORM\QueryBuilder;
use RDS\Hydrogen\Criteria\Common\Field;
use RDS\Hydrogen\Criteria\CriterionInterface;
use RDS\Hydrogen\Criteria\OrderBy;

/**
 * Class OrderByProcessor
 */
class OrderByProcessor extends CriterionProcessor
{
    /**
     * @var int
     */
    private static $relationId = 0;

    /**
     * @param QueryBuilder $builder
     * @param CriterionInterface|OrderBy $orderBy
     * @return QueryBuilder
     */
    public function apply(QueryBuilder $builder, CriterionInterface $orderBy): QueryBuilder
    {
        return $builder->orderBy($this->field($orderBy->getField()), $orderBy->getDirection());
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.
    }
}
    }

    /**
     * @param Field $field
     * @return string
     */
    protected function field(Field $field): string
    {
        $relations = explode('.', $field->getName());
        $fieldValue = array_pop($relations);

        foreach ($relations as $relation) {
            $alias = $this->createAlias($relation);
        }

        if (isset($alias)) {
            return $alias.'.'.$fieldValue;
        }

        return parent::field($field);
    }


    /**
     * @param string $class
     * @return string
     */
    private function createAlias(string $class): string
    {
        return 'ref_' . \snake_case(\class_basename($class)) . '_' . ++self::$relationId;
    }
}


1			<?php
2			/**
3			* This file is part of Hydrogen package.
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*/
8			declare(strict_types=1);
9
10			namespace RDS\Hydrogen\Processor\DatabaseProcessor;
11
12			use Doctrine\ORM\QueryBuilder;
13			use RDS\Hydrogen\Criteria\Common\Field;
14			use RDS\Hydrogen\Criteria\CriterionInterface;
15			use RDS\Hydrogen\Criteria\OrderBy;
16
17			/**
18			* Class OrderByProcessor
19			*/
20			class OrderByProcessor extends CriterionProcessor
21			{
22			/**
23			* @var int
24			*/
25			private static $relationId = 0;
26
27			/**
28			* @param QueryBuilder $builder
29			* @param CriterionInterface\|OrderBy $orderBy
30			* @return QueryBuilder
31			*/
32			public function apply(QueryBuilder $builder, CriterionInterface $orderBy): QueryBuilder
33			{
34			return $builder->orderBy($this->field($orderBy->getField()), $orderBy->getDirection());
			0 ignored issues – show Bug introduced 2018-05-30 13:01 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `RDS\Hydrogen\Criteria\CriterionInterface` as the method `getField()` does only exist in the following implementations of said interface: `RDS\Hydrogen\Criteria\GroupBy`, `RDS\Hydrogen\Criteria\OrderBy`, `RDS\Hydrogen\Criteria\Selection`, `RDS\Hydrogen\Criteria\Where`. 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... Bug introduced 2018-05-30 13:01 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `RDS\Hydrogen\Criteria\CriterionInterface` as the method `getDirection()` does only exist in the following implementations of said interface: `RDS\Hydrogen\Criteria\OrderBy`. 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...
35			}
36
37			/**
38			* @param Field $field
39			* @return string
40			*/
41			protected function field(Field $field): string
42			{
43			$relations = explode('.', $field->getName());
44			$fieldValue = array_pop($relations);
45
46			foreach ($relations as $relation) {
47			$alias = $this->createAlias($relation);
48			}
49
50			if (isset($alias)) {
51			return $alias.'.'.$fieldValue;
52			}
53
54			return parent::field($field);
55			}
56
57
58			/**
59			* @param string $class
60			* @return string
61			*/
62			private function createAlias(string $class): string
63			{
64			return 'ref_' . \snake_case(\class_basename($class)) . '_' . ++self::$relationId;
65			}
66			}
67

rambler-digital-solutions / hydrogen

Pull Request — master (#5)

OrderByProcessor::field() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like