ProductVariantViewFactory::create() - Code Metrics - Inspection of "[Product] [Cart] Change price contract" - Sylius/SyliusShopApiPlugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#77)

by Łukasz

created 2017-05-08 07:42 UTC

ProductVariantViewFactory::create() A

↳ Parent: ProductVariantViewFactory

Complexity

Conditions	2
Paths	2

Size

Total Lines	19
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	12
nc	2
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;

    /**
     * @param PriceViewFactoryInterface $priceViewFactory
     */
    public function __construct(PriceViewFactoryInterface $priceViewFactory)
    {
        $this->priceViewFactory = $priceViewFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function create(ProductVariantInterface $variant, ChannelInterface $channel, $locale)
    {
        $variantView = new ProductVariantView();

        $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($variant->getChannelPricingForChannel($channel)->getPrice());

        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			/**
12			* @var PriceViewFactoryInterface
13			*/
14			private $priceViewFactory;
15
16			/**
17			* @param PriceViewFactoryInterface $priceViewFactory
18			*/
19			public function __construct(PriceViewFactoryInterface $priceViewFactory)
20			{
21			$this->priceViewFactory = $priceViewFactory;
22			}
23
24			/**
25			* {@inheritdoc}
26			*/
27			public function create(ProductVariantInterface $variant, ChannelInterface $channel, $locale)
28			{
29			$variantView = new ProductVariantView();
30
31			$variantView->code = $variant->getCode();
32			$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...
33			$variantView->price = $this->priceViewFactory->create($variant->getChannelPricingForChannel($channel)->getPrice());
34
35			foreach ($variant->getOptionValues() as $optionValue) {
36			$variantView->axis[] = $optionValue->getCode();
37			$variantView->nameAxis[$optionValue->getCode()] = sprintf(
38			'%s %s',
39			$optionValue->getOption()->getTranslation($locale)->getName(),
40			$optionValue->getTranslation($locale)->getValue()
41			);
42			}
43
44			return $variantView;
45			}
46			}
47

Sylius / SyliusShopApiPlugin

Pull Request — master (#77)

ProductVariantViewFactory::create() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like