Issues in OrderItemUnit.php - Fixed Issues - Inspection of "Merge pull request #5057 from michalmarcinkowski/i..." - Sylius/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fd86aa...d435ff )

by Paweł

created 2016-05-18 20:06 UTC

src/Sylius/Component/Core/Model/OrderItemUnit.php (2 issues)

Labels

Bug 2

Severity

Minor 2

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?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.
 */

namespace Sylius\Component\Core\Model;

use Sylius\Component\Inventory\Model\InventoryUnitInterface;
use Sylius\Component\Order\Model\OrderItemUnit as BaseOrderItemUnit;
use Sylius\Component\Shipping\Model\ShipmentInterface as BaseShipmentInterface;

/**
 * @author Mateusz Zalewski <[email protected]>
 */
class OrderItemUnit extends BaseOrderItemUnit implements OrderItemUnitInterface
{
    /**
     * @var string InventoryUnitInterface::STATE_*
     */
    protected $inventoryState = InventoryUnitInterface::STATE_CHECKOUT;

    /**
     * @var BaseShipmentInterface
     */
    protected $shipment;

    /**
     * @var string BaseShipmentInterface::STATE_*
     */
    protected $shippingState = BaseShipmentInterface::STATE_CHECKOUT;

    /**
     * @var \DateTime
     */
    protected $createdAt;

    /**
     * @var \DateTime
     */
    protected $updatedAt;

    /**
     * @param OrderItemInterface $orderItem
     */
    public function __construct(OrderItemInterface $orderItem)
    {
        parent::__construct($orderItem);

        $this->createdAt = new \DateTime();
    }

