DoctrineBackendOptimizeListener::iterate() - Code Metrics - Inspection of "DevKit updates" - sonata-project/SonataNotificationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.x-dev-kit ( 8d77e1 )

unknown

created 2016-05-23 18:42 UTC

DoctrineBackendOptimizeListener::iterate() A

↳ Parent: DoctrineBackendOptimizeListener

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	10
rs	9.4285
cc	3
eloc	5
nc	3
nop	1

<?php

/*
 * This file is part of the Sonata project.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\NotificationBundle\Event;

use Doctrine\Bundle\DoctrineBundle\Registry;
use Symfony\Bridge\Doctrine\RegistryInterface;

/**
 * Doctrine context optimizer
 * Used with doctrine backend to clear context taking care of the batch iterations.
 *
 * @author Kevin Nedelec <[email protected]>
 *
 * Class DoctrineOptimizeListener
 */
class DoctrineBackendOptimizeListener implements IterationListener
{
    /**
     * @var Registry
     */
    protected $doctrine;

    /**
     * @param RegistryInterface $doctrine
     */
    public function __construct(RegistryInterface $doctrine)
    {
        $this->doctrine = $doctrine;

    }

    /**
     * {@inheritdoc}
     */
    public function iterate(IterateEvent $event)
    {
        if (!method_exists($event->getIterator(), 'isBufferEmpty')) {
            throw new \LogicException('You can\'t use DoctrineOptimizeListener with this iterator');
        }

        if ($event->getIterator()->isBufferEmpty()) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $this->doctrine->getManager()->getUnitOfWork()->clear();
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the Sonata project.
5			*
6			* (c) Thomas Rabaix <[email protected]>
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 Sonata\NotificationBundle\Event;
13
14			use Doctrine\Bundle\DoctrineBundle\Registry;
15			use Symfony\Bridge\Doctrine\RegistryInterface;
16
17			/**
18			* Doctrine context optimizer
19			* Used with doctrine backend to clear context taking care of the batch iterations.
20			*
21			* @author Kevin Nedelec <[email protected]>
22			*
23			* Class DoctrineOptimizeListener
24			*/
25			class DoctrineBackendOptimizeListener implements IterationListener
26			{
27			/**
28			* @var Registry
29			*/
30			protected $doctrine;
31
32			/**
33			* @param RegistryInterface $doctrine
34			*/
35			public function __construct(RegistryInterface $doctrine)
36			{
37			$this->doctrine = $doctrine;
			0 ignored issues – show Documentation Bug introduced 2015-11-22 19:11 UTC by Report Bug Copy Issue Report It seems like `$doctrine` of type `object<Symfony\Bridge\Doctrine\RegistryInterface>` is incompatible with the declared type `object<Doctrine\Bundle\DoctrineBundle\Registry>` of property `$doctrine`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
38			}
39
40			/**
41			* {@inheritdoc}
42			*/
43			public function iterate(IterateEvent $event)
44			{
45			if (!method_exists($event->getIterator(), 'isBufferEmpty')) {
46			throw new \LogicException('You can\'t use DoctrineOptimizeListener with this iterator');
47			}
48
49			if ($event->getIterator()->isBufferEmpty()) {
			0 ignored issues – show Bug introduced 2015-11-22 19:11 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Sonata\NotificationBundl...essageIteratorInterface` as the method `isBufferEmpty()` does only exist in the following implementations of said interface: `Sonata\NotificationBundl...rroneousMessageIterator`, `Sonata\NotificationBundl...eManagerMessageIterator`, `Sonata\NotificationBundl...eManagerMessageIterator`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
50			$this->doctrine->getManager()->getUnitOfWork()->clear();
51			}
52			}
53			}
54

sonata-project / SonataNotificationBundle

Push — 2.x-dev-kit ( 8d77e1 )

DoctrineBackendOptimizeListener::iterate() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like