Completed
Push — 17.x ( e764b3 )
by Tim
03:33
created

UrlRewriteObserver::prepareUrlRewrites()   B

Complexity

Conditions 5
Paths 10

Size

Total Lines 43

Duplication

Lines 7
Ratio 16.28 %

Code Coverage

Tests 13
CRAP Score 5.7873

Importance

Changes 0
Metric Value
dl 7
loc 43
rs 8.9208
c 0
b 0
f 0
ccs 13
cts 19
cp 0.6842
cc 5
nc 10
nop 0
crap 5.7873
1
<?php
2
3
/**
4
 * TechDivision\Import\Product\UrlRewrite\Observers\UrlRewriteObserver
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-url-rewrite
18
 * @link      http://www.techdivision.com
19
 */
20
21
namespace TechDivision\Import\Product\UrlRewrite\Observers;
22
23
use TechDivision\Import\Utils\StoreViewCodes;
24
use TechDivision\Import\Product\Utils\VisibilityKeys;
25
use TechDivision\Import\Product\Utils\CoreConfigDataKeys;
26
use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
27
use TechDivision\Import\Product\UrlRewrite\Utils\ColumnKeys;
28
use TechDivision\Import\Product\UrlRewrite\Utils\MemberNames;
29
use TechDivision\Import\Product\UrlRewrite\Services\ProductUrlRewriteProcessorInterface;
30
use TechDivision\Import\Subjects\SubjectInterface;
31
32
/**
33
 * Observer that creates/updates the product's URL rewrites.
34
 *
35
 * @author    Tim Wagner <[email protected]>
36
 * @copyright 2016 TechDivision GmbH <[email protected]>
37
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
38
 * @link      https://github.com/techdivision/import-product-url-rewrite
39
 * @link      http://www.techdivision.com
40
 */
