UserImpersonatedListener::__construct() - Code Metrics - Inspection of "Merge branch '1.0'" - Sylius/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bfa6c3...34b432 )

by Kamil

created 2017-10-10 13:13 UTC

UserImpersonatedListener::__construct() A

↳ Parent: UserImpersonatedListener

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	9
rs	9.6666
cc	1
eloc	7
nc	1
nop	3

<?php

/*
 * This file is part of the Sylius package.
 *
 * (c) Paweł Jędrzejewski
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Sylius\Bundle\ShopBundle\EventListener;

use Sylius\Bundle\UserBundle\Event\UserEvent;
use Sylius\Component\Channel\Context\ChannelContextInterface;
use Sylius\Component\Core\Model\ChannelInterface;
use Sylius\Component\Core\Model\OrderInterface;
use Sylius\Component\Core\Repository\OrderRepositoryInterface;
use Sylius\Component\Core\Storage\CartStorageInterface;

final class UserImpersonatedListener
{
    /**
     * @var CartStorageInterface
     */
    private $cartStorage;

    /**
     * @var ChannelContextInterface
     */
    private $channelContext;

    /**
     * @var OrderRepositoryInterface
     */
    private $orderRepository;

    /**
     * @param CartStorageInterface $cartStorage
     * @param ChannelContextInterface $channelContext
     * @param OrderRepositoryInterface $orderRepository
     */
    public function __construct(
        CartStorageInterface $cartStorage,
        ChannelContextInterface $channelContext,
        OrderRepositoryInterface $orderRepository
    ) {
        $this->cartStorage = $cartStorage;
        $this->channelContext = $channelContext;
        $this->orderRepository = $orderRepository;
    }

    /**
     * @param UserEvent $event
     */
    public function onUserImpersonated(UserEvent $event): void
    {
        $customer = $event->getUser()->getCustomer();
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.
    }
}

        /** @var ChannelInterface $channel */
        $channel = $this->channelContext->getChannel();

        /** @var OrderInterface $cart */
        $cart = $this->orderRepository->findLatestCartByChannelAndCustomer($channel, $customer);

        if ($cart === null) {
            $this->cartStorage->removeForChannel($channel);

            return;
        }

        $this->cartStorage->setForChannel($channel, $cart);
    }
}


1			<?php
2
3			/*
4			* This file is part of the Sylius package.
5			*
6			* (c) Paweł Jędrzejewski
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			declare(strict_types=1);
13
14			namespace Sylius\Bundle\ShopBundle\EventListener;
15
16			use Sylius\Bundle\UserBundle\Event\UserEvent;
17			use Sylius\Component\Channel\Context\ChannelContextInterface;
18			use Sylius\Component\Core\Model\ChannelInterface;
19			use Sylius\Component\Core\Model\OrderInterface;
20			use Sylius\Component\Core\Repository\OrderRepositoryInterface;
21			use Sylius\Component\Core\Storage\CartStorageInterface;
22
23			final class UserImpersonatedListener
24			{
25			/**
26			* @var CartStorageInterface
27			*/
28			private $cartStorage;
29
30			/**
31			* @var ChannelContextInterface
32			*/
33			private $channelContext;
34
35			/**
36			* @var OrderRepositoryInterface
37			*/
38			private $orderRepository;
39
40			/**
41			* @param CartStorageInterface $cartStorage
42			* @param ChannelContextInterface $channelContext
43			* @param OrderRepositoryInterface $orderRepository
44			*/
45			public function __construct(
46			CartStorageInterface $cartStorage,
47			ChannelContextInterface $channelContext,
48			OrderRepositoryInterface $orderRepository
49			) {
50			$this->cartStorage = $cartStorage;
51			$this->channelContext = $channelContext;
52			$this->orderRepository = $orderRepository;
53			}
54
55			/**
56			* @param UserEvent $event
57			*/
58			public function onUserImpersonated(UserEvent $event): void
59			{
60			$customer = $event->getUser()->getCustomer();
			0 ignored issues – show Bug introduced 2017-09-08 10:18 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Sylius\Component\User\Model\UserInterface` as the method `getCustomer()` does only exist in the following implementations of said interface: `Sylius\Component\Core\Model\ShopUser`. 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...
61
62			/** @var ChannelInterface $channel */
63			$channel = $this->channelContext->getChannel();
64
65			/** @var OrderInterface $cart */
66			$cart = $this->orderRepository->findLatestCartByChannelAndCustomer($channel, $customer);
67
68			if ($cart === null) {
69			$this->cartStorage->removeForChannel($channel);
70
71			return;
72			}
73
74			$this->cartStorage->setForChannel($channel, $cart);
75			}
76			}
77

Sylius / Sylius

Push — master ( bfa6c3...34b432 )

UserImpersonatedListener::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like