UrlKeyAndPathObserver - Code Metrics - Inspection of "* Fixed invalid behaviour of #PAC-307: Add fallbac..." - techdivision/import-category - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 20.x ( f8b2f9...4a3d9d )

by Tim

created 2020-12-28 16:21 UTC

UrlKeyAndPathObserver A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	247
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

Metric	Value
wmc	28
lcom	1
cbo	7
dl	0
loc	247
rs	10
c	0
b	0
f	0

12 Methods

Rating	Name	Size	Complexity
A	__construct()	11	1
F	process()	82	16
A	getPkMemberName()	4	1
A	getCategoryBunchProcessor()	4	1
A	getUrlKeyUtil()	4	1
A	getCategoryByPath()	4	1
A	getCategoryByPkAndStoreId()	4	1
A	setIds()	4	2
A	setLastEntityId()	4	1
A	getPrimaryKey()	4	1
A	loadUrlKey()	4	1
A	makeUnique()	4	1

<?php

/**
 * TechDivision\Import\Category\Observers\UrlKeyAndPathObserver
 *
 * 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 2019 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-category
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Category\Observers;

use Zend\Filter\FilterInterface;
use TechDivision\Import\Utils\StoreViewCodes;
use TechDivision\Import\Utils\UrlKeyUtilInterface;
use TechDivision\Import\Utils\Filter\UrlKeyFilterTrait;
use TechDivision\Import\Category\Utils\ColumnKeys;
use TechDivision\Import\Category\Utils\MemberNames;
use TechDivision\Import\Category\Utils\ConfigurationKeys;
use TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface;
use TechDivision\Import\Category\Services\CategoryBunchProcessorInterface;

/**
 * Observer that extracts the URL key/path from the category path
 * and adds them as two new columns with the their values.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2019 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-category
 * @link      http://www.techdivision.com
 */
class UrlKeyAndPathObserver extends AbstractCategoryImportObserver
{

    /**
     * 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 category bunch processor instance.
     *
     * @var \TechDivision\Import\Category\Services\CategoryBunchProcessorInterface
     */
    protected $categoryBunchProcessor;