41
class UrlRewriteObserver extends AbstractProductImportObserver
42
{
43
44
    /**
45
     * The entity type to load the URL rewrites for.
46
     *
47
     * @var string
48
     */
49
    const ENTITY_TYPE = 'product';
50
51
    /**
52
     * The key for the category in the metadata.
53
     *
54
     * @var string
55
     */
56
    const CATEGORY_ID = 'category_id';
57
58
    /**
59
     * The URL key from the CSV file column that has to be processed by the observer.
60
     *
61
     * @var string
62
     */
63
    protected $urlKey;
64
65
    /**
66
     * The actual category ID to process.
67
     *
68
     * @var integer
69
     */
70
    protected $categoryId;
71
72
    /**
73
     * The actual entity ID to process.
74
     *
75
     * @var integer
76
     */
77
    protected $entityId;
78
79
    /**
80
     * The ID of the recently created URL rewrite.
81
     *
82
     * @var integer
83
     */
84
    protected $urlRewriteId;
85
86
    /**
87
     * The array with the URL rewrites that has to be created.
88
     *
89
     * @var array
90
     */
91
    protected $urlRewrites = array();
92
93
    /**
94
     * The array with the category IDs related with the product.
95
     *
96
     * @var array
97
     */
98
    protected $productCategoryIds = array();
99
100
    /**
101
     * The product bunch processor instance.
102
     *
103
     * @var \TechDivision\Import\Product\UrlRewrite\Services\ProductUrlRewriteProcessorInterface
104
     */
105
    protected $productUrlRewriteProcessor;
106
107
    /**
108
     * Initialize the observer with the passed product URL rewrite processor instance.
109
     *
110
     * @param \TechDivision\Import\Product\UrlRewrite\Services\ProductUrlRewriteProcessorInterface $productUrlRewriteProcessor The product URL rewrite processor instance
111
     */
112 3
    public function __construct(ProductUrlRewriteProcessorInterface $productUrlRewriteProcessor)
113
    {
114 3
        $this->productUrlRewriteProcessor = $productUrlRewriteProcessor;
115 3
    }
116
117
    /**
118
     * Return's the product bunch processor instance.
119
     *
120
     * @return \TechDivision\Import\Product\Services\ProductBunchProcessorInterface The product bunch processor instance
121
     */
122 3
    protected function getProductUrlRewriteProcessor()
123
    {
124 3
        return $this->productUrlRewriteProcessor;
125
    }
126
127
    /**
128
     * Will be invoked by the action on the events the listener has been registered for.
129
     *
130
     * @param \TechDivision\Import\Subjects\SubjectInterface $subject The subject instance
131
     *
132
     * @return array The modified row
133
     * @throws \Exception Is thrown, if the product is not available or no URL key has been specified
134
     * @see \TechDivision\Import\Observers\ObserverInterface::handle()
135
     */
136 3
    public function handle(SubjectInterface $subject)
137
    {
138
139
        // initialize the row
140 3
        $this->setSubject($subject);
141 3
        $this->setRow($subject->getRow());
142
143
        // try to load the entity ID for the product with the passed SKU
144 3
        if ($product = $this->loadProduct($sku = $this->getValue(ColumnKeys::SKU))) {
145 3
            $this->setLastEntityId($this->entityId = $product[MemberNames::ENTITY_ID]);
146 View Code Duplication
        } else {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
147
            // prepare a log message
148
            $message = sprintf('Product with SKU "%s" can\'t be loaded to create URL rewrites', $sku);
149
            // query whether or not we're in debug mode
150
            if ($this->getSubject()->isDebugMode()) {
151
                $this->getSubject()->getSystemLogger()->warning($message);
152
                return $this->getRow();
153
            } else {
154
                throw new \Exception($this->appendExceptionSuffix($message));
0 ignored issues
show
Deprecated Code introduced by
The method TechDivision\Import\Obse...appendExceptionSuffix() has been deprecated with message: Will be removed with version 1.0.0, use subject method instead

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
155
            }
156
        }
157
158
        // try to load the URL key
159 3
        if ($this->hasValue(ColumnKeys::URL_KEY)) {
160 3
            $this->urlKey = $this->getValue(ColumnKeys::URL_KEY);
161 View Code Duplication
        } else {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
162
            // prepare a log message
163
            $message = sprintf('Can\'t find a value in column "url_key" for product with SKU "%s"', $sku);
164
            // query whether or not we're in debug mode
165
            if ($this->getSubject()->isDebugMode()) {
166
                $this->getSubject()->getSystemLogger()->warning($message);
167
                return $this->getRow();
168
            } else {
169
                throw new \Exception($this->appendExceptionSuffix($message));
0 ignored issues
show
Deprecated Code introduced by
The method TechDivision\Import\Obse...appendExceptionSuffix() has been deprecated with message: Will be removed with version 1.0.0, use subject method instead

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
170
            }
171
        }
172
173
        // initialize the store view code
174 3
        $this->getSubject()->prepareStoreViewCode();
175
176
        // load the store view - if no store view has been set we use the admin store view as default
177 3
        $storeViewCode = $this->getSubject()->getStoreViewCode(StoreViewCodes::ADMIN);
178
179
        // query whether or not the row has already been processed
180 3 View Code Duplication
        if ($this->storeViewHasBeenProcessed($sku, $storeViewCode)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
181
            // log a message
182
            $this->getSubject()
183
                ->getSystemLogger()
184
                ->debug(
185
                    sprintf(
186
                        'URL rewrites for SKU "%s" + store view code "%s" has already been processed',
187
                        $sku,
188
                        $storeViewCode
189
                    )
190
                );
191
192
            // return without creating any rewrites
193
            return $this->getRow();
194
        };
195
196
        // stop processing as we don't want to create URL rewrites for the admin store view
197 3 View Code Duplication
        if ($storeViewCode === StoreViewCodes::ADMIN) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
198
            // log a message and return
199
            $this->getSubject()
200
                 ->getSystemLogger()
201
                 ->debug(
202
                     sprintf(
203
                         'Store with code "%s" is not active, no URL rewrites will be created for product with SKU "%s"',
204
                         $storeViewCode,
205
                         $sku
206
                     )
207
                 );
208
209
            // return without creating any rewrites
210
            return $this->getRow();
211
        }
212
213
        // stop processing if the store is NOT active
214 3 View Code Duplication
        if (!$this->getSubject()->storeIsActive($storeViewCode)) {
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface TechDivision\Import\Subjects\SubjectInterface as the method storeIsActive() does only exist in the following implementations of said interface: TechDivision\Import\Prod...jects\UrlRewriteSubject.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
Duplication introduced by
This code seems to be duplicated across 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...
215
            // log a message and return
216
            $this->getSubject()
217
                 ->getSystemLogger()
218
                 ->debug(
219
                     sprintf(
220
                         'Store with code "%s" is not active, no URL rewrites will be created for product with SKU "%s"',
221
                         $storeViewCode,
222
                         $sku
223
                     )
224
                 );
225
226
            // return without creating any rewrites
227
            return $this->getRow();
228
        }
229
230
        // only map the visibility for the product row related to the default store view
231 3
        if (!$this->hasBeenProcessed($sku)) {
232 3
            $this->addEntityIdVisibilityIdMapping($this->getValue(ColumnKeys::VISIBILITY));
233
        }
234
235
        // do NOT create new URL rewrites, if the product is NOT visible (any more), BUT
236
        // handle existing URL rewrites, e. g. to remove and clean up the URL rewrites
237 3
        if (!$this->isVisible()) {
238
            // log a message
239
            $this->getSubject()
240
                 ->getSystemLogger()
241
                 ->debug(
242
                     sprintf(
243
                         'Product with SKU "%s" is not visible, so no URL rewrites will be created',
244
                         $sku
245
                     )
246
                 );
247
248
            // return without creating any rewrites
249
            return $this->getRow();
250
        }
251
252
        // process the functionality and return the row
253 3
        $this->process();
254
255
        // return the processed row
256 3
        return $this->getRow();
257
    }
