UrlKeyObserver - Code Metrics - Inspection of "Remove functionality to make given URL keys unique..." - techdivision/import-product - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 19.x ( bfbe2b...654634 )

by Tim

created 2020-03-09 12:46 UTC

UrlKeyObserver A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	13
lcom	1
cbo	5
dl	0
loc	152
ccs	0
cts	58
cp	0
rs	10
c	0
b	0
f	0

8 Methods

Rating	Name	Size	Complexity
A	__construct()	9	1
A	getProductBunchProcessor()	4	1
A	process()	35	5
A	setIds()	4	2
A	setLastEntityId()	4	1
A	loadProduct()	4	1
A	getUrlKeyUtil()	4	1
A	makeUnique()	4	1

<?php

/**
 * TechDivision\Import\Product\Observers\UrlKeyObserver
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-product
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Observers;

use Zend\Filter\FilterInterface;
use TechDivision\Import\Utils\StoreViewCodes;
use TechDivision\Import\Product\Utils\MemberNames;
use TechDivision\Import\Product\Utils\ColumnKeys;
use TechDivision\Import\Utils\Filter\UrlKeyFilterTrait;
use TechDivision\Import\Product\Services\ProductBunchProcessorInterface;
use TechDivision\Import\Utils\UrlKeyUtilInterface;
use TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface;

/**
 * Observer that extracts the URL key from the product name and adds a two new columns
 * with the their values.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-product
 * @link      http://www.techdivision.com
 */
class UrlKeyObserver extends AbstractProductImportObserver
{

    /**
     * The trait that provides string => URL key conversion functionality.
     *
     * @var \TechDivision\Import\Utils\Filter\UrlKeyFilterTrait
     */
    use UrlKeyFilterTrait;

    /**
     * The URL key utility instance.
     *
     * @var \TechDivision\Import\Utils\UrlKeyUtilInterface
     */
    protected $urlKeyUtil;

    /**
     * The product bunch processor instance.
     *
     * @var \TechDivision\Import\Product\Services\ProductBunchProcessorInterface
     */
    protected $productBunchProcessor;

    /**
     * Initialize the observer with the passed product bunch processor and filter instance.
     *
     * @param \TechDivision\Import\Product\Services\ProductBunchProcessorInterface $productBunchProcessor   The product bunch processor instance
     * @param \Zend\Filter\FilterInterface                                         $convertLiteralUrlFilter The URL filter instance
     * @param \TechDivision\Import\Utils\UrlKeyUtilInterface                       $urlKeyUtil              The URL key utility instance
     */
    public function __construct(
        ProductBunchProcessorInterface $productBunchProcessor,
        FilterInterface $convertLiteralUrlFilter,
        UrlKeyUtilInterface $urlKeyUtil
    ) {
        $this->productBunchProcessor = $productBunchProcessor;
        $this->convertLiteralUrlFilter = $convertLiteralUrlFilter;
        $this->urlKeyUtil = $urlKeyUtil;
    }

    /**
     * Return's the product bunch processor instance.
     *
     * @return \TechDivision\Import\Product\Services\ProductBunchProcessorInterface The product bunch processor instance
     */
    protected function getProductBunchProcessor()
    {
        return $this->productBunchProcessor;
    }

    /**
     * Process the observer's business logic.
     *
     * @return void
     * @throws \Exception Is thrown, if either column "url_key" or "name" have a value set
     */
    protected function process()
    {

        // prepare the store view code
        $this->getSubject()->prepareStoreViewCode();

        // set the entity ID for the product with the passed SKU
        if ($product = $this->loadProduct($this->getValue(ColumnKeys::SKU))) {
            $this->setIds($product);
        } else {
            $this->setIds(array());
        }

        // query whether or not the URL key column has a value
        if ($this->hasValue(ColumnKeys::URL_KEY)) {
            return;
        }

        // query whether or not a product name is available
        if ($this->hasValue(ColumnKeys::NAME)) {
            $this->setValue(
                ColumnKeys::URL_KEY,
                $this->makeUnique(
                    $this->getSubject(),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    $this->convertNameToUrlKey($this->getValue(ColumnKeys::NAME))
                )
            );
            return;
        }

        // throw an exception, that the URL key can not be initialized and we're in admin store view
        if ($this->getSubject()->getStoreViewCode(StoreViewCodes::ADMIN) === StoreViewCodes::ADMIN) {
            throw new \Exception('Can\'t initialize the URL key because either columns "url_key" or "name" have a value set for default store view');
        }
    }

