ShippingMethod::createTranslation() - Code Metrics - Inspection of "Improve TranslatableTrait" - pamil/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — translation-class ( c4acc3 )

by Kamil

created 2016-11-18 09:59 UTC

ShippingMethod::createTranslation() A

↳ Parent: ShippingMethod

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?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\Shipping\Model;

use Sylius\Component\Resource\Model\TimestampableTrait;
use Sylius\Component\Resource\Model\ToggleableTrait;
use Sylius\Component\Resource\Model\TranslatableTrait;
use Sylius\Component\Resource\Model\TranslationInterface;

/**
 * @author Paweł Jędrzejewski <[email protected]>
 * @author Gonzalo Vilaseca <[email protected]>
 */
class ShippingMethod implements ShippingMethodInterface

{
    use TimestampableTrait, ToggleableTrait;
    use TranslatableTrait {
        __construct as private initializeTranslationsCollection;
    }

    /**
     * @var mixed
     */
    protected $id;

    /**
     * @var string
     */
    protected $code;

    /**
     * @var int
     */
    protected $position;

    /**
     * @var ShippingCategoryInterface
     */
    protected $category;

    /**
     * @var int
     */
    protected $categoryRequirement = ShippingMethodInterface::CATEGORY_REQUIREMENT_MATCH_ANY;

    /**
     * @var string
     */
    protected $calculator;

    /**
     * @var array
     */
    protected $configuration = [];

    public function __construct()
    {
        $this->initializeTranslationsCollection();

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

    /**
     * {@inheritdoc}
     */
    public function __toString()

    {
        return $this->getTranslation()->__toString();
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 getId()
    {
        return $this->id;
    }

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

    /**
     * {@inheritdoc}
     */
    public function setCode($code)
    {
        $this->code = $code;
    }

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

    /**
     * {@inheritdoc}
     */
    public function setPosition($position)
    {
        $this->position = $position;
    }

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

    /**
     * {@inheritdoc}
     */
    public function setCategory(ShippingCategoryInterface $category = null)
    {
        $this->category = $category;
    }

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

    /**
     * {@inheritdoc}
     */
    public function setCategoryRequirement($categoryRequirement)
    {
        $this->categoryRequirement = $categoryRequirement;
    }

    /**
     * {@inheritdoc}
     */
    public function getCategoryRequirementLabel()
    {
        return self::getCategoryRequirementLabels()[$this->categoryRequirement];
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return $this->getTranslation()->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.
    }
}
    }