258
259
    /**
260
     * Process the observer's business logic.
261
     *
262
     * @return void
263
     */
264 3
    protected function process()
265
    {
266
267
        // prepare the URL rewrites
268 3
        $this->prepareUrlRewrites();
269
270
        // iterate over the categories and create the URL rewrites
271 3
        foreach ($this->urlRewrites as $categoryId => $urlRewrite) {
272
            // initialize and persist the URL rewrite
273 3
            if ($urlRewrite = $this->initializeUrlRewrite($urlRewrite)) {
274
                // initialize URL rewrite and catagory ID
275 3
                $this->categoryId = $categoryId;
0 ignored issues
show
Documentation Bug introduced by
It seems like $categoryId can also be of type string. However, the property $categoryId is declared as type integer. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
276
277
                try {
278
                    // persist the URL rewrite
279 3
                    $this->urlRewriteId = $this->persistUrlRewrite($urlRewrite);
0 ignored issues
show
Documentation Bug introduced by
The property $urlRewriteId was declared of type integer, but $this->persistUrlRewrite($urlRewrite) is of type string. Maybe add a type cast?

This check looks for assignments to scalar types that may be of the wrong type.

To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.

$answer = 42;

$correct = false;

$correct = (bool) $answer;
Loading history...
280
281
                    /*
282
                     * Attention! Stop processing, if this is a root category, because Magento needs explicitly
283
                     * NO URL rewrite product category relation to render canonical and meta og:url tag!
284
                     */
285 3
                    if ($this->isRootCategory($this->getCategory($categoryId))) {
286 3
                        continue;
287
                    }
288
289
                    // initialize and persist the URL rewrite product => category relation
290 2
                    $urlRewriteProductCategory = $this->initializeUrlRewriteProductCategory(
291 2
                        $this->prepareUrlRewriteProductCategoryAttributes()
292
                    );
293
294
                    // persist the URL rewrite product category relation
295 2
                    $this->persistUrlRewriteProductCategory($urlRewriteProductCategory);
296
                } catch (\Exception $e) {
297
                    // query whether or not debug mode has been enabled
298 View Code Duplication
                    if ($this->getSubject()->isDebugMode()) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
299
                        $this->getSubject()
300
                             ->getSystemLogger()
301
                             ->warning($this->getSubject()->appendExceptionSuffix($e->getMessage()));
302
                    } else {
303
                        throw $e;
304
                    }
305
                }
306
            }
307
        }
308 3
    }
309
310
    /**
311
     * Initialize the category product with the passed attributes and returns an instance.
312
     *
313
     * @param array $attr The category product attributes
314
     *
315
     * @return array The initialized category product
316
     */
317 2
    protected function initializeUrlRewrite(array $attr)
318
    {
319 2
        return $attr;
320
    }
321
322
    /**
323
     * Initialize the URL rewrite product => category relation with the passed attributes
324
     * and returns an instance.
325
     *
326
     * @param array $attr The URL rewrite product => category relation attributes
327
     *
328
     * @return array The initialized URL rewrite product => category relation
329
     */
