InPlacePagerPersister::__construct() - Code Metrics - Inspection of "fixes deprecation warning of Symfony 4.3." - FriendsOfSymfony/FOSElasticaBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1570)

unknown

created 2019-11-30 09:20 UTC

InPlacePagerPersister::__construct() A

↳ Parent: InPlacePagerPersister

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	9
Ratio	100 %

Code Coverage

Tests	5
CRAP Score	2.0185

Importance

Changes

Metric	Value
dl	9
loc	9
ccs	5
cts	6
cp	0.8333
rs	9.9666
c	0
b	0
f	0
cc	2
nc	2
nop	2
crap	2.0185

<?php

namespace FOS\ElasticaBundle\Persister;

use FOS\ElasticaBundle\Persister\Event\Events;
use FOS\ElasticaBundle\Persister\Event\OnExceptionEvent;
use FOS\ElasticaBundle\Persister\Event\PostInsertObjectsEvent;
use FOS\ElasticaBundle\Persister\Event\PostPersistEvent;
use FOS\ElasticaBundle\Persister\Event\PreFetchObjectsEvent;
use FOS\ElasticaBundle\Persister\Event\PreInsertObjectsEvent;
use FOS\ElasticaBundle\Persister\Event\PrePersistEvent;
use FOS\ElasticaBundle\Provider\PagerInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;

final class InPlacePagerPersister implements PagerPersisterInterface
{
    const NAME = 'in_place';
    
    /**
     * @var PersisterRegistry
     */
    private $registry;
    
    /**
     * @var EventDispatcherInterface
     */
    private $dispatcher;

    /**
     * @param PersisterRegistry $registry
     * @param EventDispatcherInterface $dispatcher
     */
    public function __construct(PersisterRegistry $registry, EventDispatcherInterface $dispatcher)
    {
        $this->registry = $registry;
        $this->dispatcher = $dispatcher;

        if (class_exists(LegacyEventDispatcherProxy::class)) {
            $this->dispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function insert(PagerInterface $pager, array $options = array())
    {
        $pager->setMaxPerPage(empty($options['max_per_page']) ? 100 : $options['max_per_page']);

        $options = array_replace([
            'max_per_page' => $pager->getMaxPerPage(),
            'first_page' => $pager->getCurrentPage(),
            'last_page' => $pager->getNbPages(),
        ], $options);

        $pager->setCurrentPage($options['first_page']);

        $objectPersister = $this->registry->getPersister($options['indexName'], $options['typeName']);

        try {
            $event = new PrePersistEvent($pager, $objectPersister, $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);
    }
}
            $this->dispatcher->dispatch(Events::PRE_PERSIST, $event);
            $pager = $event->getPager();
            $options = $event->getOptions();

            $lastPage = min($options['last_page'], $pager->getNbPages());
            $page = $pager->getCurrentPage();
            do {
                $pager->setCurrentPage($page);

                $this->insertPage($page, $pager, $objectPersister, $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);
    }
}

                $page++;
            } while ($page <= $lastPage);
        } finally {
            $event = new PostPersistEvent($pager, $objectPersister, $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);
    }
}
            $this->dispatcher->dispatch(Events::POST_PERSIST, $event);
        }
    }

    /**
     * @param int $page
     * @param PagerInterface $pager
     * @param ObjectPersisterInterface $objectPersister
     * @param array $options
     *
     * @throws \Exception
     */
    private function insertPage($page, PagerInterface $pager, ObjectPersisterInterface $objectPersister, array $options = array())
    {
        $pager->setCurrentPage($page);

        $event = new PreFetchObjectsEvent($pager, $objectPersister, $options);
        $this->dispatcher->dispatch(Events::PRE_FETCH_OBJECTS, $event);
        $pager = $event->getPager();
        $options = $event->getOptions();

        $objects = $pager->getCurrentPageResults();

        if ($objects instanceof \Traversable) {
            $objects = iterator_to_array($objects);
        }

        $event = new PreInsertObjectsEvent($pager, $objectPersister, $objects, $options);
        $this->dispatcher->dispatch(Events::PRE_INSERT_OBJECTS, $event);
        $pager = $event->getPager();
        $options = $event->getOptions();
        $objects = $event->getObjects();

        try {
            if (!empty($objects)) {
                $objectPersister->insertMany($objects);
            }

            $event = new PostInsertObjectsEvent($pager, $objectPersister, $objects, $options);
            $this->dispatcher->dispatch(Events::POST_INSERT_OBJECTS, $event);
        } catch (\Exception $e) {
            $event = new OnExceptionEvent($pager, $objectPersister, $e, $objects, $options);
            $this->dispatcher->dispatch(Events::ON_EXCEPTION, $event);

            if ($event->isIgnored()) {
                $event = new PostInsertObjectsEvent($pager, $objectPersister, $objects, $options);
                $this->dispatcher->dispatch(Events::POST_INSERT_OBJECTS, $event);
            } else {
                $e = $event->getException();

                throw $e;
            }
        }
    }

}


