UrlKeyUtil::loadUrlKey() - Code Metrics - Inspection of "Merge pull request #207 from techdivision/pac-307-..." - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 16.x ( 50411d...f5cbb2 )

by Tim

created 2020-12-23 16:03 UTC

UrlKeyUtil::loadUrlKey() A

↳ Parent: UrlKeyUtil

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	23
ccs	0
cts	0
cp	0
rs	9.552
c	0
b	0
f	0
cc	2
nc	2
nop	2
crap	6

<?php

/**
 * TechDivision\Import\Utils\UrlKeyUtil
 *
 * 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
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Utils;

use TechDivision\Import\Configuration\ConfigurationInterface;
use TechDivision\Import\Services\UrlKeyAwareProcessorInterface;
use TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface;

/**
 * Utility class that provides functionality to make URL keys unique.
 *
 * @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
 * @link      http://www.techdivision.com
 */
class UrlKeyUtil implements UrlKeyUtilInterface
{

    /**
     * The configuration instance.
     *
     * @var \TechDivision\Import\Configuration\ConfigurationInterface
     */
    protected $configuration;

    /**
     * The URL key aware processor instance.
     *
     * \TechDivision\Import\Services\UrlKeyAwareProcessorInterface
     */
    protected $urlKeyAwareProcessor;

    /**
     * Construct a new instance.
     *
     * @param \TechDivision\Import\Configuration\ConfigurationInterface   $configuration        The configuration instance
     * @param \TechDivision\Import\Services\UrlKeyAwareProcessorInterface $urlKeyAwareProcessor The URL key aware processor instance
     */
    public function __construct(
        ConfigurationInterface $configuration,
        UrlKeyAwareProcessorInterface $urlKeyAwareProcessor
    ) {
        $this->configuration = $configuration;
        $this->urlKeyAwareProcessor = $urlKeyAwareProcessor;
    }

    /**
     * Returns the URL key aware processor instance.
     *
     * @return \TechDivision\Import\Services\UrlKeyAwareProcessorInterface The processor instance
     */
    protected function getUrlKeyAwareProcessor()
    {
        return $this->urlKeyAwareProcessor;
    }

    /**
     * Load's and return's the varchar attribute with the passed params.
     *
     * @param integer $attributeCode The attribute code of the varchar attribute
     * @param integer $entityTypeId  The entity type ID of the varchar attribute
     * @param integer $storeId       The store ID of the varchar attribute
     * @param string  $value         The value of the varchar attribute
     *
     * @return array|null The varchar attribute
     */
    protected function loadVarcharAttributeByAttributeCodeAndEntityTypeIdAndStoreIdAndValue($attributeCode, $entityTypeId, $storeId, $value)
    {
        return $this->getUrlKeyAwareProcessor()
                    ->loadVarcharAttributeByAttributeCodeAndEntityTypeIdAndStoreIdAndValue(
                        $attributeCode,
                        $entityTypeId,
                        $storeId,
                        $value
                    );
    }

    /**
     * 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
     */
    public function makeUnique(UrlKeyAwareSubjectInterface $subject, $urlKey)
    {

        // initialize the entity type ID
        $entityType = $subject->getEntityType();
        $entityTypeId = (integer) $entityType[MemberNames::ENTITY_TYPE_ID];

        // initialize the store view ID, use the admin store view if no store view has
        // been set, because the default url_key value has been set in admin store view
        $storeId = $subject->getRowStoreId(StoreViewCodes::ADMIN);

        // initialize the counter
        $counter = 0;

        // initialize the counters
        $matchingCounters = array();
        $notMatchingCounters = array();

        // pre-initialze the URL key to query for
        $value = $urlKey;

        do {
            // try to load the attribute
            $attribute =
                $this->loadVarcharAttributeByAttributeCodeAndEntityTypeIdAndStoreIdAndValue(
                    MemberNames::URL_KEY,
                    $entityTypeId,
                    $storeId,
                    $value
                );

            // try to load the entity's URL key
            if ($attribute) {

                // this IS the URL key of the passed entity
                if ($subject->isUrlKeyOf($attribute)) {
                    $matchingCounters[] = $counter;
                } else {
                    $notMatchingCounters[] = $counter;
                }

                // prepare the next URL key to query for
                $value = sprintf('%s-%d', $urlKey, ++$counter);
            }
        } while ($attribute);


        // sort the array ascending according to the counter
        asort($matchingCounters);
        asort($notMatchingCounters);

        // this IS the URL key of the passed entity => we've an UPDATE
        if (sizeof($matchingCounters) > 0) {
            // load highest counter
            $counter = end($matchingCounters);
            // if the counter is > 0, we've to append it to the new URL key
            if ($counter > 0) {
                $urlKey = sprintf('%s-%d', $urlKey, $counter);
            }
        } elseif (sizeof($notMatchingCounters) > 0) {
            // create a new URL key by raising the counter
            $newCounter = end($notMatchingCounters);
            $urlKey = sprintf('%s-%d', $urlKey, ++$newCounter);
        }

        // return the passed URL key, if NOT
        return $urlKey;
    }