330 1
    protected function initializeUrlRewriteProductCategory($attr)
331
    {
332 1
        return $attr;
333
    }
334
335
    /**
336
     * Prepare's the URL rewrites that has to be created/updated.
337
     *
338
     * @return void
339
     */
340 3
    protected function prepareUrlRewrites()
341
    {
342
343
        // (re-)initialize the array for the URL rewrites and the product category IDs
344 3
        $this->urlRewrites = array();
345 3
        $this->productCategoryIds = array();
346
347
        // load the root category, because we need that to create the default product URL rewrite
348 3
        $rootCategory = $this->getRootCategory();
349
350
        // at least, add the root category ID to the category => product relations
351 3
        $this->productCategoryIds[] = $rootCategory[MemberNames::ENTITY_ID];
352
353 3
        $storeViewCode = $this->getValue(ColumnKeys::STORE_VIEW_CODE);
354
355
        // append the category => product relations found
356 3
        foreach ($this->getValue(ColumnKeys::CATEGORIES, array(), array($this, 'explode')) as $path) {
357
            try {
358
                // try to load the category for the given path
359 2
                $category = $this->getCategoryByPath(trim($path), $storeViewCode);
360
                // resolve the product's categories recursively
361 2
                $this->resolveCategoryIds($category[MemberNames::ENTITY_ID], true, $storeViewCode);
362
            } catch (\Exception $e) {
363
                // query whether or not debug mode has been enabled
364 View Code Duplication
                if ($this->getSubject()->isDebugMode()) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
365
                    $this->getSubject()
366
                         ->getSystemLogger()
367
                         ->warning($this->getSubject()->appendExceptionSuffix($e->getMessage()));
368
                } else {
369
                    throw $e;
370
                }
371
            }
372
        }
373
374
        // prepare the URL rewrites
375 3
        foreach ($this->productCategoryIds as $categoryId) {
376
            // set the category ID
377 3
            $this->categoryId = $categoryId;
378
379
            // prepare the attributes for each URL rewrite
380 3
            $this->urlRewrites[$categoryId] = $this->prepareAttributes($storeViewCode);
381
        }
382 3
    }
383
384
    /**
385
     * Resolve's the parent categories of the category with the passed ID and relate's
386
     * it with the product with the passed ID, if the category is top level OR has the
387
     * anchor flag set.
388
     *
389
     * @param integer $categoryId    The ID of the category to resolve the parents
390
     * @param boolean $topLevel      TRUE if the passed category has top level, else FALSE
391
     * @param string  $storeViewCode The store view code to resolve the category IDs for
392
     *
393
     * @return void
394
     */
395 2
    protected function resolveCategoryIds($categoryId, $topLevel = false, $storeViewCode = StoreViewCodes::ADMIN)
396
    {
397
398
        // return immediately if this is the absolute root node
399 2
        if ((integer) $categoryId === 1) {
400 2
            return;
401
        }
402
403
        // load the data of the category with the passed ID
404 2
        $category = $this->getCategory($categoryId, $storeViewCode);
405
406
        // query whether or not the product has already been related
407 2
        if (!in_array($categoryId, $this->productCategoryIds)) {
408 2
            if ($topLevel) {
409
                // relate it, if the category is top level
410 2
                $this->productCategoryIds[] = $categoryId;
411 2
            } elseif ((integer) $category[MemberNames::IS_ANCHOR] === 1) {
412
                // also relate it, if the category is not top level, but has the anchor flag set
413
                $this->productCategoryIds[] = $categoryId;
414
            } else {
415 2
                $this->getSubject()
416 2
                     ->getSystemLogger()
417 2
                     ->debug(sprintf('Don\'t create URL rewrite for category "%s" because of missing anchor flag', $category[MemberNames::PATH]));
418
            }
419
        }
420
421
        // load the root category
422 2
        $rootCategory = $this->getRootCategory();
423
424
        // try to resolve the parent category IDs
425 2
        if ($rootCategory[MemberNames::ENTITY_ID] !== ($parentId = $category[MemberNames::PARENT_ID])) {
426 2
            $this->resolveCategoryIds($parentId, false);
427
        }
428 2
    }
