ProductOption::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

ProductOption::createTranslation() A

↳ Parent: ProductOption

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\Product\Model;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Sylius\Component\Resource\Model\TimestampableTrait;
use Sylius\Component\Resource\Model\TranslatableTrait;
use Sylius\Component\Resource\Model\TranslationInterface;

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

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

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

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

    /**
     * @var Collection|ProductOptionValueInterface[]
     */
    protected $values;

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

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

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

    /**
     * {@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 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 getValues()
    {
        return $this->values;
    }

    /**
     * {@inheritdoc}
     */
    public function addValue(ProductOptionValueInterface $value)
    {
        if (!$this->hasValue($value)) {
            $value->setOption($this);
            $this->values->add($value);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function removeValue(ProductOptionValueInterface $value)
    {
        if ($this->hasValue($value)) {
            $this->values->removeElement($value);
            $value->setOption(null);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function hasValue(ProductOptionValueInterface $value)
    {
        return $this->values->contains($value);
    }

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


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\Product\Model;
13
14			use Doctrine\Common\Collections\ArrayCollection;
15			use Doctrine\Common\Collections\Collection;
16			use Sylius\Component\Resource\Model\TimestampableTrait;
17			use Sylius\Component\Resource\Model\TranslatableTrait;
18			use Sylius\Component\Resource\Model\TranslationInterface;
19
20			/**
21			* @author Paweł Jędrzejewski <[email protected]>
22			* @author Gonzalo Vilaseca <[email protected]>
23			*/
24			class ProductOption implements ProductOptionInterface
			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...
25			{
26			use TimestampableTrait;
27			use TranslatableTrait {
28			__construct as private initializeTranslationsCollection;
29			}
30
31			/**
32			* @var mixed
33			*/
34			protected $id;
35
36			/**
37			* @var string
38			*/
39			protected $code;
40
41			/**
42			* @var Collection\|ProductOptionValueInterface[]
43			*/
44			protected $values;
45
46			public function __construct()
47			{
48			$this->initializeTranslationsCollection();
49
50			$this->values = new ArrayCollection();
51			$this->createdAt = new \DateTime();
52			}
53
54			/**
55			* {@inheritdoc}
56			*/
57			public function __toString()
58			{
59			return $this->getName();
60			}
61
62			/**
63			* {@inheritdoc}
64			*/
65			public function getId()
66			{
67			return $this->id;
68			}
69
70			/**
71			* {@inheritdoc}
72			*/
73			public function getCode()
74			{
75			return $this->code;
76			}
77
78			/**
79			* {@inheritdoc}
80			*/
81			public function setCode($code)
82			{
83			$this->code = $code;
84			}
85
86			/**
87			* {@inheritdoc}
88			*/
89			public function getName()
90			{
91			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...
92			}
93
94			/**
95			* {@inheritdoc}
96			*/
97			public function setName($name)
98			{
99			$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...
100			}
101
102			/**
103			* {@inheritdoc}
104			*/
105			public function getValues()
106			{
107			return $this->values;
108			}
109
110			/**
111			* {@inheritdoc}
112			*/
113			public function addValue(ProductOptionValueInterface $value)
114			{
115			if (!$this->hasValue($value)) {
116			$value->setOption($this);
117			$this->values->add($value);
118			}
119			}
120
121			/**
122			* {@inheritdoc}
123			*/
124			public function removeValue(ProductOptionValueInterface $value)
125			{
126			if ($this->hasValue($value)) {
127			$this->values->removeElement($value);
128			$value->setOption(null);
129			}
130			}
131
132			/**
133			* {@inheritdoc}
134			*/
135			public function hasValue(ProductOptionValueInterface $value)
136			{
137			return $this->values->contains($value);
138			}
139
140			/**
141			* {@inheritdoc}
142			*/
143			protected function createTranslation()
144			{
145			return new ProductOptionTranslation();
146			}
147			}
148

pamil / Sylius

Push — translation-class ( c4acc3 )

ProductOption::createTranslation() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like