    /**
     * Temporarily persist's the IDs of the passed product.
     *
     * @param array $product The product to temporarily persist the IDs for
     *
     * @return void
     */
    protected function setIds(array $product)
    {
        $this->setLastEntityId(isset($product[MemberNames::ENTITY_ID]) ? $product[MemberNames::ENTITY_ID] : null);
    }

    /**
     * Set's the ID of the product that has been created recently.
     *
     * @param string $lastEntityId The entity ID
     *
     * @return void
     */
    protected function setLastEntityId($lastEntityId)
    {
        $this->getSubject()->setLastEntityId($lastEntityId);
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.
    }
}
    }

    /**
     * Load's and return's the product with the passed SKU.
     *
     * @param string $sku The SKU of the product to load
     *
     * @return array The product
     */
    protected function loadProduct($sku)
    {
        return $this->getProductBunchProcessor()->loadProduct($sku);
    }

    /**
     * Returns the URL key utility instance.
     *
     * @return \TechDivision\Import\Utils\UrlKeyUtilInterface The URL key utility instance
     */
    protected function getUrlKeyUtil()
    {
        return $this->urlKeyUtil;
    }

    /**
     * Make's the passed URL key unique by adding the next number to the end.
     *
     * @param \TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface $subject The subject to make the URL key unique for
     * @param string                                                    $urlKey  The URL key to make unique
     *
     * @return string The unique URL key
     */
    protected function makeUnique(UrlKeyAwareSubjectInterface $subject, $urlKey)
    {
        return $this->getUrlKeyUtil()->makeUnique($subject, $urlKey);
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Product\Observers\UrlKeyObserver
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 2016 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link https://github.com/techdivision/import-product
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Product\Observers;
22
23			use Zend\Filter\FilterInterface;
24			use TechDivision\Import\Utils\StoreViewCodes;
25			use TechDivision\Import\Product\Utils\MemberNames;
26			use TechDivision\Import\Product\Utils\ColumnKeys;
27			use TechDivision\Import\Utils\Filter\UrlKeyFilterTrait;
28			use TechDivision\Import\Product\Services\ProductBunchProcessorInterface;
29			use TechDivision\Import\Utils\UrlKeyUtilInterface;
30			use TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface;
31
32			/**
33			* Observer that extracts the URL key from the product name and adds a two new columns
34			* with the their values.
35			*
36			* @author Tim Wagner <[email protected]>
37			* @copyright 2016 TechDivision GmbH <[email protected]>
38			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
39			* @link https://github.com/techdivision/import-product
40			* @link http://www.techdivision.com
41			*/
42			class UrlKeyObserver extends AbstractProductImportObserver
43			{
44
45			/**
46			* The trait that provides string => URL key conversion functionality.
47			*
48			* @var \TechDivision\Import\Utils\Filter\UrlKeyFilterTrait
49			*/
50			use UrlKeyFilterTrait;
51
52			/**
53			* The URL key utility instance.
54			*
55			* @var \TechDivision\Import\Utils\UrlKeyUtilInterface
56			*/
57			protected $urlKeyUtil;
58
59			/**
60			* The product bunch processor instance.
61			*
62			* @var \TechDivision\Import\Product\Services\ProductBunchProcessorInterface
63			*/
64			protected $productBunchProcessor;
65
66			/**
67			* Initialize the observer with the passed product bunch processor and filter instance.
68			*
69			* @param \TechDivision\Import\Product\Services\ProductBunchProcessorInterface $productBunchProcessor The product bunch processor instance
70			* @param \Zend\Filter\FilterInterface $convertLiteralUrlFilter The URL filter instance
71			* @param \TechDivision\Import\Utils\UrlKeyUtilInterface $urlKeyUtil The URL key utility instance
72			*/
73			public function __construct(
74			ProductBunchProcessorInterface $productBunchProcessor,
75			FilterInterface $convertLiteralUrlFilter,
76			UrlKeyUtilInterface $urlKeyUtil
77			) {
78			$this->productBunchProcessor = $productBunchProcessor;
79			$this->convertLiteralUrlFilter = $convertLiteralUrlFilter;
80			$this->urlKeyUtil = $urlKeyUtil;
81			}
82
83			/**
84			* Return's the product bunch processor instance.
85			*
86			* @return \TechDivision\Import\Product\Services\ProductBunchProcessorInterface The product bunch processor instance
87			*/
88			protected function getProductBunchProcessor()
89			{
90			return $this->productBunchProcessor;
91			}
92
93			/**
94			* Process the observer's business logic.
95			*
96			* @return void
97			* @throws \Exception Is thrown, if either column "url_key" or "name" have a value set
98			*/
99			protected function process()
100			{
101
102			// prepare the store view code
103			$this->getSubject()->prepareStoreViewCode();
104
105			// set the entity ID for the product with the passed SKU
106			if ($product = $this->loadProduct($this->getValue(ColumnKeys::SKU))) {
107			$this->setIds($product);
108			} else {
109			$this->setIds(array());
110			}
111
112			// query whether or not the URL key column has a value
113			if ($this->hasValue(ColumnKeys::URL_KEY)) {
114			return;
115			}
116
117			// query whether or not a product name is available
118			if ($this->hasValue(ColumnKeys::NAME)) {
119			$this->setValue(
120			ColumnKeys::URL_KEY,
121			$this->makeUnique(
122			$this->getSubject(),
			0 ignored issues – show Documentation introduced 2019-09-25 12:23 UTC by Report Bug Copy Issue Report `$this->getSubject()` is of type `object<TechDivision\Impo...jects\SubjectInterface>`, but the function expects a `object<TechDivision\Impo...yAwareSubjectInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
123			$this->convertNameToUrlKey($this->getValue(ColumnKeys::NAME))
124			)
125			);
126			return;
127			}
128
129			// throw an exception, that the URL key can not be initialized and we're in admin store view
130			if ($this->getSubject()->getStoreViewCode(StoreViewCodes::ADMIN) === StoreViewCodes::ADMIN) {
131			throw new \Exception('Can\'t initialize the URL key because either columns "url_key" or "name" have a value set for default store view');
132			}
133			}
134
135			/**
136			* Temporarily persist's the IDs of the passed product.
137			*
138			* @param array $product The product to temporarily persist the IDs for
139			*
140			* @return void
141			*/
142			protected function setIds(array $product)
143			{
144			$this->setLastEntityId(isset($product[MemberNames::ENTITY_ID]) ? $product[MemberNames::ENTITY_ID] : null);
145			}
146
147			/**
148			* Set's the ID of the product that has been created recently.
149			*
150			* @param string $lastEntityId The entity ID
151			*
152			* @return void
153			*/
154			protected function setLastEntityId($lastEntityId)
155			{
156			$this->getSubject()->setLastEntityId($lastEntityId);
			0 ignored issues – show Bug introduced 2017-08-22 17:03 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TechDivision\Import\Subjects\SubjectInterface` as the method `setLastEntityId()` does only exist in the following implementations of said interface: `TechDivision\Import\Plugins\ExportableSubjectImpl`, `TechDivision\Import\Prod...\AbstractProductSubject`, `TechDivision\Import\Product\Subjects\BunchSubject`, `TechDivision\Import\Subjects\ExportableTraitImpl`. 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...
157			}
158
159			/**
160			* Load's and return's the product with the passed SKU.
161			*
162			* @param string $sku The SKU of the product to load
163			*
164			* @return array The product
165			*/
166			protected function loadProduct($sku)
167			{
168			return $this->getProductBunchProcessor()->loadProduct($sku);
169			}
170
171			/**
172			* Returns the URL key utility instance.
173			*
174			* @return \TechDivision\Import\Utils\UrlKeyUtilInterface The URL key utility instance
175			*/
176			protected function getUrlKeyUtil()
177			{
178			return $this->urlKeyUtil;
179			}
180
181			/**
182			* Make's the passed URL key unique by adding the next number to the end.
183			*
184			* @param \TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface $subject The subject to make the URL key unique for
185			* @param string $urlKey The URL key to make unique
186			*
187			* @return string The unique URL key
188			*/
189			protected function makeUnique(UrlKeyAwareSubjectInterface $subject, $urlKey)
190			{
191			return $this->getUrlKeyUtil()->makeUnique($subject, $urlKey);
192			}
193			}
194

techdivision / import-product

Push — 19.x ( bfbe2b...654634 )

UrlKeyObserver A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

8 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like