429
430
    /**
431
     * Prepare the attributes of the entity that has to be persisted.
432
     *
433
     * @param string $storeViewCode The store view code to prepare the attributes for
434
     *
435
     * @return array The prepared attributes
436
     */
437 3
    protected function prepareAttributes($storeViewCode)
438
    {
439
440
        // load the store ID to use
441 3
        $storeId = $this->getSubject()->getRowStoreId();
0 ignored issues
show
Bug introduced by
The method getRowStoreId() does not exist on TechDivision\Import\Subjects\SubjectInterface. Did you maybe mean getRow()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
442
443
        // load the category to create the URL rewrite for
444 3
        $category = $this->getCategory($this->categoryId, $storeViewCode);
445
446
        // initialize the values
447 3
        $metadata = $this->prepareMetadata($category);
448 3
        $targetPath = $this->prepareTargetPath($category);
449 3
        $requestPath = $this->prepareRequestPath($category);
450
451
        // return the prepared URL rewrite
452 3
        return $this->initializeEntity(
453
            array(
454 3
                MemberNames::ENTITY_TYPE      => UrlRewriteObserver::ENTITY_TYPE,
455 3
                MemberNames::ENTITY_ID        => $this->entityId,
456 3
                MemberNames::REQUEST_PATH     => $requestPath,
457 3
                MemberNames::TARGET_PATH      => $targetPath,
458 3
                MemberNames::REDIRECT_TYPE    => 0,
459 3
                MemberNames::STORE_ID         => $storeId,
460 3
                MemberNames::DESCRIPTION      => null,
461 3
                MemberNames::IS_AUTOGENERATED => 1,
462 3
                MemberNames::METADATA         => $metadata ? json_encode($metadata) : null
463
            )
464
        );
465
    }
466
467
    /**
468
     * Prepare's the URL rewrite product => category relation attributes.
469
     *
470
     * @return array The prepared attributes
471
     */
472 2
    protected function prepareUrlRewriteProductCategoryAttributes()
473
    {
474
475
        // return the prepared product
476 2
        return $this->initializeEntity(
477
            array(
478 2
                MemberNames::PRODUCT_ID     => $this->entityId,
479 2
                MemberNames::CATEGORY_ID    => $this->categoryId,
480 2
                MemberNames::URL_REWRITE_ID => $this->urlRewriteId
481
            )
482
        );
483
    }
484
485
    /**
486
     * Prepare's the target path for a URL rewrite.
487
     *
488
     * @param array $category The categroy with the URL path
489
     *
490
     * @return string The target path
491
     */
492 3
    protected function prepareTargetPath(array $category)
493
    {
494
495
        // query whether or not, the category is the root category
496 3
        if ($this->isRootCategory($category)) {
497 3
            $targetPath = sprintf('catalog/product/view/id/%d', $this->entityId);
498
        } else {
499 2
            $targetPath = sprintf('catalog/product/view/id/%d/category/%d', $this->entityId, $category[MemberNames::ENTITY_ID]);
500
        }
501
502
        // return the target path
503 3
        return $targetPath;
504
    }
505
506
    /**
507
     * Prepare's the request path for a URL rewrite or the target path for a 301 redirect.
508
     *
509
     * @param array $category The categroy with the URL path
510
     *
511
     * @return string The request path
512
     * @throws \RuntimeException Is thrown, if the passed category has no or an empty value for attribute "url_path"
513
     */
514 3
    protected function prepareRequestPath(array $category)
515
    {
516
517
        // load the product URL suffix to use
518 3
        $urlSuffix = $this->getSubject()->getCoreConfigData(CoreConfigDataKeys::CATALOG_SEO_PRODUCT_URL_SUFFIX, '.html');
519
520
        // query whether or not, the category is the root category
521 3
        if ($this->isRootCategory($category)) {
522 3
            return sprintf('%s%s', $this->urlKey, $urlSuffix);
523
        } else {
524
            // query whether or not the category's "url_path" attribute, necessary to create a valid "request_path", is available
525 2
            if (isset($category[MemberNames::URL_PATH]) && $category[MemberNames::URL_PATH]) {
526 2
                return sprintf('%s/%s%s', $category[MemberNames::URL_PATH], $this->urlKey, $urlSuffix);
527
            }
528
        }
529
530
        // throw an exception if the category's "url_path" attribute is NOT available
531
        throw new \RuntimeException(
532
            $this->appendExceptionSuffix(
0 ignored issues
show
Deprecated Code introduced by
The method TechDivision\Import\Obse...appendExceptionSuffix() has been deprecated with message: Will be removed with version 1.0.0, use subject method instead

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
533
                sprintf(
534
                    'Can\'t find mandatory attribute "%s" for category ID "%d", necessary to build a valid "request_path"',
535
                    MemberNames::URL_PATH,
536
                    $category[MemberNames::ENTITY_ID]
537
                )
538
            )
539
        );
540
    }
