Completed
Pull Request — master (#96)
by Tim
04:00
created

AbstractSubject::mapAttributeCodeByHeaderMapping()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 14
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 5
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 14
ccs 5
cts 5
cp 1
rs 9.4285
c 0
b 0
f 0
cc 2
eloc 5
nc 2
nop 1
crap 2

1 Method

Rating   Name   Duplication   Size   Complexity  
A AbstractSubject::getDefaultStore() 0 4 1
1
<?php
2
3
/**
4
 * TechDivision\Import\Subjects\AbstractSubject
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
18
 * @link      http://www.techdivision.com
19
 */
20
21
namespace TechDivision\Import\Subjects;
22
23
use Doctrine\Common\Collections\Collection;
24
use TechDivision\Import\RowTrait;
25
use TechDivision\Import\HeaderTrait;
26
use TechDivision\Import\SystemLoggerTrait;
27
use TechDivision\Import\Utils\ScopeKeys;
28
use TechDivision\Import\Utils\ColumnKeys;
29
use TechDivision\Import\Utils\MemberNames;
30
use TechDivision\Import\Utils\RegistryKeys;
31
use TechDivision\Import\Utils\Generators\GeneratorInterface;
32
use TechDivision\Import\Callbacks\CallbackInterface;
33
use TechDivision\Import\Observers\ObserverInterface;
34
use TechDivision\Import\Adapter\ImportAdapterInterface;
35
use TechDivision\Import\Exceptions\WrappedColumnException;
36
use TechDivision\Import\Services\RegistryProcessorInterface;
37
use TechDivision\Import\Configuration\SubjectConfigurationInterface;
38
39
/**
40
 * An abstract subject implementation.
41
 *
42
 * @author    Tim Wagner <[email protected]>
43
 * @copyright 2016 TechDivision GmbH <[email protected]>
44
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
45
 * @link      https://github.com/techdivision/import
46
 * @link      http://www.techdivision.com
47
 */
48
abstract class AbstractSubject implements SubjectInterface
49
{
50
51
    /**
52
     * The trait that provides basic filesystem handling functionality.
53
     *
54
     * @var TechDivision\Import\Subjects\FilesystemTrait
55
     */
56
    use FilesystemTrait;
57
58
    /**
59
     * The trait that provides basic filesystem handling functionality.
60
     *
61
     * @var TechDivision\Import\SystemLoggerTrait
62
     */
63
    use SystemLoggerTrait;
64
65
    /**
66
     * The trait that provides header handling functionality.
67
     *
68
     * @var TechDivision\Import\HeaderTrait
69
     */
70
    use HeaderTrait;
71
72
    /**
73
     * The trait that provides row handling functionality.
74
     *
75
     * @var TechDivision\Import\RowTrait
76
     */
77
    use RowTrait;
78
79
    /**
80
     * The name of the file to be imported.
81
     *
82
     * @var string
83
     */
84
    protected $filename;
85
86
    /**
87
     * The actual line number.
88
     *
89
     * @var integer
90
     */
91
    protected $lineNumber = 0;
92
93
    /**
94
     * The actual operation name.
95
     *
96
     * @var string
97
     */
98
    protected $operationName ;
99
100
    /**
101
     * The flag that stop's overserver execution on the actual row.
102
     *
103
     * @var boolean
104
     */
105
    protected $skipRow = false;
106
107
    /**
108
     * The import adapter instance.
109
     *
110
     * @var \TechDivision\Import\Adapter\ImportAdapterInterface
111
     */
112
    protected $importAdapter;
113
114
    /**
115
     * The system configuration.
116
     *
117
     * @var \TechDivision\Import\Configuration\SubjectConfigurationInterface
118
     */
119
    protected $configuration;
120
121
    /**
122
     * The RegistryProcessor instance to handle running threads.
123
     *
124
     * @var \TechDivision\Import\Services\RegistryProcessorInterface
125
     */
126
    protected $registryProcessor;
127
128
    /**
129
     * The actions unique serial.
130
     *
131
     * @var string
132
     */
133
    protected $serial;
134
135
    /**
136
     * Array with the subject's observers.
137
     *
138
     * @var array
139
     */
140
    protected $observers = array();
141
142
    /**
143
     * Array with the subject's callbacks.
144
     *
145
     * @var array
146
     */
147
    protected $callbacks = array();
148
149
    /**
150
     * The subject's callback mappings.
151
     *
152
     * @var array
153
     */
154
    protected $callbackMappings = array();
155
156
    /**
157
     * The available root categories.
158
     *
159
     * @var array
160
     */
161
    protected $rootCategories = array();
162
163
    /**
164
     * The Magento configuration.
165
     *
166
     * @var array
167
     */
168
    protected $coreConfigData = array();
169
170
    /**
171
     * The available stores.
172
     *
173
     * @var array
174
     */
175
    protected $stores = array();
176
177
    /**
178
     * The available websites.
179
     *
180
     * @var array
181
     */
182
    protected $storeWebsites = array();
183
184
    /**
185
     * The default store.
186
     *
187
     * @var array
188
     */
189
    protected $defaultStore;
190
191
    /**
192
     * The store view code the create the product/attributes for.
193
     *
194
     * @var string
195
     */
196
    protected $storeViewCode;
197
198
    /**
199
     * The UID generator for the core config data.
200
     *
201
     * @var \TechDivision\Import\Utils\Generators\GeneratorInterface
202
     */
203
    protected $coreConfigDataUidGenerator;
204
205
    /**
206
     * Initialize the subject instance.
207
     *
208
     * @param \TechDivision\Import\Services\RegistryProcessorInterface $registryProcessor          The registry processor instance
209
     * @param \TechDivision\Import\Utils\Generators\GeneratorInterface $coreConfigDataUidGenerator The UID generator for the core config data
210
     * @param \Doctrine\Common\Collections\Collection                  $systemLoggers              The array with the system loggers instances
211
     */
212 77
    public function __construct(
213
        RegistryProcessorInterface $registryProcessor,
214
        GeneratorInterface $coreConfigDataUidGenerator,
215
        Collection $systemLoggers
216
    ) {
217 77
        $this->systemLoggers = $systemLoggers;
0 ignored issues
show
Documentation Bug introduced by
It seems like $systemLoggers of type object<Doctrine\Common\Collections\Collection> is incompatible with the declared type array of property $systemLoggers.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
218 77
        $this->registryProcessor = $registryProcessor;
219 77
        $this->coreConfigDataUidGenerator = $coreConfigDataUidGenerator;
220 77
    }
221
222
    /**
223
     * Set's the name of the file to import
224
     *
225
     * @param string $filename The filename
226
     *
227
     * @return void
228
     */
229 10
    public function setFilename($filename)
230
    {
231 10
        $this->filename = $filename;
232 10
    }
233
234
    /**
235
     * Return's the name of the file to import.
236
     *
237
     * @return string The filename
238
     */
239 8
    public function getFilename()
240
    {
241 8
        return $this->filename;
242
    }
243
244
    /**
245
     * Set's the actual operation name.
246
     *
247
     * @param string $operationName The actual operation name
248
     *
249
     * @return void
250
     */
251 1
    public function setOperationName($operationName)
252
    {
253 1
        $this->operationName = $operationName;
254 1
    }
255
256
    /**
257
     * Return's the actual operation name.
258
     *
259
     * @return string
260
     */
261 1
    public function getOperationName()
262
    {
263 1
        return $this->operationName;
264
    }
265
266
    /**
267
     * Set's the actual line number.
268
     *
269
     * @param integer $lineNumber The line number
270
     *
271
     * @return void
272
     */
273 1
    public function setLineNumber($lineNumber)
274
    {
275 1
        $this->lineNumber = $lineNumber;
276 1
    }
277
278
    /**
279
     * Return's the actual line number.
280
     *
281
     * @return integer The line number
282
     */
283 9
    public function getLineNumber()
284
    {
285 9
        return $this->lineNumber;
286
    }
287
288
    /**
289
     * Stop's observer execution on the actual row.
290
     *
291
     * @return void
292
     */
293 1
    public function skipRow()
294
    {
295 1
        $this->skipRow = true;
296 1
    }
297
298
    /**
299
     * Return's the default callback mappings.
300
     *
301
     * @return array The default callback mappings
302
     */
303 1
    public function getDefaultCallbackMappings()
304
    {
305 1
        return array();
306
    }
307
308
    /**
309
     * Tries to format the passed value to a valid date with format 'Y-m-d H:i:s'.
310
     * If the passed value is NOT a valid date, NULL will be returned.
311
     *
312
     * @param string $value The value to format
313
     *
314
     * @return string|null The formatted date or NULL if the date is not valid
315
     */
316 2
    public function formatDate($value)
317
    {
318
319
        // create a DateTime instance from the passed value
320 2
        if ($dateTime = \DateTime::createFromFormat($this->getSourceDateFormat(), $value)) {
321 1
            return $dateTime->format('Y-m-d H:i:s');
322
        }
323
324
        // return NULL, if the passed value is NOT a valid date
325 1
        return null;
326
    }
327
328
    /**
329
     * Extracts the elements of the passed value by exploding them
330
     * with the also passed delimiter.
331
     *
332
     * @param string      $value     The value to extract
333
     * @param string|null $delimiter The delimiter used to extrace the elements
334
     *
335
     * @return array The exploded values
336
     */
337 2
    public function explode($value, $delimiter = null)
338
    {
339
        // load the global configuration
340 2
        $configuration = $this->getConfiguration();
341
342
        // initializet delimiter, enclosure and escape char
343 2
        $delimiter = $delimiter ? $delimiter : $configuration->getDelimiter();
344 2
        $enclosure = $configuration->getEnclosure();
345 2
        $escape = $configuration->getEscape();
346
347
        // parse and return the found data as array
348 2
        return str_getcsv($value, $delimiter, $enclosure, $escape);
349
    }
350
351
    /**
352
     * Queries whether or not debug mode is enabled or not, default is TRUE.
353
     *
354
     * @return boolean TRUE if debug mode is enabled, else FALSE
355
     */
356 1
    public function isDebugMode()
357
    {
358 1
        return $this->getConfiguration()->isDebugMode();
359
    }
360
361
    /**
362
     * Set's the subject configuration.
363
     *
364
     * @param \TechDivision\Import\Configuration\SubjectConfigurationInterface $configuration The subject configuration
365
     *
366
     * @return void
367
     */
368 77
    public function setConfiguration(SubjectConfigurationInterface $configuration)
369
    {
370 77
        $this->configuration = $configuration;
371 77
    }
372
373
    /**
374
     * Return's the subject configuration.
375
     *
376
     * @return \TechDivision\Import\Configuration\SubjectConfigurationInterface The subject configuration
377
     */
378 77
    public function getConfiguration()
379
    {
380 77
        return $this->configuration;
381
    }
382
383
    /**
384
     * Set's the import adapter instance.
385
     *
386
     * @param \TechDivision\Import\Adapter\ImportAdapterInterface $importAdapter The import adapter instance
387
     *
388
     * @return void
389
     */
390 3
    public function setImportAdapter(ImportAdapterInterface $importAdapter)
391
    {
392 3
        $this->importAdapter = $importAdapter;
393 3
    }
394
395
    /**
396
     * Return's the import adapter instance.
397
     *
398
     * @return \TechDivision\Import\Adapter\ImportAdapterInterface The import adapter instance
399
     */
400 3
    public function getImportAdapter()
401
    {
402 3
        return $this->importAdapter;
403
    }
404
405
    /**
406
     * Return's the RegistryProcessor instance to handle the running threads.
407
     *
408
     * @return \TechDivision\Import\Services\RegistryProcessorInterface The registry processor instance
409
     */
410 77
    public function getRegistryProcessor()
411
    {
412 77
        return $this->registryProcessor;
413
    }
414
415
    /**
416
     * Set's the unique serial for this import process.
417
     *
418
     * @param string $serial The unique serial
419
     *
420
     * @return void
421
     */
422 9
    public function setSerial($serial)
423
    {
424 9
        $this->serial = $serial;
425 9
    }
426
427
    /**
428
     * Return's the unique serial for this import process.
429
     *
430
     * @return string The unique serial
431
     */
432 4
    public function getSerial()
433
    {
434 4
        return $this->serial;
435
    }
436
437
    /**
438
     * Return's the source date format to use.
439
     *
440
     * @return string The source date format
441
     */
442 4
    public function getSourceDateFormat()
443
    {
444 4
        return $this->getConfiguration()->getSourceDateFormat();
445
    }
446
447
    /**
448
     * Return's the multiple field delimiter character to use, default value is comma (,).
449
     *
450
     * @return string The multiple field delimiter character
451
     */
452 1
    public function getMultipleFieldDelimiter()
453
    {
454 1
        return $this->getConfiguration()->getMultipleFieldDelimiter();
455
    }
456
457
    /**
458
     * Return's the multiple value delimiter character to use, default value is comma (|).
459
     *
460
     * @return string The multiple value delimiter character
461
     */
462 1
    public function getMultipleValueDelimiter()
463
    {
464 1
        return $this->getConfiguration()->getMultipleValueDelimiter();
465
    }
466
467
    /**
468
     * Intializes the previously loaded global data for exactly one bunch.
469
     *
470
     * @param string $serial The serial of the actual import
471
     *
472
     * @return void
473
     */
474 77
    public function setUp($serial)
475
    {
476
477
        // load the status of the actual import
478 77
        $status = $this->getRegistryProcessor()->getAttribute($serial);
479
480
        // load the global data we've prepared initially
481 77
        $this->stores = $status[RegistryKeys::GLOBAL_DATA][RegistryKeys::STORES];
482 77
        $this->defaultStore = $status[RegistryKeys::GLOBAL_DATA][RegistryKeys::DEFAULT_STORE];
483 77
        $this->storeWebsites  = $status[RegistryKeys::GLOBAL_DATA][RegistryKeys::STORE_WEBSITES];
484 77
        $this->rootCategories = $status[RegistryKeys::GLOBAL_DATA][RegistryKeys::ROOT_CATEGORIES];
485 77
        $this->coreConfigData = $status[RegistryKeys::GLOBAL_DATA][RegistryKeys::CORE_CONFIG_DATA];
486
487
        // initialize the operation name
488 77
        $this->operationName = $this->getConfiguration()->getConfiguration()->getOperationName();
489
490
        // merge the callback mappings with the mappings from the child instance
491 77
        $this->callbackMappings = array_merge($this->callbackMappings, $this->getDefaultCallbackMappings());
492
493
        // merge the callback mappings the the one from the configuration file
494 77
        foreach ($this->getConfiguration()->getCallbacks() as $callbackMappings) {
495 77
            foreach ($callbackMappings as $attributeCode => $mappings) {
496
                // write a log message, that default callback configuration will
497
                // be overwritten with the one from the configuration file
498 77
                if (isset($this->callbackMappings[$attributeCode])) {
499 72
                    $this->getSystemLogger()->notice(
500 72
                        sprintf('Now override callback mappings for attribute %s with values found in configuration file', $attributeCode)
501
                    );
502
                }
503
504
                // override the attributes callbacks
505 77
                $this->callbackMappings[$attributeCode] = $mappings;
506
            }
507
        }
508 77
    }
509
510
    /**
511
     * Clean up the global data after importing the variants.
512
     *
513
     * @param string $serial The serial of the actual import
514
     *
515
     * @return void
516
     */
517 1
    public function tearDown($serial)
518
    {
519
520
        // load the registry processor
521 1
        $registryProcessor = $this->getRegistryProcessor();
522
523
        // update the source directory for the next subject
524 1
        $registryProcessor->mergeAttributesRecursive(
525 1
            $serial,
526 1
            array(RegistryKeys::SOURCE_DIRECTORY => $newSourceDir = $this->getNewSourceDir($serial))
527
        );
528
529
        // log a debug message with the new source directory
530 1
        $this->getSystemLogger()->info(
531 1
            sprintf('Subject %s successfully updated source directory to %s', get_class($this), $newSourceDir)
532
        );
533 1
    }
534
535
    /**
536
     * Return's the target directory for the artefact export.
537
     *
538
     * @return string The target directory for the artefact export
539
     */
540 1
    public function getTargetDir()
541
    {
542 1
        return $this->getNewSourceDir($this->getSerial());
543
    }
544
545
    /**
546
     * Return's the next source directory, which will be the target directory
547
     * of this subject, in most cases.
548
     *
549
     * @param string $serial The serial of the actual import
550
     *
551
     * @return string The new source directory
552
     */
553 4
    public function getNewSourceDir($serial)
554
    {
555 4
        return sprintf('%s/%s', $this->getConfiguration()->getTargetDir(), $serial);
556
    }
557
558
    /**
559
     * Register the passed observer with the specific type.
560
     *
561
     * @param \TechDivision\Import\Observers\ObserverInterface $observer The observer to register
562
     * @param string                                           $type     The type to register the observer with
563
     *
564
     * @return void
565
     */
566 6
    public function registerObserver(ObserverInterface $observer, $type)
567
    {
568
569
        // query whether or not the array with the callbacks for the
570
        // passed type has already been initialized, or not
571 6
        if (!isset($this->observers[$type])) {
572 6
            $this->observers[$type] = array();
573
        }
574
575
        // append the callback with the instance of the passed type
576 6
        $this->observers[$type][] = $observer;
577 6
    }
578
579
    /**
580
     * Register the passed callback with the specific type.
581
     *
582
     * @param \TechDivision\Import\Callbacks\CallbackInterface $callback The subject to register the callbacks for
583
     * @param string                                           $type     The type to register the callback with
584
     *
585
     * @return void
586
     */
587 2
    public function registerCallback(CallbackInterface $callback, $type)
588
    {
589
590
        // query whether or not the array with the callbacks for the
591
        // passed type has already been initialized, or not
592 2
        if (!isset($this->callbacks[$type])) {
593 2
            $this->callbacks[$type] = array();
594
        }
595
596
        // append the callback with the instance of the passed type
597 2
        $this->callbacks[$type][] = $callback;
598 2
    }
599
600
    /**
601
     * Return's the array with callbacks for the passed type.
602
     *
603
     * @param string $type The type of the callbacks to return
604
     *
605
     * @return array The callbacks
606
     */
607 1
    public function getCallbacksByType($type)
608
    {
609
610
        // initialize the array for the callbacks
611 1
        $callbacks = array();
612
613
        // query whether or not callbacks for the type are available
614 1
        if (isset($this->callbacks[$type])) {
615 1
            $callbacks = $this->callbacks[$type];
616
        }
617
618
        // return the array with the type's callbacks
619 1
        return $callbacks;
620
    }
621
622
    /**
623
     * Return's the array with the available observers.
624
     *
625
     * @return array The observers
626
     */
627 6
    public function getObservers()
628
    {
629 6
        return $this->observers;
630
    }
631
632
    /**
633
     * Return's the array with the available callbacks.
634
     *
635
     * @return array The callbacks
636
     */
637 1
    public function getCallbacks()
638
    {
639 1
        return $this->callbacks;
640
    }
641
642
    /**
643
     * Return's the callback mappings for this subject.
644
     *
645
     * @return array The array with the subject's callback mappings
646
     */
647 2
    public function getCallbackMappings()
648
    {
649 2
        return $this->callbackMappings;
650
    }
651
652
    /**
653
     * Imports the content of the file with the passed filename.
654
     *
655
     *
656
     * @param string $serial   The serial of the actual import
657
     * @param string $filename The filename to process
658
     *
659
     * @return void
660
     * @throws \Exception Is thrown, if the import can't be processed
661
     */
662 5
    public function import($serial, $filename)
663
    {
664
665
        try {
666
            // stop processing, if the filename doesn't match
667 5
            if (!$this->match($filename)) {
668 1
                return;
669
            }
670
671
            // load the system logger instance
672 4
            $systemLogger = $this->getSystemLogger();
673
674
            // prepare the flag filenames
675 4
            $inProgressFilename = sprintf('%s.inProgress', $filename);
676 4
            $importedFilename = sprintf('%s.imported', $filename);
677 4
            $failedFilename = sprintf('%s.failed', $filename);
678
679
            // query whether or not the file has already been imported
680 4
            if ($this->isFile($failedFilename) ||
681 3
                $this->isFile($importedFilename) ||
682 4
                $this->isFile($inProgressFilename)
683
            ) {
684
                // log a debug message and exit
685 1
                $systemLogger->debug(sprintf('Import running, found inProgress file %s', $inProgressFilename));
686 1
                return;
687
            }
688
689
            // flag file as in progress
690 3
            $this->touch($inProgressFilename);
691
692
            // track the start time
693 3
            $startTime = microtime(true);
694
695
            // initialize the serial/filename
696 3
            $this->setSerial($serial);
697 3
            $this->setFilename($filename);
698
699
            // log a message that the file has to be imported
700 3
            $systemLogger->debug(sprintf('Now start importing file %s', $filename));
701
702
            // let the adapter process the file
703 3
            $this->getImportAdapter()->import(array($this, 'importRow'), $filename);
704
705
            // track the time needed for the import in seconds
706 1
            $endTime = microtime(true) - $startTime;
707
708
            // log a message that the file has successfully been imported
709 1
            $systemLogger->debug(sprintf('Successfully imported file %s in %f s', $filename, $endTime));
710
711
            // rename flag file, because import has been successfull
712 1
            $this->rename($inProgressFilename, $importedFilename);
713
0 ignored issues
show
Coding Style introduced by
Blank line found at end of control structure
Loading history...
714 2
        } catch (\Exception $e) {
715
            // rename the flag file, because import failed and write the stack trace
716 2
            $this->rename($inProgressFilename, $failedFilename);
0 ignored issues
show
Bug introduced by
The variable $inProgressFilename does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
Bug introduced by
The variable $failedFilename does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
717 2
            $this->write($failedFilename, $e->__toString());
718
719
            // do not wrap the exception if not already done
720 2
            if ($e instanceof WrappedColumnException) {
721 1
                throw $e;
722
            }
723
724
            // else wrap and throw the exception
725 1
            throw $this->wrapException(array(), $e);
726
        }
727 1
    }
728
729
    /**
730
     * This method queries whether or not the passed filename matches
731
     * the pattern, based on the subjects configured prefix.
732
     *
733
     * @param string $filename The filename to match
734
     *
735
     * @return boolean TRUE if the filename matches, else FALSE
736
     */
737 5
    protected function match($filename)
738
    {
739
740
        // prepare the pattern to query whether the file has to be processed or not
741 5
        $pattern = sprintf(
742 5
            '/^.*\/%s.*\\.%s$/',
743 5
            $this->getConfiguration()->getPrefix(),
744 5
            $this->getConfiguration()->getSuffix()
745
        );
746
747
        // stop processing, if the filename doesn't match
748 5
        return (boolean) preg_match($pattern, $filename);
749
    }
750
751
    /**
752
     * Imports the passed row into the database. If the import failed, the exception
753
     * will be catched and logged, but the import process will be continued.
754
     *
755
     * @param array $row The row with the data to be imported
756
     *
757
     * @return void
758
     */
759 7
    public function importRow(array $row)
760
    {
761
762
        // initialize the row
763 7
        $this->row = $row;
764
765
        // raise the line number and reset the skip row flag
766 7
        $this->lineNumber++;
767 7
        $this->skipRow = false;
768
769
        // initialize the headers with the columns from the first line
770 7
        if (sizeof($this->headers) === 0) {
771 1
            foreach ($this->row as $value => $key) {
772 1
                $this->headers[$this->mapAttributeCodeByHeaderMapping($key)] = $value;
773
            }
774 1
            return;
775
        }
776
777
        // process the observers
778 6
        foreach ($this->getObservers() as $observers) {
779
            // invoke the pre-import/import and post-import observers
780 6
            foreach ($observers as $observer) {
781
                // query whether or not we have to skip the row
782 6
                if ($this->skipRow) {
783 1
                    break;
784
                }
785
786
                // if not, set the subject and process the observer
787 6
                if ($observer instanceof ObserverInterface) {
788 6
                    $this->row = $observer->handle($this);
789
                }
790
            }
791
        }
792
793
        // log a debug message with the actual line nr/file information
794 6
        $this->getSystemLogger()->debug(
795 6
            sprintf(
796 6
                'Successfully processed row (operation: %s) in file %s on line %d',
797 6
                $this->operationName,
798 6
                $this->filename,
799 6
                $this->lineNumber
800
            )
801
        );
802 6
    }
803
804
    /**
805
     * Queries whether or not that the subject needs an OK file to be processed.
806
     *
807
     * @return boolean TRUE if the subject needs an OK file, else FALSE
808
     */
809 1
    public function isOkFileNeeded()
810
    {
811 1
        return $this->getConfiguration()->isOkFileNeeded();
812
    }
813
814
    /**
815
     * Return's the default store.
816
     *
817
     * @return array The default store
818
     */
819 4
    public function getDefaultStore()
820
    {
821 4
        return $this->defaultStore;
822
    }
823
824
    /**
825
     * Set's the store view code the create the product/attributes for.
826
     *
827
     * @param string $storeViewCode The store view code
828
     *
829
     * @return void
830
     */
831 4
    public function setStoreViewCode($storeViewCode)
832
    {
833 4
        $this->storeViewCode = $storeViewCode;
834 4
    }
835
836
    /**
837
     * Return's the store view code the create the product/attributes for.
838
     *
839
     * @param string|null $default The default value to return, if the store view code has not been set
840
     *
841
     * @return string The store view code
842
     */
843 8
    public function getStoreViewCode($default = null)
844
    {
845
846
        // return the store view code, if available
847 8
        if ($this->storeViewCode != null) {
848 4
            return $this->storeViewCode;
849
        }
850
851
        // if NOT and a default code is available
852 4
        if ($default != null) {
0 ignored issues
show
Bug introduced by
It seems like you are loosely comparing $default of type string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison !== instead.
Loading history...
853
            // return the default value
854 3
            return $default;
855
        }
856 1
    }
857
858
    /**
859
     * Return's the store ID of the store with the passed store view code
860
     *
861
     * @param string $storeViewCode The store view code to return the store ID for
862
     *
863
     * @return integer The ID of the store with the passed ID
864
     * @throws \Exception Is thrown, if the store with the actual code is not available
865
     */
866 4
    public function getStoreId($storeViewCode)
867
    {
868
869
        // query whether or not, the requested store is available
870 4
        if (isset($this->stores[$storeViewCode])) {
871 3
            return (integer) $this->stores[$storeViewCode][MemberNames::STORE_ID];
872
        }
873
874
        // throw an exception, if not
875 1
        throw new \Exception(
876 1
            sprintf(
877 1
                'Found invalid store view code %s in file %s on line %d',
878 1
                $storeViewCode,
879 1
                $this->getFilename(),
880 1
                $this->getLineNumber()
881
            )
882
        );
883
    }
884
885
    /**
886
     * Return's the store ID of the actual row, or of the default store
887
     * if no store view code is set in the CSV file.
888
     *
889
     * @param string|null $default The default store view code to use, if no store view code is set in the CSV file
890
     *
891
     * @return integer The ID of the actual store
892
     * @throws \Exception Is thrown, if the store with the actual code is not available
893
     */
894 2
    public function getRowStoreId($default = null)
895
    {
896
897
        // initialize the default store view code, if not passed
898 2
        if ($default == null) {
0 ignored issues
show
Bug introduced by
It seems like you are loosely comparing $default of type string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.
Loading history...
899 2
            $defaultStore = $this->getDefaultStore();
900 2
            $default = $defaultStore[MemberNames::CODE];
901
        }
902
903
        // load the store view code the create the product/attributes for
904 2
        return $this->getStoreId($this->getStoreViewCode($default));
905
    }
906
907
    /**
908
     * Prepare's the store view code in the subject.
909
     *
910
     * @return void
911
     */
912 2
    public function prepareStoreViewCode()
913
    {
914
915
        // re-set the store view code
916 2
        $this->setStoreViewCode(null);
917
918
        // initialize the store view code
919 2
        if ($storeViewCode = $this->getValue(ColumnKeys::STORE_VIEW_CODE)) {
920 2
            $this->setStoreViewCode($storeViewCode);
921
        }
922 2
    }
923
924
    /**
925
     * Return's the root category for the actual view store.
926
     *
927
     * @return array The store's root category
928
     * @throws \Exception Is thrown if the root category for the passed store code is NOT available
929
     */
930 2
    public function getRootCategory()
931
    {
932
933
        // load the default store
934 2
        $defaultStore = $this->getDefaultStore();
935
936
        // load the actual store view code
937 2
        $storeViewCode = $this->getStoreViewCode($defaultStore[MemberNames::CODE]);
938
939
        // query weather or not we've a root category or not
940 2
        if (isset($this->rootCategories[$storeViewCode])) {
941 1
            return $this->rootCategories[$storeViewCode];
942
        }
943
944
        // throw an exception if the root category is NOT available
945 1
        throw new \Exception(sprintf('Root category for %s is not available', $storeViewCode));
946
    }
947
948
    /**
949
     * Return's the Magento configuration value.
950
     *
951
     * @param string  $path    The Magento path of the requested configuration value
952
     * @param mixed   $default The default value that has to be returned, if the requested configuration value is not set
953
     * @param string  $scope   The scope the configuration value has been set
954
     * @param integer $scopeId The scope ID the configuration value has been set
955
     *
956
     * @return mixed The configuration value
957
     * @throws \Exception Is thrown, if nor a value can be found or a default value has been passed
958
     */
959 5
    public function getCoreConfigData($path, $default = null, $scope = ScopeKeys::SCOPE_DEFAULT, $scopeId = 0)
960
    {
961
962
        // initialize the core config data
963
        $coreConfigData = array(
964 5
            MemberNames::PATH => $path,
965 5
            MemberNames::SCOPE => $scope,
966 5
            MemberNames::SCOPE_ID => $scopeId
967
        );
968
969
        // generate the UID from the passed data
970 5
        $uniqueIdentifier = $this->coreConfigDataUidGenerator->generate($coreConfigData);
971
972
        // iterate over the core config data and try to find the requested configuration value
973 5
        if (isset($this->coreConfigData[$uniqueIdentifier])) {
974 1
            return $this->coreConfigData[$uniqueIdentifier][MemberNames::VALUE];
975
        }
976
977
        // query whether or not we've to query for the configuration value on fallback level 'websites' also
978 4
        if ($scope === ScopeKeys::SCOPE_STORES) {
979
            // query whether or not the website with the passed ID is available
980 2
            foreach ($this->storeWebsites as $storeWebsite) {
981 2
                if ($storeWebsite[MemberNames::WEBSITE_ID] === $scopeId) {
982
                    // replace scope with 'websites' and website ID
983 2
                    $coreConfigData = array_merge(
984 2
                        $coreConfigData,
985
                        array(
986 2
                            MemberNames::SCOPE    => ScopeKeys::SCOPE_WEBSITES,
987
                            MemberNames::SCOPE_ID => $storeWebsite[MemberNames::WEBSITE_ID]
988
                        )
989
                    );
990
991
                    // generate the UID from the passed data, merged with the 'websites' scope and ID
992 2
                    $uniqueIdentifier = $this->coreConfigDataUidGenerator->generate($coreConfigData);
993
994
                    // query whether or not, the configuration value on 'websites' level
995 2 View Code Duplication
                    if (isset($this->coreConfigData[$uniqueIdentifier][MemberNames::VALUE])) {
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...
996 2
                        return $this->coreConfigData[$uniqueIdentifier][MemberNames::VALUE];
997
                    }
998
                }
999
            }
1000
        }
1001
1002
        // replace scope with 'default' and scope ID '0'
1003 3
        $coreConfigData = array_merge(
1004 3
            $coreConfigData,
1005
            array(
1006 3
                MemberNames::SCOPE    => ScopeKeys::SCOPE_DEFAULT,
1007
                MemberNames::SCOPE_ID => 0
1008
            )
1009
        );
1010
1011
        // generate the UID from the passed data, merged with the 'default' scope and ID 0
1012 3
        $uniqueIdentifier = $this->coreConfigDataUidGenerator->generate($coreConfigData);
1013
1014
        // query whether or not, the configuration value on 'default' level
1015 3 View Code Duplication
        if (isset($this->coreConfigData[$uniqueIdentifier][MemberNames::VALUE])) {
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...
1016 1
            return $this->coreConfigData[$uniqueIdentifier][MemberNames::VALUE];
1017
        }
1018
1019
        // if not, return the passed default value
1020 2
        if ($default !== null) {
1021 1
            return $default;
1022
        }
1023
1024
        // throw an exception if no value can be found
1025
        // in the Magento configuration
1026 1
        throw new \Exception(
1027 1
            sprintf(
1028 1
                'Can\'t find a value for configuration "%s-%s-%d" in "core_config_data"',
1029 1
                $path,
1030 1
                $scope,
1031 1
                $scopeId
1032
            )
1033
        );
1034
    }
1035
1036
    /**
1037
     * Resolve the original column name for the passed one.
1038
     *
1039
     * @param string $columnName The column name that has to be resolved
1040
     *
1041
     * @return string|null The original column name
1042
     */
1043 2
    public function resolveOriginalColumnName($columnName)
1044
    {
1045
1046
        // try to load the original data
1047 2
        $originalData = $this->getOriginalData();
1048
1049
        // query whether or not original data is available
1050 2
        if (isset($originalData[ColumnKeys::ORIGINAL_COLUMN_NAMES])) {
1051
            // query whether or not the original column name is available
1052 1
            if (isset($originalData[ColumnKeys::ORIGINAL_COLUMN_NAMES][$columnName])) {
1053 1
                return $originalData[ColumnKeys::ORIGINAL_COLUMN_NAMES][$columnName];
1054
            }
1055
1056
            // query whether or a wildcard column name is available
1057 1
            if (isset($originalData[ColumnKeys::ORIGINAL_COLUMN_NAMES]['*'])) {
1058 1
                return $originalData[ColumnKeys::ORIGINAL_COLUMN_NAMES]['*'];
1059
            }
1060
        }
1061
1062
        // return the original column name
1063 1
        return $columnName;
1064
    }
1065
1066
    /**
1067
     * Return's the original data if available, or an empty array.
1068
     *
1069
     * @return array The original data
1070
     */
1071 2
    public function getOriginalData()
1072
    {
1073
1074
        // initialize the array for the original data
1075 2
        $originalData = array();
1076
1077
        // query whether or not the column contains original data
1078 2
        if ($this->hasOriginalData()) {
1079
            // unerialize the original data from the column
1080 1
            $originalData = unserialize($this->row[$this->headers[ColumnKeys::ORIGINAL_DATA]]);
1081
        }
1082
1083
        // return an empty array, if not
1084 2
        return $originalData;
1085
    }
1086
1087
    /**
1088
     * Query's whether or not the actual column contains original data like
1089
     * filename, line number and column names.
1090
     *
1091
     * @return boolean TRUE if the actual column contains origin data, else FALSE
1092
     */
1093 3
    public function hasOriginalData()
1094
    {
1095 3
        return isset($this->headers[ColumnKeys::ORIGINAL_DATA]) && isset($this->row[$this->headers[ColumnKeys::ORIGINAL_DATA]]);
1096
    }
1097
1098
    /**
1099
     * Wraps the passed exeception into a new one by trying to resolve the original filname,
1100
     * line number and column names and use it for a detailed exception message.
1101
     *
1102
     * @param array      $columnNames The column names that should be resolved and wrapped
1103
     * @param \Exception $parent      The exception we want to wrap
1104
     * @param string     $className   The class name of the exception type we want to wrap the parent one
1105
     *
1106
     * @return \Exception the wrapped exception
1107
     */
1108 2
    public function wrapException(
1109
        array $columnNames = array(),
1110
        \Exception $parent = null,
1111
        $className = '\TechDivision\Import\Exceptions\WrappedColumnException'
1112
    ) {
1113
1114
        // initialize the message
1115 2
        $message = $parent->getMessage();
0 ignored issues
show
Bug introduced by
It seems like $parent is not always an object, but can also be of type null. Maybe add an additional type check?

If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe:

function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
Loading history...
1116
1117
        // query whether or not has been a result of invalid data of a previous column of a CSV file
1118 2
        if ($this->hasOriginalData()) {
1119
            // load the original data
1120 1
            $originalData = $this->getOriginalData();
1121
1122
            // replace old filename and line number of the original message
1123 1
            $message = $this->appendExceptionSuffix(
1124 1
                $this->stripExceptionSuffix($message),
1125 1
                $originalData[ColumnKeys::ORIGINAL_FILENAME],
1126 1
                $originalData[ColumnKeys::ORIGINAL_LINE_NUMBER]
1127
            );
1128
0 ignored issues
show
Coding Style introduced by
Blank line found at end of control structure
Loading history...
1129
        } else {
1130
            // append filename and line number to the original message
1131 1
            $message = $this->appendExceptionSuffix(
1132 1
                $this->stripExceptionSuffix($message),
1133 1
                $this->filename,
1134 1
                $this->lineNumber
1135
            );
1136
        }
1137
1138
        // query whether or not, column names has been passed
1139 2
        if (sizeof($columnNames) > 0) {
1140
            // prepare the original column names
1141 1
            $originalColumnNames = array();
1142 1
            foreach ($columnNames as $columnName) {
1143 1
                $originalColumnNames[] = $this->resolveOriginalColumnName($columnName);
1144
            }
1145
1146
            // append the column information
1147 1
            $message = sprintf('%s in column(s) %s', $message, implode(', ', $originalColumnNames));
1148
        }
1149
1150
        // create a new exception and wrap the parent one
1151 2
        return new $className($message, null, $parent);
1152
    }
1153
1154
    /**
1155
     * Strip's the exception suffix containing filename and line number from the
1156
     * passed message.
1157
     *
1158
     * @param string $message The message to strip the exception suffix from
1159
     *
1160
     * @return mixed The message without the exception suffix
1161
     */
1162 2
    public function stripExceptionSuffix($message)
1163
    {
1164 2
        return str_replace($this->appendExceptionSuffix(), '', $message);
1165
    }
1166
1167
    /**
1168
     * Append's the exception suffix containing filename and line number to the
1169
     * passed message. If no message has been passed, only the suffix will be
1170
     * returned
1171
     *
1172
     * @param string|null $message    The message to append the exception suffix to
1173
     * @param string|null $filename   The filename used to create the suffix
1174
     * @param string|null $lineNumber The line number used to create the suffx
1175
     *
1176
     * @return string The message with the appended exception suffix
1177
     */
1178 7
    public function appendExceptionSuffix($message = null, $filename = null, $lineNumber = null)
1179
    {
1180
1181
        // query whether or not a filename has been passed
1182 7
        if ($filename === null) {
1183 7
            $filename = $this->getFilename();
1184
        }
1185
1186
        // query whether or not a line number has been passed
1187 7
        if ($lineNumber === null) {
1188 7
            $lineNumber = $this->getLineNumber();
1189
        }
1190
1191
        // if no message has been passed, only return the suffix
1192 7
        if ($message === null) {
1193 2
            return sprintf(' in file %s on line %d', $filename, $lineNumber);
1194
        }
1195
1196
        // concatenate the message with the suffix and return it
1197 7
        return sprintf('%s in file %s on line %d', $message, $filename, $lineNumber);
1198
    }
1199
1200
    /**
1201
     * Raises the value for the counter with the passed key by one.
1202
     *
1203
     * @param mixed $counterName The name of the counter to raise
1204
     *
1205
     * @return integer The counter's new value
1206
     */
1207 1
    public function raiseCounter($counterName)
1208
    {
1209
1210
        // raise the counter with the passed name
1211 1
        return $this->getRegistryProcessor()->raiseCounter(
1212 1
            $this->getSerial(),
1213 1
            $counterName
1214
        );
1215
    }
1216
1217
    /**
1218
     * Merge the passed array into the status of the actual import.
1219
     *
1220
     * @param array $status The status information to be merged
1221
     *
1222
     * @return void
1223
     */
1224 1
    public function mergeAttributesRecursive(array $status)
1225
    {
1226
1227
        // merge the passed status
1228 1
        $this->getRegistryProcessor()->mergeAttributesRecursive(
1229 1
            $this->getSerial(),
1230 1
            $status
1231
        );
1232 1
    }
1233
}
1234