SubscriptionRepository - Code Metrics - Inspection of "filtering subscriptions by criteria" - PayHelper/payments-hub - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#52)

by Rafał

created 2018-07-26 08:50 UTC

SubscriptionRepository A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
wmc	7
lcom	1
cbo	4
dl	0
loc	75
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Size	Complexity
A	findOneBySubscriptionId()	11	1
A	getOneByToken()	11	1
A	applyCustomCriteria()	26	4
A	createPaginator()	12	1

<?php

declare(strict_types=1);

namespace PH\Bundle\CoreBundle\Doctrine\ORM;

use Doctrine\ORM\QueryBuilder;
use PH\Component\Core\Model\SubscriptionInterface;
use PH\Component\Core\Repository\SubscriptionRepositoryInterface;
use Sylius\Bundle\ResourceBundle\Doctrine\ORM\EntityRepository;

class SubscriptionRepository extends EntityRepository implements SubscriptionRepositoryInterface
{
    /**
     * {@inheritdoc}
     */
    public function findOneBySubscriptionId(string $id): ?SubscriptionInterface
    {
        return $this->createQueryBuilder('o')
            ->andWhere('o.id = :id')
            ->leftJoin('o.items', 'i')
            ->addSelect('i')
            ->setParameter('id', $id)
            ->getQuery()
            ->getOneOrNullResult()
        ;
    }

    /**
     * {@inheritdoc}
     */
    public function getOneByToken(string $token): ?SubscriptionInterface
    {
        return $this->createQueryBuilder('o')
            ->andWhere('o.tokenValue = :token')
            ->leftJoin('o.items', 'i')
            ->addSelect('i')
            ->setParameter('token', $token)
            ->getQuery()
            ->getOneOrNullResult()
        ;
    }

    public function applyCustomCriteria(QueryBuilder $queryBuilder, array $criteria = []): void
    {
        foreach ($criteria as $key => $criterion) {
            if (false !== strpos($key, 'metadata.')) {
                $explodedValueArray = explode(',', $criterion);

                $queryBuilder
                    ->andWhere($queryBuilder->expr()->eq(
                        'metadata.key',
                        $queryBuilder->expr()->literal(str_replace('metadata.', '', $key))
                    ))
                ;

                $orX = $queryBuilder->expr()->orX();
                foreach ($explodedValueArray as $item) {
                    $orX->add($queryBuilder->expr()->eq('metadata.value', $queryBuilder->expr()->literal($item)));
                }

                $queryBuilder
                    ->andWhere($orX)
                ;

                unset($criteria[$key]);
            }
        }
    }

    /**
     * {@inheritdoc}
     */
    public function createPaginator(array $criteria = [], array $sorting = []): iterable
    {
        $queryBuilder = $this->createQueryBuilder('o')
            ->leftJoin('o.metadata', 'metadata')
        ;

        $this->applyCustomCriteria($queryBuilder, $criteria);
        $this->applyCriteria($queryBuilder, $criteria);
        $this->applySorting($queryBuilder, $sorting);

        return $this->getPaginator($queryBuilder);
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());
}
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace PH\Bundle\CoreBundle\Doctrine\ORM;
6
7			use Doctrine\ORM\QueryBuilder;
8			use PH\Component\Core\Model\SubscriptionInterface;
9			use PH\Component\Core\Repository\SubscriptionRepositoryInterface;
10			use Sylius\Bundle\ResourceBundle\Doctrine\ORM\EntityRepository;
11
12			class SubscriptionRepository extends EntityRepository implements SubscriptionRepositoryInterface
13			{
14			/**
15			* {@inheritdoc}
16			*/
17			public function findOneBySubscriptionId(string $id): ?SubscriptionInterface
18			{
19			return $this->createQueryBuilder('o')
20			->andWhere('o.id = :id')
21			->leftJoin('o.items', 'i')
22			->addSelect('i')
23			->setParameter('id', $id)
24			->getQuery()
25			->getOneOrNullResult()
26			;
27			}
28
29			/**
30			* {@inheritdoc}
31			*/
32			public function getOneByToken(string $token): ?SubscriptionInterface
33			{
34			return $this->createQueryBuilder('o')
35			->andWhere('o.tokenValue = :token')
36			->leftJoin('o.items', 'i')
37			->addSelect('i')
38			->setParameter('token', $token)
39			->getQuery()
40			->getOneOrNullResult()
41			;
42			}
43
44			public function applyCustomCriteria(QueryBuilder $queryBuilder, array $criteria = []): void
45			{
46			foreach ($criteria as $key => $criterion) {
47			if (false !== strpos($key, 'metadata.')) {
48			$explodedValueArray = explode(',', $criterion);
49
50			$queryBuilder
51			->andWhere($queryBuilder->expr()->eq(
52			'metadata.key',
53			$queryBuilder->expr()->literal(str_replace('metadata.', '', $key))
54			))
55			;
56
57			$orX = $queryBuilder->expr()->orX();
58			foreach ($explodedValueArray as $item) {
59			$orX->add($queryBuilder->expr()->eq('metadata.value', $queryBuilder->expr()->literal($item)));
60			}
61
62			$queryBuilder
63			->andWhere($orX)
64			;
65
66			unset($criteria[$key]);
67			}
68			}
69			}
70
71			/**
72			* {@inheritdoc}
73			*/
74			public function createPaginator(array $criteria = [], array $sorting = []): iterable
75			{
76			$queryBuilder = $this->createQueryBuilder('o')
77			->leftJoin('o.metadata', 'metadata')
78			;
79
80			$this->applyCustomCriteria($queryBuilder, $criteria);
81			$this->applyCriteria($queryBuilder, $criteria);
82			$this->applySorting($queryBuilder, $sorting);
83
84			return $this->getPaginator($queryBuilder);
			0 ignored issues – show Bug Best Practice introduced 2018-07-25 14:29 UTC by Report Bug Copy Issue Report The return type of `return $this->getPaginator($queryBuilder);` (`Pagerfanta\Pagerfanta`) is incompatible with the return type declared by the interface `Sylius\Component\Resourc...erface::createPaginator` of type `Sylius\Component\Resource\Repository\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...
85			}
86			}
87

PayHelper / payments-hub

Pull Request — master (#52)

SubscriptionRepository A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

Duplication Side-by-Side

Filter issues like