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

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

↳ Parent: MongoDBPagerProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	15
ccs	8
cts	8
cp	1
rs	9.7666
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?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\Persistence\ManagerRegistry;
use FOS\ElasticaBundle\Provider\PagerfantaPager;
use FOS\ElasticaBundle\Provider\PagerInterface;
use FOS\ElasticaBundle\Provider\PagerProviderInterface;
use Pagerfanta\Adapter\DoctrineODMMongoDBAdapter;
use Pagerfanta\Pagerfanta;

final class MongoDBPagerProvider implements PagerProviderInterface
{
    /**
     * @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);

        $pager = new PagerfantaPager(new Pagerfanta(
            new DoctrineODMMongoDBAdapter(\call_user_func([$repository, $options['query_builder_method']]))

        ));

        $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\Persistence\ManagerRegistry;
15		use FOS\ElasticaBundle\Provider\PagerfantaPager;
16		use FOS\ElasticaBundle\Provider\PagerInterface;
17		use FOS\ElasticaBundle\Provider\PagerProviderInterface;
18		use Pagerfanta\Adapter\DoctrineODMMongoDBAdapter;
19		use Pagerfanta\Pagerfanta;
20
21		final class MongoDBPagerProvider implements PagerProviderInterface
22		{
23		/**
24		* @var string
25		*/
26		private $objectClass;
27
28		/**
29		* @var ManagerRegistry
30		*/
31		private $doctrine;
32
33		/**
34		* @var array
35		*/
36		private $baseOptions;
37
38		/**
39		* @var RegisterListenersService
40		*/
41		private $registerListenersService;
42
43		/**
44		* @param string $objectClass
45		*/
46	4	public function __construct(ManagerRegistry $doctrine, RegisterListenersService $registerListenersService, $objectClass, array $baseOptions)
47		{
48	4	$this->doctrine = $doctrine;
49	4	$this->objectClass = $objectClass;
50	4	$this->baseOptions = $baseOptions;
51	4	$this->registerListenersService = $registerListenersService;
52	4	}
53
54		/**
55		* {@inheritdoc}
56		*/
57	3	public function provide(array $options = []): PagerInterface
58		{
59	3	$options = \array_replace($this->baseOptions, $options);
60
61	3	$manager = $this->doctrine->getManagerForClass($this->objectClass);
62	3	$repository = $manager->getRepository($this->objectClass);
63
64	3	$pager = new PagerfantaPager(new Pagerfanta(
65	3	new DoctrineODMMongoDBAdapter(\call_user_func([$repository, $options['query_builder_method']]))
		0 ignored issues – show Deprecated Code introduced 2020-09-03 20:17 UTC by Report Bug Copy Issue Report The class `Pagerfanta\Adapter\DoctrineODMMongoDBAdapter` has been deprecated with message: to be removed in 3.0, use the `Pagerfanta\Doctrine\MongoDBODM\QueryAdapter` from the `pagerfanta/doctrine-mongodb-odm-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...
66		));
67
68	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 `61` 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...
69
70	3	return $pager;
71		}
72		}
73

FriendsOfSymfony / FOSElasticaBundle

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

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

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