ORMPagerProvider::provide() - Code Metrics - FriendsOfSymfony/FOSElasticaBundle - Measure and Improve Code Quality continuously with Scrutinizer

ORMPagerProvider::provide() A
last analyzed 2021-03-12 13:55 UTC

↳ Parent: ORMPagerProvider

Complexity

Conditions	5
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	6.6

Importance

Changes

Metric	Value
dl	0
loc	38
ccs	9
cts	15
cp	0.6
rs	9.0008
c	0
b	0
f	0
cc	5
nc	2
nop	1
crap	6.6

<?php

/*
 * This file is part of the FOSElasticaBundle package.
 *
 * (c) FriendsOfSymfony <https://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\ORM\Query\Expr\From;
use Doctrine\ORM\QueryBuilder;
use Doctrine\Persistence\ManagerRegistry;
use FOS\ElasticaBundle\Provider\PagerfantaPager;
use FOS\ElasticaBundle\Provider\PagerInterface;
use FOS\ElasticaBundle\Provider\PagerProviderInterface;
use Pagerfanta\Adapter\DoctrineORMAdapter;
use Pagerfanta\Pagerfanta;

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

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

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

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

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

    /**
     * @param string $objectClass
     */
    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 = []): PagerInterface
    {
        $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 <https://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\ORM\Query\Expr\From;
15		use Doctrine\ORM\QueryBuilder;
16		use Doctrine\Persistence\ManagerRegistry;
17		use FOS\ElasticaBundle\Provider\PagerfantaPager;
18		use FOS\ElasticaBundle\Provider\PagerInterface;
19		use FOS\ElasticaBundle\Provider\PagerProviderInterface;
20		use Pagerfanta\Adapter\DoctrineORMAdapter;
21		use Pagerfanta\Pagerfanta;
22
23		final class ORMPagerProvider implements PagerProviderInterface
24		{
25		public const ENTITY_ALIAS = 'a';
26
27		/**
28		* @var string
29		*/
30		private $objectClass;
31
32		/**
33		* @var ManagerRegistry
34		*/
35		private $doctrine;
36
37		/**
38		* @var array
39		*/
40		private $baseOptions;
41
42		/**
43		* @var RegisterListenersService
44		*/
45		private $registerListenersService;
46
47		/**
48		* @param string $objectClass
49		*/
50	4	public function __construct(ManagerRegistry $doctrine, RegisterListenersService $registerListenersService, $objectClass, array $baseOptions)
51		{
52	4	$this->doctrine = $doctrine;
53	4	$this->objectClass = $objectClass;
54	4	$this->baseOptions = $baseOptions;
55	4	$this->registerListenersService = $registerListenersService;
56	4	}
57
58		/**
59		* {@inheritdoc}
60		*/
61	3	public function provide(array $options = []): PagerInterface
62		{
63	3	$options = \array_replace($this->baseOptions, $options);
64
65	3	$manager = $this->doctrine->getManagerForClass($this->objectClass);
66	3	$repository = $manager->getRepository($this->objectClass);
67
68	3	$qb = \call_user_func([$repository, $options['query_builder_method']], self::ENTITY_ALIAS);
69
70		// Ensure that the query builder has a sorting configured. Without a ORDER BY clause, the SQL standard does not
71		// guarantee any order, which breaks the pagination (second page might use a different sorting that when retrieving
72		// the first page).
73		// If the QueryBuilder already has its own ordering, or the method returned a Query instead of a QueryBuilder, we
74		// assume that the query already provides a proper sorting. This allows giving full control over sorting if wanted
75		// when using a custom method.
76	3	if ($qb instanceof QueryBuilder && empty($qb->getDQLPart('orderBy'))) {
77		// 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.
78		// This side-effect allows us to be sure to get only From objects in the next call.
79		$qb->getRootAliases();
80
81		/** @var From[] $fromClauses */
82		$fromClauses = $qb->getDQLPart('from');
83
84		foreach ($fromClauses as $fromClause) {
85		$identifiers = $manager->getClassMetadata($fromClause->getFrom())->getIdentifierFieldNames();
86
87		foreach ($identifiers as $identifier) {
88		$qb->addOrderBy($fromClause->getAlias().'.'.$identifier);
89		}
90		}
91		}
92
93	3	$pager = new PagerfantaPager(new Pagerfanta(new DoctrineORMAdapter($qb)));
		0 ignored issues – show Deprecated Code introduced 2020-09-03 20:17 UTC by Report Bug Copy Issue Report The class `Pagerfanta\Adapter\DoctrineORMAdapter` has been deprecated with message: to be removed in 3.0, use the `Pagerfanta\Doctrine\ORM\QueryAdapter` from the `pagerfanta/doctrine-orm-adapter` package instead This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
94
95	3	$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 `65` 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...
96
97	3	return $pager;
98		}
99		}
100

FriendsOfSymfony / FOSElasticaBundle

ORMPagerProvider::provide() A last analyzed 2021-03-12 13:55 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ORMPagerProvider::provide() A
last analyzed 2021-03-12 13:55 UTC