    /**
     * Initialize the observer with the passed product bunch processor instance.
     *
     * @param \TechDivision\Import\Category\Services\CategoryBunchProcessorInterface $categoryBunchProcessor  The category 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(
        CategoryBunchProcessorInterface $categoryBunchProcessor,
        FilterInterface $convertLiteralUrlFilter,
        UrlKeyUtilInterface $urlKeyUtil
    ) {

        // set the processor and the URL filter instance
        $this->categoryBunchProcessor = $categoryBunchProcessor;
        $this->convertLiteralUrlFilter = $convertLiteralUrlFilter;
        $this->urlKeyUtil = $urlKeyUtil;
    }

    /**
     * Process the observer's business logic.
     *
     * @return void
     */
    protected function process()
    {

        // initialize the URL key and array for the categories
        $urlKey = null;
        $category = array();

        // set the entity ID for the category with the passed path
        try {
            $this->setIds($category = $this->getCategoryByPath($path = $this->getValue(ColumnKeys::PATH)));
        } catch (\Exception $e) {
            $this->setIds(array());
        }

        // query whether or not the URL key column has a value
        if ($this->hasValue(ColumnKeys::URL_KEY)) {
            $urlKey = $this->makeUnique($this->getSubject(), $this->getValue(ColumnKeys::URL_KEY));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } else {
            // query whether or not the existing category `url_key` should be re-created from the category name
            if ($category && !$this->getSubject()->getConfiguration()->getParam(ConfigurationKeys::UPDATE_URL_KEY_FROM_NAME, true)) {

                // if the category already exists and NO re-creation from the category name has to
                // be done, load the original `url_key`from the category and use that to proceed
                $urlKey = $this->loadUrlKey($this->getSubject(), $this->getPrimaryKey());
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }

            // query whether or not the an URL key for the exisitng category
            // has been available, if not but the column `name` contains a
            // value try to create an URL key from the category's name
            if ($urlKey === '' || $urlKey === null && $this->hasValue(ColumnKeys::NAME)) {
                $urlKey = $this->makeUnique($this->getSubject(), $this->convertNameToUrlKey($this->getValue(ColumnKeys::NAME)));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }

            // if no URL key has benn available nor the column `name`
            // contains a value, we've to throw an exception
            if ($urlKey === '' || $urlKey === null) {
                // throw an exception, that the URL key can not be initialized and we're in default store view
                if ($this->getSubject()->getStoreViewCode(StoreViewCodes::ADMIN) === StoreViewCodes::ADMIN) {
                    throw new \Exception('Can\'t initialize the URL key for category "%s" because columns "url_key" or "name" have a value set for default store view', $path);
                }
            }

            // otherwise set the URL key as value for column`url_key`,
            // because we need one to process the rewrites later
            $this->setValue(ColumnKeys::URL_KEY, $urlKey);
        }

        // explode the path into the category names
        if ($categories = $this->explode($this->getValue(ColumnKeys::PATH), '/')) {
            // initialize the category with the actual category's URL key
            $categoryPaths = array($urlKey);
            // prepare the store view code
            $this->prepareStoreViewCode();
            // load ID of the actual store view
            $storeId = $this->getRowStoreId(StoreViewCodes::ADMIN);

            // iterate over the category names and try to load the category therefore
            for ($i = sizeof($categories) - 1; $i > 1; $i--) {
                try {
                    // prepare the expected category name
                    $categoryPath = implode('/', array_slice($categories, 0, $i));
                    // load the existing category and prepend the URL key the array with the category URL keys
                    $existingCategory = $this->getCategoryByPkAndStoreId($this->mapPath($categoryPath), $storeId);
                    // query whether or not an URL key is available or not
                    if (isset($existingCategory[MemberNames::URL_KEY])) {
                        array_unshift($categoryPaths, $existingCategory[MemberNames::URL_KEY]);
                    } else {
                        $this->getSystemLogger()->debug(sprintf('Can\'t find URL key for category %s', $categoryPath));
                    }
                } catch (\Exception $e) {
                    $this->getSystemLogger()->debug(sprintf('Can\'t load parent category %s', $categoryPath));
                }
            }

            // create the header for the URL path
            if (!$this->hasHeader(ColumnKeys::URL_PATH)) {
                $this->addHeader(ColumnKeys::URL_PATH);
            }

            // set the URL path
            $this->setValue(ColumnKeys::URL_PATH, implode('/', $categoryPaths));
        }
    }

    /**
     * Return the primary key member name.
     *
     * @return string The primary key member name
     */
    protected function getPkMemberName()
    {
        return MemberNames::ENTITY_ID;
    }

    /**
     * Returns the category bunch processor instance.
     *
     * @return \TechDivision\Import\Category\Services\CategoryBunchProcessorInterface The category bunch processor instance
     */
    protected function getCategoryBunchProcessor()
    {
        return $this->categoryBunchProcessor;
    }

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

