ORMPagerProvider::provide() - Code Metrics - Inspection of "Fix pagination of ORM queries when populating" - FriendsOfSymfony/FOSElasticaBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1402)

by Christophe

created 2018-02-21 10:35 UTC

ORMPagerProvider::provide() B

↳ Parent: ORMPagerProvider

Complexity

Conditions	5
Paths	2

Size

Total Lines	38
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	5

Importance

Changes

Metric	Value
dl	0
loc	38
ccs	8
cts	8
cp	1
rs	8.439
c	0
b	0
f	0
cc	5
eloc	15
nc	2
nop	1
crap	5

<?php

/*
 * This file is part of the FOSElasticaBundle package.
 *
 * (c) FriendsOfSymfony <http://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\Doctrine;

use Doctrine\Common\Persistence\ManagerRegistry;
use Doctrine\ORM\Query\Expr\From;
use Doctrine\ORM\QueryBuilder;
use FOS\ElasticaBundle\Provider\PagerfantaPager;
use FOS\ElasticaBundle\Provider\PagerProviderInterface;
use Pagerfanta\Adapter\DoctrineORMAdapter;
use Pagerfanta\Pagerfanta;

final class ORMPagerProvider implements PagerProviderInterface
{
    const ENTITY_ALIAS = 'a';

    /**
     * @var string
     */
    private $objectClass;

    /**
     * @var ManagerRegistry
     */
    private $doctrine;

    /**
     * @var array
     */
    private $baseOptions;

    /**
     * @var RegisterListenersService
     */
    private $registerListenersService;

    /**
     * @param ManagerRegistry $doctrine
     * @param RegisterListenersService $registerListenersService
     * @param string $objectClass
     * @param array $baseOptions
     */
    public function __construct(ManagerRegistry $doctrine, RegisterListenersService $registerListenersService, $objectClass, array $baseOptions)
    {
        $this->doctrine = $doctrine;
        $this->objectClass = $objectClass;
        $this->baseOptions = $baseOptions;
        $this->registerListenersService = $registerListenersService;
    }

    /**
     * {@inheritdoc}
     */
    public function provide(array $options = array())
    {
        $options = array_replace($this->baseOptions, $options);

        $manager = $this->doctrine->getManagerForClass($this->objectClass);
        $repository = $manager->getRepository($this->objectClass);

        $qb = \call_user_func([$repository, $options['query_builder_method']], self::ENTITY_ALIAS);

        // Ensure that the query builder has a sorting configured. Without a ORDER BY clause, the SQL standard does not
        // guarantee any order, which breaks the pagination (second page might use a different sorting that when retrieving
        // the first page).
        // If the QueryBuilder already has its own ordering, or the method returned a Query instead of a QueryBuilder, we
        // assume that the query already provides a proper sorting. This allows giving full control over sorting if wanted
        // when using a custom method.
        if ($qb instanceof QueryBuilder && empty($qb->getDQLPart('orderBy'))) {
            // When getting root aliases, the QueryBuilder normalizes all from parts to From objects, in case they were added as string using the low-level API.
            // This side-effect allows us to be sure to get only From objects in the next call.
            $qb->getRootAliases();

            /** @var From[] $fromClauses */
            $fromClauses = $qb->getDQLPart('from');

            foreach ($fromClauses as $fromClause) {
                $identifiers = $manager->getClassMetadata($fromClause->getFrom())->getIdentifierFieldNames();

                foreach ($identifiers as $identifier) {
                    $qb->addOrderBy($fromClause->getAlias().'.'.$identifier);
                }
            }
        }

        $pager = new PagerfantaPager(new Pagerfanta(new DoctrineORMAdapter($qb)));

        $this->registerListenersService->register($manager, $pager, $options);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

        return $pager;
    }
}