541
542
    /**
543
     * Prepare's the URL rewrite's metadata with the passed category values.
544
     *
545
     * @param array $category The category used for preparation
546
     *
547
     * @return array|null The metadata
548
     */
549 3
    protected function prepareMetadata(array $category)
550
    {
551
552
        // initialize the metadata
553 3
        $metadata = array();
554
555
        // query whether or not, the passed category IS the root category
556 3
        if ($this->isRootCategory($category)) {
557 3
            return;
558
        }
559
560
        // if not, set the category ID in the metadata
561 2
        $metadata[UrlRewriteObserver::CATEGORY_ID] = (integer) $category[MemberNames::ENTITY_ID];
562
563
        // return the metadata
564 2
        return $metadata;
565
    }
566
567
    /**
568
     * Query whether or not the actual entity is visible.
569
     *
570
     * @return boolean TRUE if the entity is visible, else FALSE
571
     */
572 3
    protected function isVisible()
573
    {
574 3
        return $this->getEntityIdVisibilityIdMapping() !== VisibilityKeys::VISIBILITY_NOT_VISIBLE;
575
    }
576
577
    /**
578
     * Return's the visibility for the passed entity ID, if it already has been mapped. The mapping will be created
579
     * by calling <code>\TechDivision\Import\Product\Subjects\BunchSubject::getVisibilityIdByValue</code> which will
580
     * be done by the <code>\TechDivision\Import\Product\Callbacks\VisibilityCallback</code>.
581
     *
582
     * @return integer The visibility ID
583
     * @throws \Exception Is thrown, if the entity ID has not been mapped
584
     * @see \TechDivision\Import\Product\Subjects\BunchSubject::getVisibilityIdByValue()
585
     */
586 3
    protected function getEntityIdVisibilityIdMapping()
587
    {
588 3
        return $this->getSubject()->getEntityIdVisibilityIdMapping();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface TechDivision\Import\Subjects\SubjectInterface as the method getEntityIdVisibilityIdMapping() does only exist in the following implementations of said interface: TechDivision\Import\Prod...jects\UrlRewriteSubject.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
589
    }
590
591
    /**
592
     * Return's the root category for the actual view store.
593
     *
594
     * @return array The store's root category
595
     * @throws \Exception Is thrown if the root category for the passed store code is NOT available
596
     */
597 3
    protected function getRootCategory()
598
    {
599 3
        return $this->getSubject()->getRootCategory();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface TechDivision\Import\Subjects\SubjectInterface as the method getRootCategory() does only exist in the following implementations of said interface: TechDivision\Import\Prod...\AbstractProductSubject, TechDivision\Import\Product\Subjects\BunchSubject, TechDivision\Import\Prod...jects\UrlRewriteSubject, TechDivision\Import\Subjects\AbstractEavSubject, TechDivision\Import\Subjects\AbstractSubject, TechDivision\Import\Subjects\MoveFilesSubject.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
600
    }
601
602
    /**
603
     * Return's TRUE if the passed category IS the root category, else FALSE.
604
     *
605
     * @param array $category The category to query
606
     *
607
     * @return boolean TRUE if the passed category IS the root category
608
     */
609 3
    protected function isRootCategory(array $category)
610
    {
611
612
        // load the root category
613 3
        $rootCategory = $this->getRootCategory();
614
615
        // compare the entity IDs and return the result
616 3
        return $rootCategory[MemberNames::ENTITY_ID] === $category[MemberNames::ENTITY_ID];
617
    }
618
619
    /**
620
     * Return's the category with the passed path.
621
     *
622
     * @param string $path          The path of the category to return
623
     * @param string $storeViewCode The store view code of the category to return
624
     *
625
     * @return array The category
626
     */