    /**
     * Load the url_key, if it exists. Return NULL otherwise.
     *
     * @param \TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface $subject The subject to make the URL key unique for
     * @param int                                                       $pk      The ID from category or product
     *
     * @return string|null The URL key
     */
    public function loadUrlKey(UrlKeyAwareSubjectInterface $subject, $pk)
    {

        // initialize the entity type ID
        $entityType = $subject->getEntityType();
        $entityTypeId = (integer) $entityType[MemberNames::ENTITY_TYPE_ID];

        // initialize the store view ID, use the admin store view if no store view has
        // been set, because the default url_key value has been set in admin store view
        $storeId = $subject->getRowStoreId(StoreViewCodes::ADMIN);

        // try to load the attribute
        $attribute = $this->getUrlKeyAwareProcessor()
            ->loadVarcharAttributeByAttributeCodeAndEntityTypeIdAndStoreIdAndPrimaryKey(
                MemberNames::URL_KEY,
                $entityTypeId,
                $storeId,
                $pk
            );

        // whether return the attribute's value or NULL
        return $attribute ? $attribute['value'] : null;
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Utils\UrlKeyUtil
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
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Utils;
22
23			use TechDivision\Import\Configuration\ConfigurationInterface;
24			use TechDivision\Import\Services\UrlKeyAwareProcessorInterface;
25			use TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface;
26
27			/**
28			* Utility class that provides functionality to make URL keys unique.
29			*
30			* @author Tim Wagner <[email protected]>
31			* @copyright 2019 TechDivision GmbH <[email protected]>
32			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
33			* @link https://github.com/techdivision/import
34			* @link http://www.techdivision.com
35			*/
36			class UrlKeyUtil implements UrlKeyUtilInterface
37			{
38
39			/**
40			* The configuration instance.
41			*
42			* @var \TechDivision\Import\Configuration\ConfigurationInterface
43			*/
44			protected $configuration;
45
46			/**
47			* The URL key aware processor instance.
48			*
49			* \TechDivision\Import\Services\UrlKeyAwareProcessorInterface
50			*/
51			protected $urlKeyAwareProcessor;
52
53			/**
54			* Construct a new instance.
55			*
56			* @param \TechDivision\Import\Configuration\ConfigurationInterface $configuration The configuration instance
57			* @param \TechDivision\Import\Services\UrlKeyAwareProcessorInterface $urlKeyAwareProcessor The URL key aware processor instance
58			*/
59			public function __construct(
60			ConfigurationInterface $configuration,
61			UrlKeyAwareProcessorInterface $urlKeyAwareProcessor
62			) {
63			$this->configuration = $configuration;
64			$this->urlKeyAwareProcessor = $urlKeyAwareProcessor;
65			}
66
67			/**
68			* Returns the URL key aware processor instance.
69			*
70			* @return \TechDivision\Import\Services\UrlKeyAwareProcessorInterface The processor instance
71			*/
72			protected function getUrlKeyAwareProcessor()
73			{
74			return $this->urlKeyAwareProcessor;
75			}
76
77			/**
78			* Load's and return's the varchar attribute with the passed params.
79			*
80			* @param integer $attributeCode The attribute code of the varchar attribute
81			* @param integer $entityTypeId The entity type ID of the varchar attribute
82			* @param integer $storeId The store ID of the varchar attribute
83			* @param string $value The value of the varchar attribute
84			*
85			* @return array\|null The varchar attribute
86			*/
87			protected function loadVarcharAttributeByAttributeCodeAndEntityTypeIdAndStoreIdAndValue($attributeCode, $entityTypeId, $storeId, $value)
88			{
89			return $this->getUrlKeyAwareProcessor()
90			->loadVarcharAttributeByAttributeCodeAndEntityTypeIdAndStoreIdAndValue(
91			$attributeCode,
92			$entityTypeId,
93			$storeId,
94			$value
95			);
96			}
97
98			/**
99			* Make's the passed URL key unique by adding the next number to the end.
100			*
101			* @param \TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface $subject The subject to make the URL key unique for
102			* @param string $urlKey The URL key to make unique
103			*
104			* @return string The unique URL key
105			*/
106			public function makeUnique(UrlKeyAwareSubjectInterface $subject, $urlKey)
107			{
108
109			// initialize the entity type ID
110			$entityType = $subject->getEntityType();
111			$entityTypeId = (integer) $entityType[MemberNames::ENTITY_TYPE_ID];
112
113			// initialize the store view ID, use the admin store view if no store view has
114			// been set, because the default url_key value has been set in admin store view
115			$storeId = $subject->getRowStoreId(StoreViewCodes::ADMIN);
116
117			// initialize the counter
118			$counter = 0;
119
120			// initialize the counters
121			$matchingCounters = array();
122			$notMatchingCounters = array();
123
124			// pre-initialze the URL key to query for
125			$value = $urlKey;
126
127			do {
128			// try to load the attribute
129			$attribute =
130			$this->loadVarcharAttributeByAttributeCodeAndEntityTypeIdAndStoreIdAndValue(
131			MemberNames::URL_KEY,
132			$entityTypeId,
133			$storeId,
134			$value
135			);
136
137			// try to load the entity's URL key
138			if ($attribute) {
			0 ignored issues – show Bug Best Practice introduced 2019-09-25 12:22 UTC by Report Bug Copy Issue Report The expression `$attribute` 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...
139			// this IS the URL key of the passed entity
140			if ($subject->isUrlKeyOf($attribute)) {
141			$matchingCounters[] = $counter;
142			} else {
143			$notMatchingCounters[] = $counter;
144			}
145
146			// prepare the next URL key to query for
147			$value = sprintf('%s-%d', $urlKey, ++$counter);
148			}
149			} while ($attribute);
			0 ignored issues – show Bug Best Practice introduced 2019-09-25 12:22 UTC by Report Bug Copy Issue Report The expression `$attribute` 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...
150
151			// sort the array ascending according to the counter
152			asort($matchingCounters);
153			asort($notMatchingCounters);
154
155			// this IS the URL key of the passed entity => we've an UPDATE
156			if (sizeof($matchingCounters) > 0) {
157			// load highest counter
158			$counter = end($matchingCounters);
159			// if the counter is > 0, we've to append it to the new URL key
160			if ($counter > 0) {
161			$urlKey = sprintf('%s-%d', $urlKey, $counter);
162			}
163			} elseif (sizeof($notMatchingCounters) > 0) {
164			// create a new URL key by raising the counter
165			$newCounter = end($notMatchingCounters);
166			$urlKey = sprintf('%s-%d', $urlKey, ++$newCounter);
167			}
168
169			// return the passed URL key, if NOT
170			return $urlKey;
171			}
172
173			/**
174			* Load the url_key, if it exists. Return NULL otherwise.
175			*
176			* @param \TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface $subject The subject to make the URL key unique for
177			* @param int $pk The ID from category or product
178			*
179			* @return string\|null The URL key
180			*/
181			public function loadUrlKey(UrlKeyAwareSubjectInterface $subject, $pk)
182			{
183
184			// initialize the entity type ID
185			$entityType = $subject->getEntityType();
186			$entityTypeId = (integer) $entityType[MemberNames::ENTITY_TYPE_ID];
187
188			// initialize the store view ID, use the admin store view if no store view has
189			// been set, because the default url_key value has been set in admin store view
190			$storeId = $subject->getRowStoreId(StoreViewCodes::ADMIN);
191
192			// try to load the attribute
193			$attribute = $this->getUrlKeyAwareProcessor()
194			->loadVarcharAttributeByAttributeCodeAndEntityTypeIdAndStoreIdAndPrimaryKey(
195			MemberNames::URL_KEY,
196			$entityTypeId,
197			$storeId,
198			$pk
199			);
200
201			// whether return the attribute's value or NULL
202			return $attribute ? $attribute['value'] : null;
203			}
204			}
205

techdivision / import

Push — 16.x ( 50411d...f5cbb2 )

UrlKeyUtil::loadUrlKey() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like