MongoDBPagerProvider::provide() - Code Metrics - Inspection of "fix "Notice: Undefined index: indexName in InPlace..." - FriendsOfSymfony/FOSElasticaBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3cdfc2...4aa078 )

by Maksim

created 2017-12-12 10:51 UTC

MongoDBPagerProvider::provide() A

↳ Parent: MongoDBPagerProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines	15
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?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 FOS\ElasticaBundle\Provider\PagerfantaPager;
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 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);

        $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 <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 FOS\ElasticaBundle\Provider\PagerfantaPager;
16			use FOS\ElasticaBundle\Provider\PagerProviderInterface;
17			use Pagerfanta\Adapter\DoctrineODMMongoDBAdapter;
18			use Pagerfanta\Pagerfanta;
19
20			final class MongoDBPagerProvider implements PagerProviderInterface
21			{
22			/**
23			* @var string
24			*/
25			private $objectClass;
26
27			/**
28			* @var ManagerRegistry
29			*/
30			private $doctrine;
31
32			/**
33			* @var array
34			*/
35			private $baseOptions;
36
37			/**
38			* @var RegisterListenersService
39			*/
40			private $registerListenersService;
41
42			/**
43			* @param ManagerRegistry $doctrine
44			* @param RegisterListenersService $registerListenersService
45			* @param string $objectClass
46			* @param array $baseOptions
47			*/
48			public function __construct(ManagerRegistry $doctrine, RegisterListenersService $registerListenersService, $objectClass, array $baseOptions)
49			{
50			$this->doctrine = $doctrine;
51			$this->objectClass = $objectClass;
52			$this->baseOptions = $baseOptions;
53			$this->registerListenersService = $registerListenersService;
54			}
55
56			/**
57			* {@inheritdoc}
58			*/
59			public function provide(array $options = array())
60			{
61			$options = array_replace($this->baseOptions, $options);
62
63			$manager = $this->doctrine->getManagerForClass($this->objectClass);
64			$repository = $manager->getRepository($this->objectClass);
65
66			$pager = new PagerfantaPager(new Pagerfanta(
67			new DoctrineODMMongoDBAdapter(call_user_func([$repository, $options['query_builder_method']]))
68			));
69
70			$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 `63` 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...
71
72			return $pager;
73			}
74			}
75

FriendsOfSymfony / FOSElasticaBundle

Push — master ( 3cdfc2...4aa078 )

MongoDBPagerProvider::provide() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like