CartSetLocaleAction::ofLocale() - Code Metrics - Inspection of "feat(Localization): add setLocale action to cart,..." - commercetools/commercetools-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 81d0f4...17c567 )

by Jens

created 2016-08-05 13:44 UTC

CartSetLocaleAction::ofLocale() A

↳ Parent: CartSetLocaleAction

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	4
Ratio	100 %

Importance

Changes	1
Bugs	0	Features	1

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

<?php
/**
 * @author @jayS-de <[email protected]>
 */

namespace Commercetools\Core\Request\Carts\Command;

use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Request\AbstractAction;

/**
 * @package Commercetools\Core\Request\Carts\Command
 *
 * @method string getAction()
 * @method CartSetLocaleAction setAction(string $action = null)
 * @method string getLocale()
 */
class CartSetLocaleAction extends AbstractAction

{
    public function fieldDefinitions()
    {
        return [
            'action' => [static::TYPE => 'string'],
            'locale' => [static::TYPE => 'string'],
        ];
    }

    /**
     * @param string $locale
     * @param Context|callable $context
     * @return CartSetLocaleAction
     */
    public static function ofLocale($locale, $context = null)
    {
        return static::of($context)->setLocale($locale);
    }

    /**
     * @param array $data
     * @param Context|callable $context
     */
    public function __construct(array $data = [], $context = null)
    {
        parent::__construct($data, $context);
        $this->setAction('setLocale');
    }

    public function setLocale($locale)
    {
        $locale = \Locale::canonicalize($locale);
        parent::setLocale($locale);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}

        return $this;
    }

    /**
     * @return array
     */
    public function toJson()
    {
        $data = parent::toArray();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
        $data['locale'] = str_replace('_', '-', $data['locale']);

        return $data;
    }
}


1		<?php
2		/**
3		* @author @jayS-de <[email protected]>
4		*/
5
6		namespace Commercetools\Core\Request\Carts\Command;
7
8		use Commercetools\Core\Model\Common\Context;
9		use Commercetools\Core\Request\AbstractAction;
10
11		/**
12		* @package Commercetools\Core\Request\Carts\Command
13		*
14		* @method string getAction()
15		* @method CartSetLocaleAction setAction(string $action = null)
16		* @method string getLocale()
17		*/
18	View Code Duplication	class CartSetLocaleAction extends AbstractAction
		0 ignored issues – show Duplication introduced 2016-08-05 13:51 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
19		{
20		public function fieldDefinitions()
21		{
22		return [
23		'action' => [static::TYPE => 'string'],
24		'locale' => [static::TYPE => 'string'],
25		];
26		}
27
28		/**
29		* @param string $locale
30		* @param Context\|callable $context
31		* @return CartSetLocaleAction
32		*/
33		public static function ofLocale($locale, $context = null)
34		{
35		return static::of($context)->setLocale($locale);
36		}
37
38		/**
39		* @param array $data
40		* @param Context\|callable $context
41		*/
42		public function __construct(array $data = [], $context = null)
43		{
44		parent::__construct($data, $context);
45		$this->setAction('setLocale');
46		}
47
48		public function setLocale($locale)
49		{
50		$locale = \Locale::canonicalize($locale);
51		parent::setLocale($locale);
		0 ignored issues – show Bug introduced 2016-08-05 13:51 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Commercetools\Core\Request\AbstractAction` as the method `setLocale()` does only exist in the following sub-classes of `Commercetools\Core\Request\AbstractAction`: `Commercetools\Core\Reque...and\CartSetLocaleAction`, `Commercetools\Core\Reque...CustomerSetLocaleAction`, `Commercetools\Core\Reque...nd\OrderSetLocaleAction`, `Commercetools\Core\Reque...d\ReviewSetLocaleAction`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
52
53		return $this;
54		}
55
56		/**
57		* @return array
58		*/
59		public function toJson()
60		{
61		$data = parent::toArray();
		0 ignored issues – show Comprehensibility Bug introduced 2016-08-05 13:51 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`toArray()` instead of `toJson()`). Are you sure this is correct? If so, you might want to change this to `$this->toArray()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
62		$data['locale'] = str_replace('_', '-', $data['locale']);
63
64		return $data;
65		}
66		}
67

commercetools / commercetools-php-sdk

Push — develop ( 81d0f4...17c567 )

CartSetLocaleAction::ofLocale() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like