ProductVariantViewFactory::create() - Code Metrics - Inspection of "Merge pull request #209 from pamil/null-on-get-pri..." - Sylius/SyliusShopApiPlugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cbdd73...c501e5 )

by Łukasz

created 2017-09-04 10:55 UTC

ProductVariantViewFactory::create() B

↳ Parent: ProductVariantViewFactory

Complexity

Conditions	3
Paths	3

Size

Total Lines	28
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	28
rs	8.8571
c	0
b	0
f	0
cc	3
eloc	17
nc	3
nop	3

<?php

namespace Sylius\ShopApiPlugin\Factory;

use Sylius\Component\Core\Model\ChannelInterface;
use Sylius\Component\Core\Model\ProductVariantInterface;
use Sylius\ShopApiPlugin\View\ProductVariantView;

final class ProductVariantViewFactory implements ProductVariantViewFactoryInterface
{
    /** @var PriceViewFactoryInterface */
    private $priceViewFactory;

    /** @var string */
    private $productVariantViewClass;

    public function __construct(PriceViewFactoryInterface $priceViewFactory, string $productVariantViewClass)
    {
        $this->priceViewFactory = $priceViewFactory;
        $this->productVariantViewClass = $productVariantViewClass;
    }

    /**
     * {@inheritdoc}
     */
    public function create(ProductVariantInterface $variant, ChannelInterface $channel, string $locale): ProductVariantView
    {
        /** @var ProductVariantView $variantView */
        $variantView = new $this->productVariantViewClass();

        $channelPricing = $variant->getChannelPricingForChannel($channel);
        if (null === $channelPricing) {
            throw new ViewCreationException('Variant does not have pricing.');
        }

        $variantView->code = $variant->getCode();
        $variantView->name = $variant->getTranslation($locale)->getName();
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.
    }
}
        $variantView->price = $this->priceViewFactory->create(
            $channelPricing->getPrice(),
            $channel->getBaseCurrency()->getCode()
        );

        foreach ($variant->getOptionValues() as $optionValue) {
            $variantView->axis[] = $optionValue->getCode();
            $variantView->nameAxis[$optionValue->getCode()] = sprintf(
                '%s %s',
                $optionValue->getOption()->getTranslation($locale)->getName(),
                $optionValue->getTranslation($locale)->getValue()
            );
        }

        return $variantView;
    }
}


1			<?php
2
3			namespace Sylius\ShopApiPlugin\Factory;
4
5			use Sylius\Component\Core\Model\ChannelInterface;
6			use Sylius\Component\Core\Model\ProductVariantInterface;
7			use Sylius\ShopApiPlugin\View\ProductVariantView;
8
9			final class ProductVariantViewFactory implements ProductVariantViewFactoryInterface
10			{
11			/** @var PriceViewFactoryInterface */
12			private $priceViewFactory;
13
14			/** @var string */
15			private $productVariantViewClass;
16
17			public function __construct(PriceViewFactoryInterface $priceViewFactory, string $productVariantViewClass)
18			{
19			$this->priceViewFactory = $priceViewFactory;
20			$this->productVariantViewClass = $productVariantViewClass;
21			}
22
23			/**
24			* {@inheritdoc}
25			*/
26			public function create(ProductVariantInterface $variant, ChannelInterface $channel, string $locale): ProductVariantView
27			{
28			/** @var ProductVariantView $variantView */
29			$variantView = new $this->productVariantViewClass();
30
31			$channelPricing = $variant->getChannelPricingForChannel($channel);
32			if (null === $channelPricing) {
33			throw new ViewCreationException('Variant does not have pricing.');
34			}
35
36			$variantView->code = $variant->getCode();
37			$variantView->name = $variant->getTranslation($locale)->getName();
			0 ignored issues – show Bug introduced 2017-05-05 12:07 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Sylius\Component\Resourc...el\TranslationInterface` as the method `getName()` does only exist in the following implementations of said interface: `Sylius\Component\Attribu...el\AttributeTranslation`, `Sylius\Component\Core\Model\ProductTranslation`, `Sylius\Component\Payment...aymentMethodTranslation`, `Sylius\Component\Product...ociationTypeTranslation`, `Sylius\Component\Product...uctAttributeTranslation`, `Sylius\Component\Product...roductOptionTranslation`, `Sylius\Component\Product\Model\ProductTranslation`, `Sylius\Component\Product...oductVariantTranslation`, `Sylius\Component\Shippin...ippingMethodTranslation`, `Sylius\Component\Taxonomy\Model\TaxonTranslation`. 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...
38			$variantView->price = $this->priceViewFactory->create(
39			$channelPricing->getPrice(),
40			$channel->getBaseCurrency()->getCode()
41			);
42
43			foreach ($variant->getOptionValues() as $optionValue) {
44			$variantView->axis[] = $optionValue->getCode();
45			$variantView->nameAxis[$optionValue->getCode()] = sprintf(
46			'%s %s',
47			$optionValue->getOption()->getTranslation($locale)->getName(),
48			$optionValue->getTranslation($locale)->getValue()
49			);
50			}
51
52			return $variantView;
53			}
54			}
55

Sylius / SyliusShopApiPlugin

Push — master ( cbdd73...c501e5 )

ProductVariantViewFactory::create() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like