627 2
    protected function getCategoryByPath($path, $storeViewCode = StoreViewCodes::ADMIN)
628
    {
629 2
        return $this->getSubject()->getCategoryByPath($path, $storeViewCode);
0 ignored issues
show
Bug introduced by
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\Prod...\AbstractProductSubject, TechDivision\Import\Product\Subjects\BunchSubject, TechDivision\Import\Prod...jects\UrlRewriteSubject.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
630
    }
631
632
    /**
633
     * Return's the category with the passed ID.
634
     *
635
     * @param integer $categoryId    The ID of the category to return
636
     * @param string  $storeViewCode The store view code of category to return
637
     *
638
     * @return array The category data
639
     */
640 2
    protected function getCategory($categoryId, $storeViewCode = StoreViewCodes::ADMIN)
641
    {
642 2
        return $this->getSubject()->getCategory($categoryId, $storeViewCode);
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface TechDivision\Import\Subjects\SubjectInterface as the method getCategory() does only exist in the following implementations of said interface: TechDivision\Import\Prod...\AbstractProductSubject, TechDivision\Import\Product\Subjects\BunchSubject, TechDivision\Import\Prod...jects\UrlRewriteSubject.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
643
    }
644
645
    /**
646
     * Persist's the URL rewrite with the passed data.
647
     *
648
     * @param array $row The URL rewrite to persist
649
     *
650
     * @return string The ID of the persisted entity
651
     */
652 3
    protected function persistUrlRewrite($row)
653
    {
654 3
        return $this->getProductUrlRewriteProcessor()->persistUrlRewrite($row);
655
    }
656
657
    /**
658
     * Persist's the URL rewrite product => category relation with the passed data.
659
     *
660
     * @param array $row The URL rewrite product => category relation to persist
661
     *
662
     * @return void
663
     */
664 2
    protected function persistUrlRewriteProductCategory($row)
665
    {
666 2
        return $this->getProductUrlRewriteProcessor()->persistUrlRewriteProductCategory($row);
667
    }
668
669
    /**
670
     * Queries whether or not the passed SKU and store view code has already been processed.
671
     *
672
     * @param string $sku           The SKU to check been processed
673
     * @param string $storeViewCode The store view code to check been processed
674
     *
675
     * @return boolean TRUE if the SKU and store view code has been processed, else FALSE
676
     */
677 3
    protected function storeViewHasBeenProcessed($sku, $storeViewCode)
678
    {
679 3
        return $this->getSubject()->storeViewHasBeenProcessed($sku, $storeViewCode);
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface TechDivision\Import\Subjects\SubjectInterface as the method storeViewHasBeenProcessed() does only exist in the following implementations of said interface: TechDivision\Import\Prod...\AbstractProductSubject, TechDivision\Import\Product\Subjects\BunchSubject, TechDivision\Import\Prod...jects\UrlRewriteSubject.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
680
    }
681
682
    /**
683
     * Add the entity ID => visibility mapping for the actual entity ID.
684
     *
685
     * @param string $visibility The visibility of the actual entity to map
686
     *
687
     * @return void
688
     */
689 3
    protected function addEntityIdVisibilityIdMapping($visibility)
690
    {
691 3
        $this->getSubject()->addEntityIdVisibilityIdMapping($visibility);
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface TechDivision\Import\Subjects\SubjectInterface as the method addEntityIdVisibilityIdMapping() does only exist in the following implementations of said interface: TechDivision\Import\Prod...jects\UrlRewriteSubject.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
692 3
    }
693
694
    /**
695
     * Set's the ID of the product that has been created recently.
696
     *
697
     * @param string $lastEntityId The entity ID
698
     *
699
     * @return void
700
     */
701 3
    protected function setLastEntityId($lastEntityId)
702
    {
703 3
        $this->getSubject()->setLastEntityId($lastEntityId);
0 ignored issues
show
Bug introduced by
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\Prod...jects\UrlRewriteSubject, 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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
704 3
    }
705
706
    /**
707
     * Load's and return's the product with the passed SKU.
708
     *
709
     * @param string $sku The SKU of the product to load
710
     *
711
     * @return array The product
712
     */
713 3
    protected function loadProduct($sku)
714
    {
715 3
        return $this->getProductUrlRewriteProcessor()->loadProduct($sku);
716
    }
717
}
718