1			<?php
2
3			namespace FOS\ElasticaBundle\Persister;
4
5			use FOS\ElasticaBundle\Persister\Event\Events;
6			use FOS\ElasticaBundle\Persister\Event\OnExceptionEvent;
7			use FOS\ElasticaBundle\Persister\Event\PostInsertObjectsEvent;
8			use FOS\ElasticaBundle\Persister\Event\PostPersistEvent;
9			use FOS\ElasticaBundle\Persister\Event\PreFetchObjectsEvent;
10			use FOS\ElasticaBundle\Persister\Event\PreInsertObjectsEvent;
11			use FOS\ElasticaBundle\Persister\Event\PrePersistEvent;
12			use FOS\ElasticaBundle\Provider\PagerInterface;
13			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
14			use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
15
16			final class InPlacePagerPersister implements PagerPersisterInterface
17			{
18			const NAME = 'in_place';
19
20			/**
21			* @var PersisterRegistry
22			*/
23			private $registry;
24
25			/**
26			* @var EventDispatcherInterface
27			*/
28			private $dispatcher;
29
30			/**
31			* @param PersisterRegistry $registry
32			* @param EventDispatcherInterface $dispatcher
33			*/
34	11	View Code Duplication	public function __construct(PersisterRegistry $registry, EventDispatcherInterface $dispatcher)
35			{
36	11		$this->registry = $registry;
37	11		$this->dispatcher = $dispatcher;
38
39	11		if (class_exists(LegacyEventDispatcherProxy::class)) {
40			$this->dispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);
41			}
42	11		}
43
44			/**
45			* {@inheritdoc}
46			*/
47	10		public function insert(PagerInterface $pager, array $options = array())
48			{
49	10		$pager->setMaxPerPage(empty($options['max_per_page']) ? 100 : $options['max_per_page']);
50
51	10		$options = array_replace([
52	10		'max_per_page' => $pager->getMaxPerPage(),
53	10		'first_page' => $pager->getCurrentPage(),
54	10		'last_page' => $pager->getNbPages(),
55			], $options);
56
57	10		$pager->setCurrentPage($options['first_page']);
58
59	10		$objectPersister = $this->registry->getPersister($options['indexName'], $options['typeName']);
60
61			try {
62	10		$event = new PrePersistEvent($pager, $objectPersister, $options);
			0 ignored issues – show Bug introduced 2019-09-10 14:20 UTC by Report Bug Copy Issue Report It seems like `$objectPersister` defined by `$this->registry->getPers..., $options['typeName'])` on line `59` can be `null`; however, `FOS\ElasticaBundle\Persi...istEvent::__construct()` 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...
63	10		$this->dispatcher->dispatch(Events::PRE_PERSIST, $event);
64	10		$pager = $event->getPager();
65	10		$options = $event->getOptions();
66
67	10		$lastPage = min($options['last_page'], $pager->getNbPages());
68	10		$page = $pager->getCurrentPage();
69			do {
70	10		$pager->setCurrentPage($page);
71
72	10		$this->insertPage($page, $pager, $objectPersister, $options);
			0 ignored issues – show Bug introduced 2019-09-10 14:20 UTC by Report Bug Copy Issue Report It seems like `$objectPersister` defined by `$this->registry->getPers..., $options['typeName'])` on line `59` can be `null`; however, `FOS\ElasticaBundle\Persi...Persister::insertPage()` 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...
73
74	9		$page++;
75	9		} while ($page <= $lastPage);
76	9		} finally {
77	10		$event = new PostPersistEvent($pager, $objectPersister, $options);
			0 ignored issues – show Bug introduced 2019-09-10 14:20 UTC by Report Bug Copy Issue Report It seems like `$objectPersister` defined by `$this->registry->getPers..., $options['typeName'])` on line `59` can be `null`; however, `FOS\ElasticaBundle\Persi...istEvent::__construct()` 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...
78	10		$this->dispatcher->dispatch(Events::POST_PERSIST, $event);
79			}
80	9		}
81
82			/**
83			* @param int $page
84			* @param PagerInterface $pager
85			* @param ObjectPersisterInterface $objectPersister
86			* @param array $options
87			*
88			* @throws \Exception
89			*/
90	10		private function insertPage($page, PagerInterface $pager, ObjectPersisterInterface $objectPersister, array $options = array())
91			{
92	10		$pager->setCurrentPage($page);
93
94	10		$event = new PreFetchObjectsEvent($pager, $objectPersister, $options);
95	10		$this->dispatcher->dispatch(Events::PRE_FETCH_OBJECTS, $event);
96	10		$pager = $event->getPager();
97	10		$options = $event->getOptions();
98
99	10		$objects = $pager->getCurrentPageResults();
100
101	10		if ($objects instanceof \Traversable) {
102			$objects = iterator_to_array($objects);
103			}
104
105	10		$event = new PreInsertObjectsEvent($pager, $objectPersister, $objects, $options);
106	10		$this->dispatcher->dispatch(Events::PRE_INSERT_OBJECTS, $event);
107	10		$pager = $event->getPager();
108	10		$options = $event->getOptions();
109	10		$objects = $event->getObjects();
110
111			try {
112	10		if (!empty($objects)) {
113	10		$objectPersister->insertMany($objects);
114			}
115
116	8		$event = new PostInsertObjectsEvent($pager, $objectPersister, $objects, $options);
117	8		$this->dispatcher->dispatch(Events::POST_INSERT_OBJECTS, $event);
118	2		} catch (\Exception $e) {
119	2		$event = new OnExceptionEvent($pager, $objectPersister, $e, $objects, $options);
120	2		$this->dispatcher->dispatch(Events::ON_EXCEPTION, $event);
121
122	2		if ($event->isIgnored()) {
123	1		$event = new PostInsertObjectsEvent($pager, $objectPersister, $objects, $options);
124	1		$this->dispatcher->dispatch(Events::POST_INSERT_OBJECTS, $event);
125			} else {
126	1		$e = $event->getException();
127
128	1		throw $e;
129			}
130			}
131	9		}
132
133			}
134

FriendsOfSymfony / FOSElasticaBundle

Pull Request — master (#1570)

InPlacePagerPersister::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like