    /**
     * {@inheritdoc}
     */
    public function setName($name)
    {
        $this->getTranslation()->setName($name);
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 getDescription()
    {
        return $this->getTranslation()->getDescription();
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 setDescription($description)
    {
        $this->getTranslation()->setDescription($description);
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 getCalculator()
    {
        return $this->calculator;
    }

    /**
     * {@inheritdoc}
     */
    public function setCalculator($calculator)
    {
        $this->calculator = $calculator;
    }

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

    /**
     * {@inheritdoc}
     */
    public function setConfiguration(array $configuration)
    {
        $this->configuration = $configuration;
    }

    /**
     * @return array

     */
    public static function getCategoryRequirementLabels()
    {
        return [
            ShippingMethodInterface::CATEGORY_REQUIREMENT_MATCH_NONE => 'None of the units have to match the method category',
            ShippingMethodInterface::CATEGORY_REQUIREMENT_MATCH_ANY => 'At least 1 unit has to match the method category',
            ShippingMethodInterface::CATEGORY_REQUIREMENT_MATCH_ALL => 'All units has to match the method category',
        ];
    }

    /**
     * {@inheritdoc}
     */
    protected function createTranslation()
    {
        return new ShippingMethodTranslation();
    }

}


Push — translation-class ( c4acc3 )

ShippingMethod::createTranslation() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

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\Shipping\Model;
13
14			use Sylius\Component\Resource\Model\TimestampableTrait;
15			use Sylius\Component\Resource\Model\ToggleableTrait;
16			use Sylius\Component\Resource\Model\TranslatableTrait;
17			use Sylius\Component\Resource\Model\TranslationInterface;
18
19			/**
20			* @author Paweł Jędrzejewski <[email protected]>
21			* @author Gonzalo Vilaseca <[email protected]>
22			*/
23			class ShippingMethod implements ShippingMethodInterface
			0 ignored issues – show Bug introduced 2016-11-18 10:17 UTC by Report Bug Copy Issue Report There is at least one abstract method in this class. Maybe declare it as abstract, or implement the remaining methods: addTranslation, getTranslation, getTranslations, hasTranslation, removeTranslation, setCurrentLocale, setFallbackLocale Loading history...
24			{
25			use TimestampableTrait, ToggleableTrait;
26			use TranslatableTrait {
27			__construct as private initializeTranslationsCollection;
28			}
29
30			/**
31			* @var mixed
32			*/
33			protected $id;
34
35			/**
36			* @var string
37			*/
38			protected $code;
39
40			/**
41			* @var int
42			*/
43			protected $position;
44
45			/**
46			* @var ShippingCategoryInterface
47			*/
48			protected $category;
49
50			/**
51			* @var int
52			*/
53			protected $categoryRequirement = ShippingMethodInterface::CATEGORY_REQUIREMENT_MATCH_ANY;
54
55			/**
56			* @var string
57			*/
58			protected $calculator;
59
60			/**
61			* @var array
62			*/
63			protected $configuration = [];
64
65			public function __construct()
66			{
67			$this->initializeTranslationsCollection();
68
69			$this->createdAt = new \DateTime();
70			}
71
72			/**
73			* {@inheritdoc}
74			*/
75			public function __toString()
			0 ignored issues – show Documentation introduced 2016-06-24 14:31 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
76			{
77			return $this->getTranslation()->__toString();
			0 ignored issues – show Bug introduced 2016-11-18 10:17 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 `__toString()` does only exist in the following implementations of said interface: `Sylius\Component\Payment...aymentMethodTranslation`, `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...
78			}
79
80			/**
81			* {@inheritdoc}
82			*/
83			public function getId()
84			{
85			return $this->id;
86			}
87
88			/**
89			* {@inheritdoc}
90			*/
91			public function getCode()
92			{
93			return $this->code;
94			}
95
96			/**
97			* {@inheritdoc}
98			*/
99			public function setCode($code)
100			{
101			$this->code = $code;
102			}
103
104			/**
105			* {@inheritdoc}
106			*/
107			public function getPosition()
108			{
109			return $this->position;
110			}
111
112			/**
113			* {@inheritdoc}
114			*/
115			public function setPosition($position)
116			{
117			$this->position = $position;
118			}
119
120			/**
121			* {@inheritdoc}
122			*/
123			public function getCategory()
124			{
125			return $this->category;
126			}
127
128			/**
129			* {@inheritdoc}
130			*/
131			public function setCategory(ShippingCategoryInterface $category = null)
132			{
133			$this->category = $category;
134			}
135
136			/**
137			* {@inheritdoc}
138			*/
139			public function getCategoryRequirement()
140			{
141			return $this->categoryRequirement;
142			}
143
144			/**
145			* {@inheritdoc}
146			*/
147			public function setCategoryRequirement($categoryRequirement)
148			{
149			$this->categoryRequirement = $categoryRequirement;
150			}
151
152			/**
153			* {@inheritdoc}
154			*/
155			public function getCategoryRequirementLabel()
156			{
157			return self::getCategoryRequirementLabels()[$this->categoryRequirement];
158			}
159
160			/**
161			* {@inheritdoc}
162			*/
163			public function getName()
164			{
165			return $this->getTranslation()->getName();
			0 ignored issues – show Bug introduced 2016-11-18 10:17 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...uctAttributeTranslation`, `Sylius\Component\Product...roductOptionTranslation`, `Sylius\Component\Product\Model\ProductTranslation`, `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...
166			}
167
168			/**
169			* {@inheritdoc}
170			*/
171			public function setName($name)
172			{
173			$this->getTranslation()->setName($name);
			0 ignored issues – show Bug introduced 2016-11-18 10:17 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 `setName()` 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...uctAttributeTranslation`, `Sylius\Component\Product...roductOptionTranslation`, `Sylius\Component\Product\Model\ProductTranslation`, `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...
174			}
175
176			/**
177			* {@inheritdoc}
178			*/
179			public function getDescription()
180			{
181			return $this->getTranslation()->getDescription();
			0 ignored issues – show Bug introduced 2016-11-18 10:17 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 `getDescription()` does only exist in the following implementations of said interface: `Sylius\Component\Core\Model\ProductTranslation`, `Sylius\Component\Payment...aymentMethodTranslation`, `Sylius\Component\Product\Model\ProductTranslation`, `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...
182			}
183
184			/**
185			* {@inheritdoc}
186			*/
187			public function setDescription($description)
188			{
189			$this->getTranslation()->setDescription($description);
			0 ignored issues – show Bug introduced 2016-11-18 10:17 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 `setDescription()` does only exist in the following implementations of said interface: `Sylius\Component\Core\Model\ProductTranslation`, `Sylius\Component\Payment...aymentMethodTranslation`, `Sylius\Component\Product\Model\ProductTranslation`, `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...
190			}
191
192			/**
193			* {@inheritdoc}
194			*/
195			public function getCalculator()
196			{
197			return $this->calculator;
198			}
199
200			/**
201			* {@inheritdoc}
202			*/
203			public function setCalculator($calculator)
204			{
205			$this->calculator = $calculator;
206			}
207
208			/**
209			* {@inheritdoc}
210			*/
211			public function getConfiguration()
212			{
213			return $this->configuration;
214			}
215
216			/**
217			* {@inheritdoc}
218			*/
219			public function setConfiguration(array $configuration)
220			{
221			$this->configuration = $configuration;
222			}
223
224			/**
225			* @return array
			0 ignored issues – show Documentation introduced 2016-06-24 14:31 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<*,string>`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
226			*/
227			public static function getCategoryRequirementLabels()
228			{
229			return [
230			ShippingMethodInterface::CATEGORY_REQUIREMENT_MATCH_NONE => 'None of the units have to match the method category',
231			ShippingMethodInterface::CATEGORY_REQUIREMENT_MATCH_ANY => 'At least 1 unit has to match the method category',
232			ShippingMethodInterface::CATEGORY_REQUIREMENT_MATCH_ALL => 'All units has to match the method category',
233			];
234			}
235
236			/**
237			* {@inheritdoc}
238			*/
239			protected function createTranslation()
240			{
241			return new ShippingMethodTranslation();
242			}
243
244			}
245

pamil / Sylius

Push — translation-class ( c4acc3 )

ShippingMethod::createTranslation() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like