Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like AbstractSubject often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use AbstractSubject, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 53 | abstract class AbstractSubject implements SubjectInterface, FilesystemSubjectInterface, DateConverterSubjectInterface |
||
| 54 | { |
||
| 55 | |||
| 56 | /** |
||
| 57 | * The trait that provides basic filesystem handling functionality. |
||
| 58 | * |
||
| 59 | * @var \TechDivision\Import\Subjects\FilesystemTrait |
||
| 60 | */ |
||
| 61 | use FilesystemTrait; |
||
| 62 | |||
| 63 | /** |
||
| 64 | * The trait that provides basic filesystem handling functionality. |
||
| 65 | * |
||
| 66 | * @var \TechDivision\Import\SystemLoggerTrait |
||
| 67 | */ |
||
| 68 | use SystemLoggerTrait; |
||
| 69 | |||
| 70 | /** |
||
| 71 | * The trait that provides date converting functionality. |
||
| 72 | * |
||
| 73 | * @var \TechDivision\Import\DateConverterTrait |
||
| 74 | */ |
||
| 75 | use DateConverterTrait; |
||
| 76 | |||
| 77 | /** |
||
| 78 | * The trait that provides header handling functionality. |
||
| 79 | * |
||
| 80 | * @var \TechDivision\Import\HeaderTrait |
||
| 81 | */ |
||
| 82 | use HeaderTrait; |
||
| 83 | |||
| 84 | /** |
||
| 85 | * The trait that provides row handling functionality. |
||
| 86 | * |
||
| 87 | * @var \TechDivision\Import\RowTrait |
||
| 88 | */ |
||
| 89 | use RowTrait; |
||
| 90 | |||
| 91 | /** |
||
| 92 | * The unique identifier for the actual invocation. |
||
| 93 | * |
||
| 94 | * @var string |
||
| 95 | */ |
||
| 96 | protected $uniqueId; |
||
| 97 | |||
| 98 | /** |
||
| 99 | * The name of the file to be imported. |
||
| 100 | * |
||
| 101 | * @var string |
||
| 102 | */ |
||
| 103 | protected $filename; |
||
| 104 | |||
| 105 | /** |
||
| 106 | * The actual line number. |
||
| 107 | * |
||
| 108 | * @var integer |
||
| 109 | */ |
||
| 110 | protected $lineNumber = 0; |
||
| 111 | |||
| 112 | /** |
||
| 113 | * The import adapter instance. |
||
| 114 | * |
||
| 115 | * @var \TechDivision\Import\Adapter\ImportAdapterInterface |
||
| 116 | */ |
||
| 117 | protected $importAdapter; |
||
| 118 | |||
| 119 | /** |
||
| 120 | * The subject configuration. |
||
| 121 | * |
||
| 122 | * @var \TechDivision\Import\Configuration\SubjectConfigurationInterface |
||
| 123 | */ |
||
| 124 | protected $configuration; |
||
| 125 | |||
| 126 | /** |
||
| 127 | * The plugin configuration. |
||
| 128 | * |
||
| 129 | * @var \TechDivision\Import\Configuration\PluginConfigurationInterface |
||
| 130 | */ |
||
| 131 | protected $pluginConfiguration; |
||
| 132 | |||
| 133 | /** |
||
| 134 | * The RegistryProcessor instance to handle running threads. |
||
| 135 | * |
||
| 136 | * @var \TechDivision\Import\Services\RegistryProcessorInterface |
||
| 137 | */ |
||
| 138 | protected $registryProcessor; |
||
| 139 | |||
| 140 | /** |
||
| 141 | * The actions unique serial. |
||
| 142 | * |
||
| 143 | * @var string |
||
| 144 | */ |
||
| 145 | protected $serial; |
||
| 146 | |||
| 147 | /** |
||
| 148 | * Array with the subject's observers. |
||
| 149 | * |
||
| 150 | * @var array |
||
| 151 | */ |
||
| 152 | protected $observers = array(); |
||
| 153 | |||
| 154 | /** |
||
| 155 | * Array with the subject's callbacks. |
||
| 156 | * |
||
| 157 | * @var array |
||
| 158 | */ |
||
| 159 | protected $callbacks = array(); |
||
| 160 | |||
| 161 | /** |
||
| 162 | * The subject's callback mappings. |
||
| 163 | * |
||
| 164 | * @var array |
||
| 165 | */ |
||
| 166 | protected $callbackMappings = array(); |
||
| 167 | |||
| 168 | /** |
||
| 169 | * The available root categories. |
||
| 170 | * |
||
| 171 | * @var array |
||
| 172 | */ |
||
| 173 | protected $rootCategories = array(); |
||
| 174 | |||
| 175 | /** |
||
| 176 | * The Magento configuration. |
||
| 177 | * |
||
| 178 | * @var array |
||
| 179 | */ |
||
| 180 | protected $coreConfigData = array(); |
||
| 181 | |||
| 182 | /** |
||
| 183 | * The available stores. |
||
| 184 | * |
||
| 185 | * @var array |
||
| 186 | */ |
||
| 187 | protected $stores = array(); |
||
| 188 | |||
| 189 | /** |
||
| 190 | * The available websites. |
||
| 191 | * |
||
| 192 | * @var array |
||
| 193 | */ |
||
| 194 | protected $storeWebsites = array(); |
||
| 195 | |||
| 196 | /** |
||
| 197 | * The default store. |
||
| 198 | * |
||
| 199 | * @var array |
||
| 200 | */ |
||
| 201 | protected $defaultStore; |
||
| 202 | |||
| 203 | /** |
||
| 204 | * The store view code the create the product/attributes for. |
||
| 205 | * |
||
| 206 | * @var string |
||
| 207 | */ |
||
| 208 | protected $storeViewCode; |
||
| 209 | |||
| 210 | /** |
||
| 211 | * The UID generator for the core config data. |
||
| 212 | * |
||
| 213 | * @var \TechDivision\Import\Utils\Generators\GeneratorInterface |
||
| 214 | */ |
||
| 215 | protected $coreConfigDataUidGenerator; |
||
| 216 | |||
| 217 | /** |
||
| 218 | * UNIX timestamp with the date the last row counter has been logged. |
||
| 219 | * |
||
| 220 | * @var integer |
||
| 221 | */ |
||
| 222 | protected $lastLog = 0; |
||
| 223 | |||
| 224 | /** |
||
| 225 | * The number of the last line that has been logged with the row counter |
||
| 226 | * @var integer |
||
| 227 | */ |
||
| 228 | protected $lastLineNumber = 0; |
||
| 229 | |||
| 230 | /** |
||
| 231 | * The event emitter instance. |
||
| 232 | * |
||
| 233 | * @var \League\Event\EmitterInterface |
||
| 234 | */ |
||
| 235 | protected $emitter; |
||
| 236 | |||
| 237 | /** |
||
| 238 | * The status of the file (0 = not processed, 1 = successfully processed, 2 = processed with failure) |
||
| 239 | * |
||
| 240 | * @var array |
||
| 241 | */ |
||
| 242 | protected $status = array(); |
||
| 243 | |||
| 244 | /** |
||
| 245 | * The default values for the columns from the configuration. |
||
| 246 | * |
||
| 247 | * @var array |
||
| 248 | */ |
||
| 249 | protected $defaultColumnValues = array(); |
||
| 250 | |||
| 251 | /** |
||
| 252 | * The values of the actual column, pre-initialized with the default values. |
||
| 253 | * |
||
| 254 | * @var array |
||
| 255 | */ |
||
| 256 | protected $columnValues = array(); |
||
| 257 | |||
| 258 | /** |
||
| 259 | * Mapping for the virtual entity type code to the real Magento 2 EAV entity type code. |
||
| 260 | * |
||
| 261 | * @var array |
||
| 262 | */ |
||
| 263 | protected $entityTypeCodeMappings = array( |
||
| 264 | EntityTypeCodes::EAV_ATTRIBUTE => EntityTypeCodes::CATALOG_PRODUCT, |
||
| 265 | EntityTypeCodes::EAV_ATTRIBUTE_SET => EntityTypeCodes::CATALOG_PRODUCT, |
||
| 266 | EntityTypeCodes::CATALOG_PRODUCT_URL => EntityTypeCodes::CATALOG_PRODUCT, |
||
| 267 | EntityTypeCodes::CATALOG_PRODUCT_PRICE => EntityTypeCodes::CATALOG_PRODUCT, |
||
| 268 | EntityTypeCodes::CATALOG_PRODUCT_INVENTORY => EntityTypeCodes::CATALOG_PRODUCT, |
||
| 269 | EntityTypeCodes::CATALOG_PRODUCT_INVENTORY_MSI => EntityTypeCodes::CATALOG_PRODUCT, |
||
| 270 | EntityTypeCodes::CATALOG_PRODUCT_TIER_PRICE => EntityTypeCodes::CATALOG_PRODUCT |
||
| 271 | ); |
||
| 272 | |||
| 273 | /** |
||
| 274 | * Initialize the subject instance. |
||
| 275 | * |
||
| 276 | * @param \TechDivision\Import\Services\RegistryProcessorInterface $registryProcessor The registry processor instance |
||
| 277 | * @param \TechDivision\Import\Utils\Generators\GeneratorInterface $coreConfigDataUidGenerator The UID generator for the core config data |
||
| 278 | * @param \Doctrine\Common\Collections\Collection $systemLoggers The array with the system loggers instances |
||
| 279 | * @param \League\Event\EmitterInterface $emitter The event emitter instance |
||
| 280 | */ |
||
| 281 | 81 | public function __construct( |
|
| 292 | |||
| 293 | /** |
||
| 294 | * Return's the event emitter instance. |
||
| 295 | * |
||
| 296 | * @return \League\Event\EmitterInterface The event emitter instance |
||
| 297 | */ |
||
| 298 | 9 | public function getEmitter() |
|
| 302 | |||
| 303 | /** |
||
| 304 | * Set's the name of the file to import |
||
| 305 | * |
||
| 306 | * @param string $filename The filename |
||
| 307 | * |
||
| 308 | * @return void |
||
| 309 | */ |
||
| 310 | 13 | public function setFilename($filename) |
|
| 314 | |||
| 315 | /** |
||
| 316 | * Return's the name of the file to import. |
||
| 317 | * |
||
| 318 | * @return string The filename |
||
| 319 | */ |
||
| 320 | 12 | public function getFilename() |
|
| 324 | |||
| 325 | /** |
||
| 326 | * Set's the actual line number. |
||
| 327 | * |
||
| 328 | * @param integer $lineNumber The line number |
||
| 329 | * |
||
| 330 | * @return void |
||
| 331 | */ |
||
| 332 | 1 | public function setLineNumber($lineNumber) |
|
| 336 | |||
| 337 | /** |
||
| 338 | * Return's the actual line number. |
||
| 339 | * |
||
| 340 | * @return integer The line number |
||
| 341 | */ |
||
| 342 | 17 | public function getLineNumber() |
|
| 346 | |||
| 347 | /** |
||
| 348 | * Return's the default callback mappings. |
||
| 349 | * |
||
| 350 | * @return array The default callback mappings |
||
| 351 | */ |
||
| 352 | 1 | public function getDefaultCallbackMappings() |
|
| 356 | |||
| 357 | /** |
||
| 358 | * Load the default column values from the configuration. |
||
| 359 | * |
||
| 360 | * @return array The array with the default column values |
||
| 361 | */ |
||
| 362 | 81 | View Code Duplication | public function getDefaultColumnValues() |
| 382 | |||
| 383 | /** |
||
| 384 | * Load the default header mappings from the configuration. |
||
| 385 | * |
||
| 386 | * @return array The array with the default header mappings |
||
| 387 | */ |
||
| 388 | 81 | View Code Duplication | public function getDefaultHeaderMappings() |
| 408 | |||
| 409 | /** |
||
| 410 | * Tries to format the passed value to a valid date with format 'Y-m-d H:i:s'. |
||
| 411 | * If the passed value is NOT a valid date, NULL will be returned. |
||
| 412 | * |
||
| 413 | * @param string $value The value to format |
||
| 414 | * |
||
| 415 | * @return string|null The formatted date or NULL if the date is not valid |
||
| 416 | * @throws \InvalidArgumentException Is thrown, if the passed can not be formatted according to the configured date format |
||
| 417 | */ |
||
| 418 | public function formatDate($value) |
||
| 434 | |||
| 435 | /** |
||
| 436 | * Extracts the elements of the passed value by exploding them |
||
| 437 | * with the also passed delimiter. |
||
| 438 | * |
||
| 439 | * @param string $value The value to extract |
||
| 440 | * @param string|null $delimiter The delimiter used to extrace the elements |
||
| 441 | * |
||
| 442 | * @return array The exploded values |
||
| 443 | */ |
||
| 444 | public function explode($value, $delimiter = null) |
||
| 448 | |||
| 449 | /** |
||
| 450 | * Queries whether or not debug mode is enabled or not, default is TRUE. |
||
| 451 | * |
||
| 452 | * @return boolean TRUE if debug mode is enabled, else FALSE |
||
| 453 | */ |
||
| 454 | 1 | public function isDebugMode() |
|
| 458 | |||
| 459 | /** |
||
| 460 | * Return's the subject's execution context configuration. |
||
| 461 | * |
||
| 462 | * @return \TechDivision\Import\ExecutionContextInterface The execution context configuration to use |
||
| 463 | */ |
||
| 464 | public function getExecutionContext() |
||
| 468 | |||
| 469 | /** |
||
| 470 | * Set's the subject configuration. |
||
| 471 | * |
||
| 472 | * @param \TechDivision\Import\Configuration\SubjectConfigurationInterface $configuration The subject configuration |
||
| 473 | * |
||
| 474 | * @return void |
||
| 475 | */ |
||
| 476 | 81 | public function setConfiguration(SubjectConfigurationInterface $configuration) |
|
| 480 | |||
| 481 | /** |
||
| 482 | * Return's the subject configuration. |
||
| 483 | * |
||
| 484 | * @return \TechDivision\Import\Configuration\SubjectConfigurationInterface The subject configuration |
||
| 485 | */ |
||
| 486 | 81 | public function getConfiguration() |
|
| 490 | |||
| 491 | /** |
||
| 492 | * Set's the import adapter instance. |
||
| 493 | * |
||
| 494 | * @param \TechDivision\Import\Adapter\ImportAdapterInterface $importAdapter The import adapter instance |
||
| 495 | * |
||
| 496 | * @return void |
||
| 497 | */ |
||
| 498 | 1 | public function setImportAdapter(ImportAdapterInterface $importAdapter) |
|
| 502 | |||
| 503 | /** |
||
| 504 | * Return's the import adapter instance. |
||
| 505 | * |
||
| 506 | * @return \TechDivision\Import\Adapter\ImportAdapterInterface The import adapter instance |
||
| 507 | */ |
||
| 508 | 1 | public function getImportAdapter() |
|
| 512 | |||
| 513 | /** |
||
| 514 | * Return's the RegistryProcessor instance to handle the running threads. |
||
| 515 | * |
||
| 516 | * @return \TechDivision\Import\Services\RegistryProcessorInterface The registry processor instance |
||
| 517 | */ |
||
| 518 | 81 | public function getRegistryProcessor() |
|
| 522 | |||
| 523 | /** |
||
| 524 | * Set's the unique serial for this import process. |
||
| 525 | * |
||
| 526 | * @param string $serial The unique serial |
||
| 527 | * |
||
| 528 | * @return void |
||
| 529 | */ |
||
| 530 | 8 | public function setSerial($serial) |
|
| 534 | |||
| 535 | /** |
||
| 536 | * Return's the unique serial for this import process. |
||
| 537 | * |
||
| 538 | * @return string The unique serial |
||
| 539 | */ |
||
| 540 | 1 | public function getSerial() |
|
| 544 | |||
| 545 | /** |
||
| 546 | * Merge's the passed status into the actual one. |
||
| 547 | * |
||
| 548 | * @param array $status The status to MergeBuilder |
||
| 549 | * |
||
| 550 | * @return void |
||
| 551 | */ |
||
| 552 | 4 | public function mergeStatus(array $status) |
|
| 556 | |||
| 557 | /** |
||
| 558 | * Retur's the actual status. |
||
| 559 | * |
||
| 560 | * @return array The actual status |
||
| 561 | */ |
||
| 562 | public function getStatus() |
||
| 566 | |||
| 567 | /** |
||
| 568 | * Return's the unique identifier for the actual invocation. |
||
| 569 | * |
||
| 570 | * @return string The unique identifier |
||
| 571 | */ |
||
| 572 | 4 | public function getUniqueId() |
|
| 576 | |||
| 577 | /** |
||
| 578 | * Return's the source date format to use. |
||
| 579 | * |
||
| 580 | * @return string The source date format |
||
| 581 | */ |
||
| 582 | public function getSourceDateFormat() |
||
| 586 | |||
| 587 | /** |
||
| 588 | * Return's the multiple field delimiter character to use, default value is comma (,). |
||
| 589 | * |
||
| 590 | * @return string The multiple field delimiter character |
||
| 591 | */ |
||
| 592 | 1 | public function getMultipleFieldDelimiter() |
|
| 596 | |||
| 597 | /** |
||
| 598 | * Return's the multiple value delimiter character to use, default value is comma (|). |
||
| 599 | * |
||
| 600 | * @return string The multiple value delimiter character |
||
| 601 | */ |
||
| 602 | 1 | public function getMultipleValueDelimiter() |
|
| 606 | |||
| 607 | /** |
||
| 608 | * Intializes the previously loaded global data for exactly one bunch. |
||
| 609 | * |
||
| 610 | * @param string $serial The serial of the actual import |
||
| 611 | * |
||
| 612 | * @return void |
||
| 613 | */ |
||
| 614 | 81 | public function setUp($serial) |
|
| 660 | |||
| 661 | /** |
||
| 662 | * Clean up the global data after importing the variants. |
||
| 663 | * |
||
| 664 | * @param string $serial The serial of the actual import |
||
| 665 | * |
||
| 666 | * @return void |
||
| 667 | */ |
||
| 668 | 1 | public function tearDown($serial) |
|
| 684 | |||
| 685 | /** |
||
| 686 | * Return's the target directory for the artefact export. |
||
| 687 | * |
||
| 688 | * @return string The target directory for the artefact export |
||
| 689 | */ |
||
| 690 | 1 | View Code Duplication | public function getTargetDir() |
| 704 | |||
| 705 | /** |
||
| 706 | * Register the passed observer with the specific type. |
||
| 707 | * |
||
| 708 | * @param \TechDivision\Import\Observers\ObserverInterface $observer The observer to register |
||
| 709 | * @param string $type The type to register the observer with |
||
| 710 | * |
||
| 711 | * @return void |
||
| 712 | */ |
||
| 713 | 6 | public function registerObserver(ObserverInterface $observer, $type) |
|
| 725 | |||
| 726 | /** |
||
| 727 | * Register the passed callback with the specific type. |
||
| 728 | * |
||
| 729 | * @param \TechDivision\Import\Callbacks\CallbackInterface $callback The subject to register the callbacks for |
||
| 730 | * @param string $type The type to register the callback with |
||
| 731 | * |
||
| 732 | * @return void |
||
| 733 | */ |
||
| 734 | 2 | public function registerCallback(CallbackInterface $callback, $type) |
|
| 746 | |||
| 747 | /** |
||
| 748 | * Return's the array with callbacks for the passed type. |
||
| 749 | * |
||
| 750 | * @param string $type The type of the callbacks to return |
||
| 751 | * |
||
| 752 | * @return array The callbacks |
||
| 753 | */ |
||
| 754 | 1 | public function getCallbacksByType($type) |
|
| 768 | |||
| 769 | /** |
||
| 770 | * Return's the array with the available observers. |
||
| 771 | * |
||
| 772 | * @return array The observers |
||
| 773 | */ |
||
| 774 | 6 | public function getObservers() |
|
| 778 | |||
| 779 | /** |
||
| 780 | * Return's the array with the available callbacks. |
||
| 781 | * |
||
| 782 | * @return array The callbacks |
||
| 783 | */ |
||
| 784 | 1 | public function getCallbacks() |
|
| 788 | |||
| 789 | /** |
||
| 790 | * Return's the callback mappings for this subject. |
||
| 791 | * |
||
| 792 | * @return array The array with the subject's callback mappings |
||
| 793 | */ |
||
| 794 | 2 | public function getCallbackMappings() |
|
| 798 | |||
| 799 | /** |
||
| 800 | * Imports the content of the file with the passed filename. |
||
| 801 | * |
||
| 802 | * |
||
| 803 | * @param string $serial The serial of the actual import |
||
| 804 | * @param string $filename The filename to process |
||
| 805 | * |
||
| 806 | * @return void |
||
| 807 | * @throws \Exception Is thrown, if the import can't be processed |
||
| 808 | */ |
||
| 809 | 2 | public function import($serial, $filename) |
|
| 810 | { |
||
| 811 | |||
| 812 | try { |
||
| 813 | // initialize the serial/filename |
||
| 814 | 2 | $this->setSerial($serial); |
|
| 815 | 2 | $this->setFilename($filename); |
|
| 816 | |||
| 817 | // invoke the events that has to be fired before the artfact will be processed |
||
| 818 | 2 | $this->getEmitter()->emit(EventNames::SUBJECT_ARTEFACT_PROCESS_START, $this); |
|
| 819 | 2 | $this->getEmitter()->emit($this->getEventName(EventNames::SUBJECT_ARTEFACT_PROCESS_START), $this); |
|
| 820 | |||
| 821 | // load the system logger instance |
||
| 822 | 2 | $systemLogger = $this->getSystemLogger(); |
|
| 823 | |||
| 824 | // prepare the flag filenames |
||
| 825 | 2 | $inProgressFilename = sprintf('%s.inProgress', $filename); |
|
| 826 | 2 | $importedFilename = sprintf('%s.imported', $filename); |
|
| 827 | 2 | $failedFilename = sprintf('%s.failed', $filename); |
|
| 828 | |||
| 829 | // query whether or not the file has already been imported |
||
| 830 | 2 | if ($this->isFile($failedFilename) || |
|
| 831 | 1 | $this->isFile($importedFilename) || |
|
| 832 | 2 | $this->isFile($inProgressFilename) |
|
| 833 | ) { |
||
| 834 | // log a debug message and exit |
||
| 835 | 1 | $systemLogger->debug(sprintf('Import running, found inProgress file "%s"', $inProgressFilename)); |
|
| 836 | 1 | return; |
|
| 837 | } |
||
| 838 | |||
| 839 | // flag file as in progress |
||
| 840 | 1 | $this->touch($inProgressFilename); |
|
| 841 | |||
| 842 | // track the start time |
||
| 843 | 1 | $startTime = microtime(true); |
|
| 844 | |||
| 845 | // initialize the last time we've logged the counter with the processed rows per minute |
||
| 846 | 1 | $this->lastLog = time(); |
|
| 847 | |||
| 848 | // log a message that the file has to be imported |
||
| 849 | 1 | $systemLogger->info( |
|
| 850 | 1 | sprintf('Now start processing file "%s"', basename($filename)), |
|
| 851 | 1 | array('operation-name' => $operationName = $this->getFullOperationName()) |
|
| 852 | ); |
||
| 853 | |||
| 854 | // let the adapter process the file |
||
| 855 | 1 | $this->getImportAdapter()->import(array($this, 'importRow'), $filename); |
|
| 856 | |||
| 857 | // track the time needed for the import in seconds |
||
| 858 | 1 | $endTime = microtime(true) - $startTime; |
|
| 859 | |||
| 860 | // log a message that the file has successfully been imported, |
||
| 861 | // use log level warning ONLY if rows have been skipped |
||
| 862 | 1 | $systemLogger->log( |
|
| 863 | 1 | $skippedRows = $this->getSkippedRows() > 0 ? LogLevel::WARNING : LogLevel::INFO, |
|
| 864 | 1 | sprintf( |
|
| 865 | 1 | 'Successfully processed file "%s" with "%d" lines (skipping "%d") in "%f" s', |
|
| 866 | 1 | basename($filename), |
|
| 867 | 1 | $this->getLineNumber() - 1, |
|
| 868 | $skippedRows, |
||
| 869 | $endTime |
||
| 870 | ), |
||
| 871 | 1 | array('operation-name' => $operationName) |
|
| 872 | ); |
||
| 873 | |||
| 874 | // rename flag file, because import has been successfull |
||
| 875 | 1 | if ($this->getConfiguration()->isCreatingImportedFile()) { |
|
| 876 | 1 | $this->rename($inProgressFilename, $importedFilename); |
|
| 877 | } else { |
||
| 878 | $this->getFilesystemAdapter()->delete($inProgressFilename); |
||
| 879 | } |
||
| 880 | |||
| 881 | // update the status |
||
| 882 | 1 | $this->mergeStatus( |
|
| 883 | array( |
||
| 884 | RegistryKeys::STATUS => array( |
||
| 885 | RegistryKeys::FILES => array( |
||
| 886 | $filename => array( |
||
| 887 | 1 | $this->getUniqueId() => array( |
|
| 888 | 1 | RegistryKeys::STATUS => 1, |
|
| 889 | 1 | RegistryKeys::SKIPPED_ROWS => $this->getSkippedRows(), |
|
| 890 | 1 | RegistryKeys::PROCESSED_ROWS => $this->getLineNumber() - 1 |
|
| 891 | ) |
||
| 892 | ) |
||
| 893 | ) |
||
| 894 | ) |
||
| 895 | ) |
||
| 896 | ); |
||
| 897 | |||
| 898 | // invoke the events that has to be fired when the artfact has been successfully processed |
||
| 899 | 1 | $this->getEmitter()->emit(EventNames::SUBJECT_ARTEFACT_PROCESS_SUCCESS, $this); |
|
| 900 | 1 | $this->getEmitter()->emit($this->getEventName(EventNames::SUBJECT_ARTEFACT_PROCESS_SUCCESS), $this); |
|
| 901 | } catch (\Exception $e) { |
||
| 902 | // rename the flag file, because import failed and write the stack trace |
||
| 903 | $this->rename($inProgressFilename, $failedFilename); |
||
| 904 | $this->write($failedFilename, $e->__toString()); |
||
| 905 | |||
| 906 | // update the status with the error message |
||
| 907 | $this->mergeStatus( |
||
| 908 | array( |
||
| 909 | RegistryKeys::STATUS => array( |
||
| 910 | RegistryKeys::FILES => array( |
||
| 911 | $filename => array( |
||
| 912 | $this->getUniqueId() => array( |
||
| 913 | RegistryKeys::STATUS => 2, |
||
| 914 | RegistryKeys::ERROR_MESSAGE => $e->getMessage(), |
||
| 915 | RegistryKeys::SKIPPED_ROWS => $this->getSkippedRows(), |
||
| 916 | RegistryKeys::PROCESSED_ROWS => $this->getLineNumber() - 1 |
||
| 917 | ) |
||
| 918 | ) |
||
| 919 | ) |
||
| 920 | ) |
||
| 921 | ) |
||
| 922 | ); |
||
| 923 | |||
| 924 | // invoke the events that has to be fired when the artfact can't be processed |
||
| 925 | $this->getEmitter()->emit(EventNames::SUBJECT_ARTEFACT_PROCESS_FAILURE, $this, $e); |
||
| 926 | $this->getEmitter()->emit($this->getEventName(EventNames::SUBJECT_ARTEFACT_PROCESS_FAILURE), $this, $e); |
||
| 927 | |||
| 928 | // do not wrap the exception if not already done |
||
| 929 | if ($e instanceof WrappedColumnException) { |
||
| 930 | throw $e; |
||
| 931 | } |
||
| 932 | |||
| 933 | // else wrap and throw the exception |
||
| 934 | throw $this->wrapException(array(), $e); |
||
| 935 | } |
||
| 936 | 1 | } |
|
| 937 | |||
| 938 | /** |
||
| 939 | * Imports the passed row into the database. If the import failed, the exception |
||
| 940 | * will be catched and logged, but the import process will be continued. |
||
| 941 | * |
||
| 942 | * @param array $row The row with the data to be imported |
||
| 943 | * |
||
| 944 | * @return void |
||
| 945 | */ |
||
| 946 | 7 | public function importRow(array $row) |
|
| 1054 | |||
| 1055 | /** |
||
| 1056 | * Queries whether or not that the subject needs an OK file to be processed. |
||
| 1057 | * |
||
| 1058 | * @return boolean TRUE if the subject needs an OK file, else FALSE |
||
| 1059 | */ |
||
| 1060 | 1 | public function isOkFileNeeded() |
|
| 1064 | |||
| 1065 | /** |
||
| 1066 | * Return's the default store. |
||
| 1067 | * |
||
| 1068 | * @return array The default store |
||
| 1069 | */ |
||
| 1070 | public function getDefaultStore() |
||
| 1074 | |||
| 1075 | /** |
||
| 1076 | * Return's the default store view code. |
||
| 1077 | * |
||
| 1078 | * @return array The default store view code |
||
| 1079 | */ |
||
| 1080 | 5 | public function getDefaultStoreViewCode() |
|
| 1084 | |||
| 1085 | /** |
||
| 1086 | * Set's the store view code the create the product/attributes for. |
||
| 1087 | * |
||
| 1088 | * @param string $storeViewCode The store view code |
||
| 1089 | * |
||
| 1090 | * @return void |
||
| 1091 | */ |
||
| 1092 | 4 | public function setStoreViewCode($storeViewCode) |
|
| 1096 | |||
| 1097 | /** |
||
| 1098 | * Return's the store view code the create the product/attributes for. |
||
| 1099 | * |
||
| 1100 | * @param string|null $default The default value to return, if the store view code has not been set |
||
| 1101 | * |
||
| 1102 | * @return string The store view code |
||
| 1103 | */ |
||
| 1104 | 8 | public function getStoreViewCode($default = null) |
|
| 1121 | |||
| 1122 | /** |
||
| 1123 | * Prepare's the store view code in the subject. If the store_view_code row doesn't contain |
||
| 1124 | * any value, the default code of the default store view will be set. |
||
| 1125 | * |
||
| 1126 | * @return void |
||
| 1127 | */ |
||
| 1128 | 2 | public function prepareStoreViewCode() |
|
| 1139 | |||
| 1140 | /** |
||
| 1141 | * Return's the store ID of the store with the passed store view code |
||
| 1142 | * |
||
| 1143 | * @param string $storeViewCode The store view code to return the store ID for |
||
| 1144 | * |
||
| 1145 | * @return integer The ID of the store with the passed ID |
||
| 1146 | * @throws \Exception Is thrown, if the store with the actual code is not available |
||
| 1147 | */ |
||
| 1148 | 4 | public function getStoreId($storeViewCode) |
|
| 1149 | { |
||
| 1150 | |||
| 1151 | // query whether or not, the requested store is available |
||
| 1152 | 4 | if (isset($this->stores[$storeViewCode])) { |
|
| 1153 | 3 | return (integer) $this->stores[$storeViewCode][MemberNames::STORE_ID]; |
|
| 1154 | } |
||
| 1155 | |||
| 1156 | // throw an exception, if not |
||
| 1157 | 1 | throw new \Exception( |
|
| 1158 | 1 | sprintf( |
|
| 1159 | 1 | 'Found invalid store view code %s in file %s on line %d', |
|
| 1160 | $storeViewCode, |
||
| 1161 | 1 | $this->getFilename(), |
|
| 1162 | 1 | $this->getLineNumber() |
|
| 1163 | ) |
||
| 1164 | ); |
||
| 1165 | } |
||
| 1166 | |||
| 1167 | /** |
||
| 1168 | * Return's the store ID of the actual row, or of the default store |
||
| 1169 | * if no store view code is set in the CSV file. |
||
| 1170 | * |
||
| 1171 | * @param string|null $default The default store view code to use, if no store view code is set in the CSV file |
||
| 1172 | * |
||
| 1173 | * @return integer The ID of the actual store |
||
| 1174 | * @throws \Exception Is thrown, if the store with the actual code is not available |
||
| 1175 | */ |
||
| 1176 | 2 | public function getRowStoreId($default = null) |
|
| 1187 | |||
| 1188 | /** |
||
| 1189 | * Return's the root category for the actual view store. |
||
| 1190 | * |
||
| 1191 | * @return array The store's root category |
||
| 1192 | * @throws \Exception Is thrown if the root category for the passed store code is NOT available |
||
| 1193 | */ |
||
| 1194 | 2 | public function getRootCategory() |
|
| 1208 | |||
| 1209 | /** |
||
| 1210 | * Return's the Magento configuration value. |
||
| 1211 | * |
||
| 1212 | * @param string $path The Magento path of the requested configuration value |
||
| 1213 | * @param mixed $default The default value that has to be returned, if the requested configuration value is not set |
||
| 1214 | * @param string $scope The scope the configuration value has been set |
||
| 1215 | * @param integer $scopeId The scope ID the configuration value has been set |
||
| 1216 | * |
||
| 1217 | * @return mixed The configuration value |
||
| 1218 | * @throws \Exception Is thrown, if nor a value can be found or a default value has been passed |
||
| 1219 | */ |
||
| 1220 | 5 | public function getCoreConfigData($path, $default = null, $scope = ScopeKeys::SCOPE_DEFAULT, $scopeId = 0) |
|
| 1221 | { |
||
| 1222 | |||
| 1223 | // initialize the core config data |
||
| 1224 | $coreConfigData = array( |
||
| 1225 | 5 | MemberNames::PATH => $path, |
|
| 1226 | 5 | MemberNames::SCOPE => $scope, |
|
| 1227 | 5 | MemberNames::SCOPE_ID => $scopeId |
|
| 1228 | ); |
||
| 1229 | |||
| 1230 | // generate the UID from the passed data |
||
| 1231 | 5 | $uniqueIdentifier = $this->coreConfigDataUidGenerator->generate($coreConfigData); |
|
| 1232 | |||
| 1233 | // iterate over the core config data and try to find the requested configuration value |
||
| 1234 | 5 | if (isset($this->coreConfigData[$uniqueIdentifier])) { |
|
| 1235 | 1 | return $this->coreConfigData[$uniqueIdentifier][MemberNames::VALUE]; |
|
| 1236 | } |
||
| 1237 | |||
| 1238 | // query whether or not we've to query for the configuration value on fallback level 'websites' also |
||
| 1239 | 4 | if ($scope === ScopeKeys::SCOPE_STORES) { |
|
| 1240 | // query whether or not the website with the passed ID is available |
||
| 1241 | 2 | foreach ($this->storeWebsites as $storeWebsite) { |
|
| 1242 | 2 | if ($storeWebsite[MemberNames::WEBSITE_ID] === $scopeId) { |
|
| 1243 | // replace scope with 'websites' and website ID |
||
| 1244 | 2 | $coreConfigData = array_merge( |
|
| 1245 | 2 | $coreConfigData, |
|
| 1246 | array( |
||
| 1247 | 2 | MemberNames::SCOPE => ScopeKeys::SCOPE_WEBSITES, |
|
| 1248 | MemberNames::SCOPE_ID => $storeWebsite[MemberNames::WEBSITE_ID] |
||
| 1249 | ) |
||
| 1250 | ); |
||
| 1251 | |||
| 1252 | // generate the UID from the passed data, merged with the 'websites' scope and ID |
||
| 1253 | 2 | $uniqueIdentifier = $this->coreConfigDataUidGenerator->generate($coreConfigData); |
|
| 1254 | |||
| 1255 | // query whether or not, the configuration value on 'websites' level |
||
| 1256 | 2 | View Code Duplication | if (isset($this->coreConfigData[$uniqueIdentifier][MemberNames::VALUE])) { |
| 1257 | 1 | return $this->coreConfigData[$uniqueIdentifier][MemberNames::VALUE]; |
|
| 1258 | } |
||
| 1259 | } |
||
| 1260 | } |
||
| 1261 | } |
||
| 1262 | |||
| 1263 | // replace scope with 'default' and scope ID '0' |
||
| 1264 | 3 | $coreConfigData = array_merge( |
|
| 1265 | 3 | $coreConfigData, |
|
| 1266 | array( |
||
| 1267 | 3 | MemberNames::SCOPE => ScopeKeys::SCOPE_DEFAULT, |
|
| 1268 | MemberNames::SCOPE_ID => 0 |
||
| 1269 | ) |
||
| 1270 | ); |
||
| 1271 | |||
| 1272 | // generate the UID from the passed data, merged with the 'default' scope and ID 0 |
||
| 1273 | 3 | $uniqueIdentifier = $this->coreConfigDataUidGenerator->generate($coreConfigData); |
|
| 1274 | |||
| 1275 | // query whether or not, the configuration value on 'default' level |
||
| 1276 | 3 | View Code Duplication | if (isset($this->coreConfigData[$uniqueIdentifier][MemberNames::VALUE])) { |
| 1277 | 1 | return $this->coreConfigData[$uniqueIdentifier][MemberNames::VALUE]; |
|
| 1278 | } |
||
| 1279 | |||
| 1280 | // if not, return the passed default value |
||
| 1281 | 2 | if ($default !== null) { |
|
| 1282 | 1 | return $default; |
|
| 1283 | } |
||
| 1284 | |||
| 1285 | // throw an exception if no value can be found |
||
| 1286 | // in the Magento configuration |
||
| 1287 | 1 | throw new \Exception( |
|
| 1288 | 1 | sprintf( |
|
| 1289 | 1 | 'Can\'t find a value for configuration "%s-%s-%d" in "core_config_data"', |
|
| 1290 | $path, |
||
| 1291 | $scope, |
||
| 1292 | $scopeId |
||
| 1293 | ) |
||
| 1294 | ); |
||
| 1295 | } |
||
| 1296 | |||
| 1297 | /** |
||
| 1298 | * Resolve the original column name for the passed one. |
||
| 1299 | * |
||
| 1300 | * @param string $columnName The column name that has to be resolved |
||
| 1301 | * |
||
| 1302 | * @return string|null The original column name |
||
| 1303 | */ |
||
| 1304 | 2 | public function resolveOriginalColumnName($columnName) |
|
| 1326 | |||
| 1327 | /** |
||
| 1328 | * Return's the original data if available, or an empty array. |
||
| 1329 | * |
||
| 1330 | * @return array The original data |
||
| 1331 | */ |
||
| 1332 | 2 | public function getOriginalData() |
|
| 1347 | |||
| 1348 | /** |
||
| 1349 | * Query's whether or not the actual column contains original data like |
||
| 1350 | * filename, line number and column names. |
||
| 1351 | * |
||
| 1352 | * @return boolean TRUE if the actual column contains origin data, else FALSE |
||
| 1353 | */ |
||
| 1354 | 2 | public function hasOriginalData() |
|
| 1358 | |||
| 1359 | /** |
||
| 1360 | * Wraps the passed exeception into a new one by trying to resolve the original filname, |
||
| 1361 | * line number and column names and use it for a detailed exception message. |
||
| 1362 | * |
||
| 1363 | * @param array $columnNames The column names that should be resolved and wrapped |
||
| 1364 | * @param \Exception $parent The exception we want to wrap |
||
| 1365 | * @param string $className The class name of the exception type we want to wrap the parent one |
||
| 1366 | * |
||
| 1367 | * @return \Exception the wrapped exception |
||
| 1368 | */ |
||
| 1369 | 1 | public function wrapException( |
|
| 1413 | |||
| 1414 | /** |
||
| 1415 | * Strip's the exception suffix containing filename and line number from the |
||
| 1416 | * passed message. |
||
| 1417 | * |
||
| 1418 | * @param string $message The message to strip the exception suffix from |
||
| 1419 | * |
||
| 1420 | * @return mixed The message without the exception suffix |
||
| 1421 | */ |
||
| 1422 | 1 | public function stripExceptionSuffix($message) |
|
| 1426 | |||
| 1427 | /** |
||
| 1428 | * Append's the exception suffix containing filename and line number to the |
||
| 1429 | * passed message. If no message has been passed, only the suffix will be |
||
| 1430 | * returned |
||
| 1431 | * |
||
| 1432 | * @param string|null $message The message to append the exception suffix to |
||
| 1433 | * @param string|null $filename The filename used to create the suffix |
||
| 1434 | * @param string|null $lineNumber The line number used to create the suffx |
||
| 1435 | * |
||
| 1436 | * @return string The message with the appended exception suffix |
||
| 1437 | */ |
||
| 1438 | 12 | public function appendExceptionSuffix($message = null, $filename = null, $lineNumber = null) |
|
| 1459 | |||
| 1460 | /** |
||
| 1461 | * Raises the value for the counter with the passed key by one. |
||
| 1462 | * |
||
| 1463 | * @param mixed $counterName The name of the counter to raise |
||
| 1464 | * |
||
| 1465 | * @return integer The counter's new value |
||
| 1466 | */ |
||
| 1467 | 1 | public function raiseCounter($counterName) |
|
| 1468 | { |
||
| 1469 | |||
| 1470 | // raise the counter with the passed name |
||
| 1471 | 1 | return $this->getRegistryProcessor()->raiseCounter( |
|
| 1472 | 1 | RegistryKeys::COUNTERS, |
|
| 1473 | $counterName |
||
| 1474 | ); |
||
| 1475 | } |
||
| 1476 | |||
| 1477 | /** |
||
| 1478 | * Merge the passed array into the status of the actual import. |
||
| 1479 | * |
||
| 1480 | * @param array $status The status information to be merged |
||
| 1481 | * |
||
| 1482 | * @return void |
||
| 1483 | */ |
||
| 1484 | 1 | public function mergeAttributesRecursive(array $status) |
|
| 1485 | { |
||
| 1486 | |||
| 1487 | // merge the passed status |
||
| 1488 | 1 | return $this->getRegistryProcessor()->mergeAttributesRecursive( |
|
| 1489 | 1 | RegistryKeys::STATUS, |
|
| 1490 | $status |
||
| 1491 | ); |
||
| 1492 | } |
||
| 1493 | |||
| 1494 | /** |
||
| 1495 | * Return's the entity type code to be used. |
||
| 1496 | * |
||
| 1497 | * @return string The entity type code to be used |
||
| 1498 | */ |
||
| 1499 | public function getEntityTypeCode() |
||
| 1513 | |||
| 1514 | /** |
||
| 1515 | * Concatenates and returns the event name for the actual plugin and subject context. |
||
| 1516 | * |
||
| 1517 | * @param string $eventName The event name to concatenate |
||
| 1518 | * |
||
| 1519 | * @return string The concatenated event name |
||
| 1520 | */ |
||
| 1521 | 9 | protected function getEventName($eventName) |
|
| 1522 | { |
||
| 1523 | 9 | return sprintf( |
|
| 1524 | 9 | '%s.%s.%s', |
|
| 1525 | 9 | $this->getConfiguration()->getPluginConfiguration()->getId(), |
|
| 1526 | 9 | $this->getConfiguration()->getId(), |
|
| 1527 | $eventName |
||
| 1528 | ); |
||
| 1529 | } |
||
| 1530 | |||
| 1531 | /** |
||
| 1532 | * Return's the full opration name, which consists of the Magento edition, the entity type code and the operation name. |
||
| 1533 | * |
||
| 1534 | * @param string $separator The separator used to seperate the elements |
||
| 1535 | * |
||
| 1536 | * @return string The full operation name |
||
| 1537 | */ |
||
| 1538 | public function getFullOperationName($separator = '/') |
||
| 1542 | } |
||
| 1543 |
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..