Issues in ORMPagerProvider.php - New Issues - Inspection of "Merge branch '4.0.x'" - FriendsOfSymfony/FOSElasticaBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0aa154...6fc129 )

by Maksim

created 2017-12-08 11:16 UTC

Doctrine/ORMPagerProvider.php (1 issue)

Labels

Bug 1

Severity

Minor 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?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\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);

        $pager = new PagerfantaPager(new Pagerfanta(new DoctrineORMAdapter(call_user_func(
            [$repository, $options['query_builder_method']],
            self::ENTITY_ALIAS
        ))));

        $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\DoctrineORMAdapter;
18			use Pagerfanta\Pagerfanta;
19
20		View Code Duplication	final class ORMPagerProvider implements PagerProviderInterface
21			{
22			const ENTITY_ALIAS = 'a';
23
24			/**
25			* @var string
26			*/
27			private $objectClass;
28
29			/**
30			* @var ManagerRegistry
31			*/
32			private $doctrine;
33
34			/**
35			* @var array
36			*/
37			private $baseOptions;
38
39			/**
40			* @var RegisterListenersService
41			*/
42			private $registerListenersService;
43
44			/**
45			* @param ManagerRegistry $doctrine
46			* @param RegisterListenersService $registerListenersService
47			* @param string $objectClass
48			* @param array $baseOptions
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 = array())
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		$pager = new PagerfantaPager(new Pagerfanta(new DoctrineORMAdapter(call_user_func(
69	3		[$repository, $options['query_builder_method']],
70	3		self::ENTITY_ALIAS
71			))));
72
73	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 Show Similar Issues like this 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...
74
75	3		return $pager;
76			}
77			}
78

FriendsOfSymfony / FOSElasticaBundle

Push — master ( 0aa154...6fc129 )

Doctrine/ORMPagerProvider.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like