    /**
     * {@inheritdoc}
     */
    public function getStockable()
    {
        return $this->orderItem->getVariant();
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.
    }
}
    }

    /**
     * {@inheritdoc}
     */
    public function getInventoryName()
    {
        return $this->orderItem->getVariant()->getInventoryName();
    }

    /**
     * {@inheritdoc}
     */
    public function getInventoryState()
    {
        return $this->inventoryState;
    }

    /**
     * {@inheritdoc}
     */
    public function setInventoryState($state)
    {
        $this->inventoryState = $state;
    }

    /**
     * {@inheritdoc}
     */
    public function isSold()
    {
        return InventoryUnitInterface::STATE_SOLD === $this->inventoryState;
    }

    /**
     * {@inheritdoc}
     */
    public function isBackordered()
    {
        return InventoryUnitInterface::STATE_BACKORDERED === $this->inventoryState;
    }

    /**
     * {@inheritdoc}
     */
    public function getShipment()
    {
        return $this->shipment;
    }

    /**
     * {@inheritdoc}
     */
    public function setShipment(BaseShipmentInterface $shipment = null)
    {
        $this->shipment = $shipment;
    }

    /**
     * {@inheritdoc}
     */
    public function getShippable()
    {
        return $this->orderItem->getVariant();
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.
    }
}
    }

    /**
     * {@inheritdoc}
     */
    public function getShippingState()
    {
        return $this->shippingState;
    }

    /**
     * {@inheritdoc}
     */
    public function setShippingState($state)
    {
        $this->shippingState = $state;
    }

    /**
     * {@inheritdoc}
     */
    public function getCreatedAt()
    {
        return $this->createdAt;
    }

    /**
     * {@inheritdoc}
     */
    public function setCreatedAt(\DateTime $createdAt)
    {
        $this->createdAt = $createdAt;
    }

    /**
     * {@inheritdoc}
     */
    public function getUpdatedAt()
    {
        return $this->updatedAt;
    }

    /**
     * {@inheritdoc}
     */
    public function setUpdatedAt(\DateTime $updatedAt)
    {
        $this->updatedAt = $updatedAt;
    }
}


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			namespace Sylius\Component\Core\Model;
13
14			use Sylius\Component\Inventory\Model\InventoryUnitInterface;
15			use Sylius\Component\Order\Model\OrderItemUnit as BaseOrderItemUnit;
16			use Sylius\Component\Shipping\Model\ShipmentInterface as BaseShipmentInterface;
17
18			/**
19			* @author Mateusz Zalewski <[email protected]>
20			*/
21			class OrderItemUnit extends BaseOrderItemUnit implements OrderItemUnitInterface
22			{
23			/**
24			* @var string InventoryUnitInterface::STATE_*
25			*/
26			protected $inventoryState = InventoryUnitInterface::STATE_CHECKOUT;
27
28			/**
29			* @var BaseShipmentInterface
30			*/
31			protected $shipment;
32
33			/**
34			* @var string BaseShipmentInterface::STATE_*
35			*/
36			protected $shippingState = BaseShipmentInterface::STATE_CHECKOUT;
37
38			/**
39			* @var \DateTime
40			*/
41			protected $createdAt;
42
43			/**
44			* @var \DateTime
45			*/
46			protected $updatedAt;
47
48			/**
49			* @param OrderItemInterface $orderItem
50			*/
51			public function __construct(OrderItemInterface $orderItem)
52			{
53			parent::__construct($orderItem);
54
55			$this->createdAt = new \DateTime();
56			}
57
58			/**
59			* {@inheritdoc}
60			*/
61			public function getStockable()
62			{
63			return $this->orderItem->getVariant();
			0 ignored issues – show Bug introduced 2016-01-24 10:01 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `Sylius\Component\Order\Model\OrderItemInterface` as the method `getVariant()` does only exist in the following implementations of said interface: `Sylius\Component\Core\Model\OrderItem`. 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...
64			}
65
66			/**
67			* {@inheritdoc}
68			*/
69			public function getInventoryName()
70			{
71			return $this->orderItem->getVariant()->getInventoryName();
72			}
73
74			/**
75			* {@inheritdoc}
76			*/
77			public function getInventoryState()
78			{
79			return $this->inventoryState;
80			}
81
82			/**
83			* {@inheritdoc}
84			*/
85			public function setInventoryState($state)
86			{
87			$this->inventoryState = $state;
88			}
89
90			/**
91			* {@inheritdoc}
92			*/
93			public function isSold()
94			{
95			return InventoryUnitInterface::STATE_SOLD === $this->inventoryState;
96			}
97
98			/**
99			* {@inheritdoc}
100			*/
101			public function isBackordered()
102			{
103			return InventoryUnitInterface::STATE_BACKORDERED === $this->inventoryState;
104			}
105
106			/**
107			* {@inheritdoc}
108			*/
109			public function getShipment()
110			{
111			return $this->shipment;
112			}
113
114			/**
115			* {@inheritdoc}
116			*/
117			public function setShipment(BaseShipmentInterface $shipment = null)
118			{
119			$this->shipment = $shipment;
120			}
121
122			/**
123			* {@inheritdoc}
124			*/
125			public function getShippable()
126			{
127			return $this->orderItem->getVariant();
			0 ignored issues – show Bug introduced 2016-01-24 10:01 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `Sylius\Component\Order\Model\OrderItemInterface` as the method `getVariant()` does only exist in the following implementations of said interface: `Sylius\Component\Core\Model\OrderItem`. 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...
128			}
129
130			/**
131			* {@inheritdoc}
132			*/
133			public function getShippingState()
134			{
135			return $this->shippingState;
136			}
137
138			/**
139			* {@inheritdoc}
140			*/
141			public function setShippingState($state)
142			{
143			$this->shippingState = $state;
144			}
145
146			/**
147			* {@inheritdoc}
148			*/
149			public function getCreatedAt()
150			{
151			return $this->createdAt;
152			}
153
154			/**
155			* {@inheritdoc}
156			*/
157			public function setCreatedAt(\DateTime $createdAt)
158			{
159			$this->createdAt = $createdAt;
160			}
161
162			/**
163			* {@inheritdoc}
164			*/
165			public function getUpdatedAt()
166			{
167			return $this->updatedAt;
168			}
169
170			/**
171			* {@inheritdoc}
172			*/
173			public function setUpdatedAt(\DateTime $updatedAt)
174			{
175			$this->updatedAt = $updatedAt;
176			}
177			}
178

Sylius / Sylius

Push — master ( fd86aa...d435ff )

src/Sylius/Component/Core/Model/OrderItemUnit.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like