    /**
     * Return's the category with the passed path.
     *
     * @param string $path The path of the category to return
     *
     * @return array The category
     * @throws \Exception Is thrown, if the requested category is not available
     */
    protected function getCategoryByPath($path)
    {
        return $this->getSubject()->getCategoryByPath($path);
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.
    }
}
    }

    /**
     * Returns the category with the passed primary key and the attribute values for the passed store ID.
     *
     * @param string  $pk      The primary key of the category to return
     * @param integer $storeId The store ID of the category values
     *
     * @return array|null The category data
     */
    protected function getCategoryByPkAndStoreId($pk, $storeId)
    {
        return $this->getCategoryBunchProcessor()->getCategoryByPkAndStoreId($pk, $storeId);
    }

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

    /**
     * Set's the ID of the category 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.
    }
}
    }

    /**
     * Return's the PK to of the product.
     *
     * @return integer The PK to create the relation with
     */
    protected function getPrimaryKey()
    {
        $this->getSubject()->getLastEntityId();
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 url_key with the passed primary ID.
     *
     * @param \TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface $subject      The subject to load the URL key
     * @param int                                                       $primaryKeyId The ID from category
     *
     * @return string|null url_key or null
     */
    protected function loadUrlKey(UrlKeyAwareSubjectInterface $subject, $primaryKeyId)
    {
        return $this->getUrlKeyUtil()->loadUrlKey($subject, $primaryKeyId);

    }

    /**
     * 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);
    }
}


Push — 20.x ( f8b2f9...4a3d9d )

UrlKeyAndPathObserver A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

12 Methods

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			/**
4			* TechDivision\Import\Category\Observers\UrlKeyAndPathObserver
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 2019 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-category
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Category\Observers;
22
23			use Zend\Filter\FilterInterface;
24			use TechDivision\Import\Utils\StoreViewCodes;
25			use TechDivision\Import\Utils\UrlKeyUtilInterface;
26			use TechDivision\Import\Utils\Filter\UrlKeyFilterTrait;
27			use TechDivision\Import\Category\Utils\ColumnKeys;
28			use TechDivision\Import\Category\Utils\MemberNames;
29			use TechDivision\Import\Category\Utils\ConfigurationKeys;
30			use TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface;
31			use TechDivision\Import\Category\Services\CategoryBunchProcessorInterface;
32
33			/**
34			* Observer that extracts the URL key/path from the category path
35			* and adds them as two new columns with the their values.
36			*
37			* @author Tim Wagner <[email protected]>
38			* @copyright 2019 TechDivision GmbH <[email protected]>
39			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
40			* @link https://github.com/techdivision/import-category
41			* @link http://www.techdivision.com
42			*/
43			class UrlKeyAndPathObserver extends AbstractCategoryImportObserver
44			{
45
46			/**
47			* The trait that provides string => URL key conversion functionality.
48			*
49			* @var \TechDivision\Import\Utils\Filter\UrlKeyFilterTrait
50			*/
51			use UrlKeyFilterTrait;
52
53			/**
54			* The URL key utility instance.
55			*
56			* @var \TechDivision\Import\Utils\UrlKeyUtilInterface
57			*/
58			protected $urlKeyUtil;
59
60			/**
61			* The category bunch processor instance.
62			*
63			* @var \TechDivision\Import\Category\Services\CategoryBunchProcessorInterface
64			*/
65			protected $categoryBunchProcessor;
66
67			/**
68			* Initialize the observer with the passed product bunch processor instance.
69			*
70			* @param \TechDivision\Import\Category\Services\CategoryBunchProcessorInterface $categoryBunchProcessor The category bunch processor instance
71			* @param \Zend\Filter\FilterInterface $convertLiteralUrlFilter The URL filter instance
72			* @param \TechDivision\Import\Utils\UrlKeyUtilInterface $urlKeyUtil The URL key utility instance
73			*/
74			public function __construct(
75			CategoryBunchProcessorInterface $categoryBunchProcessor,
76			FilterInterface $convertLiteralUrlFilter,
77			UrlKeyUtilInterface $urlKeyUtil
78			) {
79
80			// set the processor and the URL filter instance
81			$this->categoryBunchProcessor = $categoryBunchProcessor;
82			$this->convertLiteralUrlFilter = $convertLiteralUrlFilter;
83			$this->urlKeyUtil = $urlKeyUtil;
84			}
85
86			/**
87			* Process the observer's business logic.
88			*
89			* @return void
90			*/
91			protected function process()
92			{
93
94			// initialize the URL key and array for the categories
95			$urlKey = null;
96			$category = array();
97
98			// set the entity ID for the category with the passed path
99			try {
100			$this->setIds($category = $this->getCategoryByPath($path = $this->getValue(ColumnKeys::PATH)));
101			} catch (\Exception $e) {
102			$this->setIds(array());
103			}
104
105			// query whether or not the URL key column has a value
106			if ($this->hasValue(ColumnKeys::URL_KEY)) {
107			$urlKey = $this->makeUnique($this->getSubject(), $this->getValue(ColumnKeys::URL_KEY));
			0 ignored issues – show Documentation introduced 2019-09-25 18:34 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...
108			} else {
109			// query whether or not the existing category `url_key` should be re-created from the category name
110			if ($category && !$this->getSubject()->getConfiguration()->getParam(ConfigurationKeys::UPDATE_URL_KEY_FROM_NAME, true)) {
			0 ignored issues – show Bug Best Practice introduced 2020-12-28 16:22 UTC by Report Bug Copy Issue Report The expression `$category` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
111			// if the category already exists and NO re-creation from the category name has to
112			// be done, load the original `url_key`from the category and use that to proceed
113			$urlKey = $this->loadUrlKey($this->getSubject(), $this->getPrimaryKey());
			0 ignored issues – show Documentation introduced 2020-12-28 16:22 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...
114			}
115
116			// query whether or not the an URL key for the exisitng category
117			// has been available, if not but the column `name` contains a
118			// value try to create an URL key from the category's name
119			if ($urlKey === '' \|\| $urlKey === null && $this->hasValue(ColumnKeys::NAME)) {
120			$urlKey = $this->makeUnique($this->getSubject(), $this->convertNameToUrlKey($this->getValue(ColumnKeys::NAME)));
			0 ignored issues – show Documentation introduced 2019-09-25 18:34 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...
121			}
122
123			// if no URL key has benn available nor the column `name`
124			// contains a value, we've to throw an exception
125			if ($urlKey === '' \|\| $urlKey === null) {
126			// throw an exception, that the URL key can not be initialized and we're in default store view
127			if ($this->getSubject()->getStoreViewCode(StoreViewCodes::ADMIN) === StoreViewCodes::ADMIN) {
128			throw new \Exception('Can\'t initialize the URL key for category "%s" because columns "url_key" or "name" have a value set for default store view', $path);
129			}
130			}
131
132			// otherwise set the URL key as value for column`url_key`,
133			// because we need one to process the rewrites later
134			$this->setValue(ColumnKeys::URL_KEY, $urlKey);
135			}
136
137			// explode the path into the category names
138			if ($categories = $this->explode($this->getValue(ColumnKeys::PATH), '/')) {
139			// initialize the category with the actual category's URL key
140			$categoryPaths = array($urlKey);
141			// prepare the store view code
142			$this->prepareStoreViewCode();
143			// load ID of the actual store view
144			$storeId = $this->getRowStoreId(StoreViewCodes::ADMIN);
145
146			// iterate over the category names and try to load the category therefore
147			for ($i = sizeof($categories) - 1; $i > 1; $i--) {
148			try {
149			// prepare the expected category name
150			$categoryPath = implode('/', array_slice($categories, 0, $i));
151			// load the existing category and prepend the URL key the array with the category URL keys
152			$existingCategory = $this->getCategoryByPkAndStoreId($this->mapPath($categoryPath), $storeId);
153			// query whether or not an URL key is available or not
154			if (isset($existingCategory[MemberNames::URL_KEY])) {
155			array_unshift($categoryPaths, $existingCategory[MemberNames::URL_KEY]);
156			} else {
157			$this->getSystemLogger()->debug(sprintf('Can\'t find URL key for category %s', $categoryPath));
158			}
159			} catch (\Exception $e) {
160			$this->getSystemLogger()->debug(sprintf('Can\'t load parent category %s', $categoryPath));
161			}
162			}
163
164			// create the header for the URL path
165			if (!$this->hasHeader(ColumnKeys::URL_PATH)) {
166			$this->addHeader(ColumnKeys::URL_PATH);
167			}
168
169			// set the URL path
170			$this->setValue(ColumnKeys::URL_PATH, implode('/', $categoryPaths));
171			}
172			}
173
174			/**
175			* Return the primary key member name.
176			*
177			* @return string The primary key member name
178			*/
179			protected function getPkMemberName()
180			{
181			return MemberNames::ENTITY_ID;
182			}
183
184			/**
185			* Returns the category bunch processor instance.
186			*
187			* @return \TechDivision\Import\Category\Services\CategoryBunchProcessorInterface The category bunch processor instance
188			*/
189			protected function getCategoryBunchProcessor()
190			{
191			return $this->categoryBunchProcessor;
192			}
193
194			/**
195			* Returns the URL key utility instance.
196			*
197			* @return \TechDivision\Import\Utils\UrlKeyUtilInterface The URL key utility instance
198			*/
199			protected function getUrlKeyUtil()
200			{
201			return $this->urlKeyUtil;
202			}
203
204			/**
205			* Return's the category with the passed path.
206			*
207			* @param string $path The path of the category to return
208			*
209			* @return array The category
210			* @throws \Exception Is thrown, if the requested category is not available
211			*/
212			protected function getCategoryByPath($path)
213			{
214			return $this->getSubject()->getCategoryByPath($path);
			0 ignored issues – show Bug introduced 2019-10-30 17:29 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 `getCategoryByPath()` does only exist in the following implementations of said interface: `TechDivision\Import\Cate...AbstractCategorySubject`, `TechDivision\Import\Category\Subjects\BunchSubject`, `TechDivision\Import\Cate...ts\SortableBunchSubject`. 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...
215			}
216
217			/**
218			* Returns the category with the passed primary key and the attribute values for the passed store ID.
219			*
220			* @param string $pk The primary key of the category to return
221			* @param integer $storeId The store ID of the category values
222			*
223			* @return array\|null The category data
224			*/
225			protected function getCategoryByPkAndStoreId($pk, $storeId)
226			{
227			return $this->getCategoryBunchProcessor()->getCategoryByPkAndStoreId($pk, $storeId);
228			}
229
230			/**
231			* Temporarily persist's the IDs of the passed category.
232			*
233			* @param array $category The category to temporarily persist the IDs for
234			*
235			* @return void
236			*/
237			protected function setIds(array $category)
238			{
239			$this->setLastEntityId(isset($category[$this->getPkMemberName()]) ? $category[$this->getPkMemberName()] : null);
240			}
241
242			/**
243			* Set's the ID of the category that has been created recently.
244			*
245			* @param string $lastEntityId The entity ID
246			*
247			* @return void
248			*/
249			protected function setLastEntityId($lastEntityId)
250			{
251			$this->getSubject()->setLastEntityId($lastEntityId);
			0 ignored issues – show Bug introduced 2019-10-29 16:40 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\Cate...AbstractCategorySubject`, `TechDivision\Import\Category\Subjects\BunchSubject`, `TechDivision\Import\Cate...ts\SortableBunchSubject`, `TechDivision\Import\Plugins\ExportableSubjectImpl`, `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...
252			}
253
254			/**
255			* Return's the PK to of the product.
256			*
257			* @return integer The PK to create the relation with
258			*/
259			protected function getPrimaryKey()
260			{
261			$this->getSubject()->getLastEntityId();
			0 ignored issues – show Bug introduced 2020-12-22 00:10 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 `getLastEntityId()` does only exist in the following implementations of said interface: `TechDivision\Import\Cate...AbstractCategorySubject`, `TechDivision\Import\Category\Subjects\BunchSubject`, `TechDivision\Import\Cate...ts\SortableBunchSubject`, `TechDivision\Import\Observers\EntitySubjectImpl`, `TechDivision\Import\Plugins\ExportableSubjectImpl`, `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...
262			}
263
264			/**
265			* Load's and return's the url_key with the passed primary ID.
266			*
267			* @param \TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface $subject The subject to load the URL key
268			* @param int $primaryKeyId The ID from category
269			*
270			* @return string\|null url_key or null
271			*/
272			protected function loadUrlKey(UrlKeyAwareSubjectInterface $subject, $primaryKeyId)
273			{
274			return $this->getUrlKeyUtil()->loadUrlKey($subject, $primaryKeyId);
			0 ignored issues – show Bug introduced 2020-12-22 00:10 UTC by Report Bug Copy Issue Report The method `loadUrlKey()` does not seem to exist on `object<TechDivision\Impo...ls\UrlKeyUtilInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
275			}
276
277			/**
278			* Make's the passed URL key unique by adding the next number to the end.
279			*
280			* @param \TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface $subject The subject to make the URL key unique for
281			* @param string $urlKey The URL key to make unique
282			*
283			* @return string The unique URL key
284			*/
285			protected function makeUnique(UrlKeyAwareSubjectInterface $subject, $urlKey)
286			{
287			return $this->getUrlKeyUtil()->makeUnique($subject, $urlKey);
288			}
289			}
290

techdivision / import-category

Push — 20.x ( f8b2f9...4a3d9d )

UrlKeyAndPathObserver A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

12 Methods

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like