1		<?php
2
3		/*
4		* This file is part of the FOSElasticaBundle package.
5		*
6		* (c) FriendsOfSymfony <http://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\Doctrine;
13
14		use Doctrine\Common\Persistence\ManagerRegistry;
15		use Doctrine\ORM\Query\Expr\From;
16		use Doctrine\ORM\QueryBuilder;
17		use FOS\ElasticaBundle\Provider\PagerfantaPager;
18		use FOS\ElasticaBundle\Provider\PagerProviderInterface;
19		use Pagerfanta\Adapter\DoctrineORMAdapter;
20		use Pagerfanta\Pagerfanta;
21
22		final class ORMPagerProvider implements PagerProviderInterface
23		{
24		const ENTITY_ALIAS = 'a';
25
26		/**
27		* @var string
28		*/
29		private $objectClass;
30
31		/**
32		* @var ManagerRegistry
33		*/
34		private $doctrine;
35
36		/**
37		* @var array
38		*/
39		private $baseOptions;
40
41		/**
42		* @var RegisterListenersService
43		*/
44		private $registerListenersService;
45
46		/**
47		* @param ManagerRegistry $doctrine
48		* @param RegisterListenersService $registerListenersService
49		* @param string $objectClass
50	4	* @param array $baseOptions
51		*/
52	4	public function __construct(ManagerRegistry $doctrine, RegisterListenersService $registerListenersService, $objectClass, array $baseOptions)
53	4	{
54	4	$this->doctrine = $doctrine;
55	4	$this->objectClass = $objectClass;
56	4	$this->baseOptions = $baseOptions;
57		$this->registerListenersService = $registerListenersService;
58		}
59
60		/**
61	3	* {@inheritdoc}
62		*/
63	3	public function provide(array $options = array())
64		{
65	3	$options = array_replace($this->baseOptions, $options);
66	3
67		$manager = $this->doctrine->getManagerForClass($this->objectClass);
68	3	$repository = $manager->getRepository($this->objectClass);
69	3
70	3	$qb = \call_user_func([$repository, $options['query_builder_method']], self::ENTITY_ALIAS);
71
72		// Ensure that the query builder has a sorting configured. Without a ORDER BY clause, the SQL standard does not
73	3	// guarantee any order, which breaks the pagination (second page might use a different sorting that when retrieving
74		// the first page).
75	3	// If the QueryBuilder already has its own ordering, or the method returned a Query instead of a QueryBuilder, we
76		// assume that the query already provides a proper sorting. This allows giving full control over sorting if wanted
77		// when using a custom method.
78		if ($qb instanceof QueryBuilder && empty($qb->getDQLPart('orderBy'))) {
79		// When getting root aliases, the QueryBuilder normalizes all from parts to From objects, in case they were added as string using the low-level API.
80		// This side-effect allows us to be sure to get only From objects in the next call.
81		$qb->getRootAliases();
82
83		/** @var From[] $fromClauses */
84		$fromClauses = $qb->getDQLPart('from');
85
86		foreach ($fromClauses as $fromClause) {
87		$identifiers = $manager->getClassMetadata($fromClause->getFrom())->getIdentifierFieldNames();
88
89		foreach ($identifiers as $identifier) {
90		$qb->addOrderBy($fromClause->getAlias().'.'.$identifier);
91		}
92		}
93		}
94
95		$pager = new PagerfantaPager(new Pagerfanta(new DoctrineORMAdapter($qb)));
96
97		$this->registerListenersService->register($manager, $pager, $options);
		0 ignored issues – show Bug introduced 2017-12-08 11:22 UTC by Report Bug Copy Issue Report It seems like `$manager` defined by `$this->doctrine->getMana...ass($this->objectClass)` on line `67` can be `null`; however, `FOS\ElasticaBundle\Doctr...nersService::register()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
98
99		return $pager;
100		}
101		}
102

FriendsOfSymfony / FOSElasticaBundle

Pull Request — master (#1402)

ORMPagerProvider::provide() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like