techdivision /
import
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 |
||
| 47 | abstract class AbstractSubject implements SubjectInterface |
||
| 48 | { |
||
| 49 | |||
| 50 | /** |
||
| 51 | * The trait that provides basic filesystem handling functionality. |
||
| 52 | * |
||
| 53 | * @var TechDivision\Import\Subjects\FilesystemTrait |
||
| 54 | */ |
||
| 55 | use FilesystemTrait; |
||
| 56 | |||
| 57 | /** |
||
| 58 | * The import adapter instance. |
||
| 59 | * |
||
| 60 | * @var \TechDivision\Import\Adapter\AdapterInterface |
||
| 61 | */ |
||
| 62 | protected $importAdapter; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * The system configuration. |
||
| 66 | * |
||
| 67 | * @var \TechDivision\Import\Configuration\SubjectConfigurationInterface |
||
| 68 | */ |
||
| 69 | protected $configuration; |
||
| 70 | |||
| 71 | /** |
||
| 72 | * The array with the system logger instances. |
||
| 73 | * |
||
| 74 | * @var array |
||
| 75 | */ |
||
| 76 | protected $systemLoggers = array(); |
||
| 77 | |||
| 78 | /** |
||
| 79 | * The RegistryProcessor instance to handle running threads. |
||
| 80 | * |
||
| 81 | * @var \TechDivision\Import\Services\RegistryProcessorInterface |
||
| 82 | */ |
||
| 83 | protected $registryProcessor; |
||
| 84 | |||
| 85 | /** |
||
| 86 | * The actions unique serial. |
||
| 87 | * |
||
| 88 | * @var string |
||
| 89 | */ |
||
| 90 | protected $serial; |
||
| 91 | |||
| 92 | /** |
||
| 93 | * The name of the file to be imported. |
||
| 94 | * |
||
| 95 | * @var string |
||
| 96 | */ |
||
| 97 | protected $filename; |
||
| 98 | |||
| 99 | /** |
||
| 100 | * Array with the subject's observers. |
||
| 101 | * |
||
| 102 | * @var array |
||
| 103 | */ |
||
| 104 | protected $observers = array(); |
||
| 105 | |||
| 106 | /** |
||
| 107 | * Array with the subject's callbacks. |
||
| 108 | * |
||
| 109 | * @var array |
||
| 110 | */ |
||
| 111 | protected $callbacks = array(); |
||
| 112 | |||
| 113 | /** |
||
| 114 | * The subject's callback mappings. |
||
| 115 | * |
||
| 116 | * @var array |
||
| 117 | */ |
||
| 118 | protected $callbackMappings = array(); |
||
| 119 | |||
| 120 | /** |
||
| 121 | * Contain's the column names from the header line. |
||
| 122 | * |
||
| 123 | * @var array |
||
| 124 | */ |
||
| 125 | protected $headers = array(); |
||
| 126 | |||
| 127 | /** |
||
| 128 | * The actual line number. |
||
| 129 | * |
||
| 130 | * @var integer |
||
| 131 | */ |
||
| 132 | protected $lineNumber = 0; |
||
| 133 | |||
| 134 | /** |
||
| 135 | * The actual operation name. |
||
| 136 | * |
||
| 137 | * @var string |
||
| 138 | */ |
||
| 139 | protected $operationName ; |
||
| 140 | |||
| 141 | /** |
||
| 142 | * The flag that stop's overserver execution on the actual row. |
||
| 143 | * |
||
| 144 | * @var boolean |
||
| 145 | */ |
||
| 146 | protected $skipRow = false; |
||
| 147 | |||
| 148 | /** |
||
| 149 | * The available root categories. |
||
| 150 | * |
||
| 151 | * @var array |
||
| 152 | */ |
||
| 153 | protected $rootCategories = array(); |
||
| 154 | |||
| 155 | /** |
||
| 156 | * The Magento configuration. |
||
| 157 | * |
||
| 158 | * @var array |
||
| 159 | */ |
||
| 160 | protected $coreConfigData = array(); |
||
| 161 | |||
| 162 | /** |
||
| 163 | * The available stores. |
||
| 164 | * |
||
| 165 | * @var array |
||
| 166 | */ |
||
| 167 | protected $stores = array(); |
||
| 168 | |||
| 169 | /** |
||
| 170 | * The default store. |
||
| 171 | * |
||
| 172 | * @var array |
||
| 173 | */ |
||
| 174 | protected $defaultStore; |
||
| 175 | |||
| 176 | /** |
||
| 177 | * The store view code the create the product/attributes for. |
||
| 178 | * |
||
| 179 | * @var string |
||
| 180 | */ |
||
| 181 | protected $storeViewCode; |
||
| 182 | |||
| 183 | /** |
||
| 184 | * The UID generator for the core config data. |
||
| 185 | * |
||
| 186 | * @var \TechDivision\Import\Utils\Generators\GeneratorInterface |
||
| 187 | */ |
||
| 188 | protected $coreConfigDataUidGenerator; |
||
| 189 | |||
| 190 | /** |
||
| 191 | * The actual row. |
||
| 192 | * |
||
| 193 | * @var array |
||
| 194 | */ |
||
| 195 | protected $row = array(); |
||
| 196 | |||
| 197 | /** |
||
| 198 | * Initialize the subject instance. |
||
| 199 | * |
||
| 200 | * @param \TechDivision\Import\Services\RegistryProcessorInterface $registryProcessor The registry processor instance |
||
| 201 | * @param \TechDivision\Import\Utils\Generators\GeneratorInterface $coreConfigDataUidGenerator The UID generator for the core config data |
||
| 202 | * @param array $systemLoggers The array with the system loggers instances |
||
| 203 | */ |
||
| 204 | 13 | public function __construct( |
|
| 213 | |||
| 214 | /** |
||
| 215 | * Return's the default callback mappings. |
||
| 216 | * |
||
| 217 | * @return array The default callback mappings |
||
| 218 | */ |
||
| 219 | public function getDefaultCallbackMappings() |
||
| 223 | |||
| 224 | /** |
||
| 225 | * Return's the actual row. |
||
| 226 | * |
||
| 227 | * @return array The actual row |
||
| 228 | */ |
||
| 229 | public function getRow() |
||
| 233 | |||
| 234 | /** |
||
| 235 | * Stop's observer execution on the actual row. |
||
| 236 | * |
||
| 237 | * @return void |
||
| 238 | */ |
||
| 239 | public function skipRow() |
||
| 243 | |||
| 244 | /** |
||
| 245 | * Return's the actual line number. |
||
| 246 | * |
||
| 247 | * @return integer The line number |
||
| 248 | */ |
||
| 249 | 1 | public function getLineNumber() |
|
| 253 | |||
| 254 | /** |
||
| 255 | * Return's the actual operation name. |
||
| 256 | * |
||
| 257 | * @return string |
||
| 258 | */ |
||
| 259 | public function getOperationName() |
||
| 263 | |||
| 264 | /** |
||
| 265 | * Set's the array containing header row. |
||
| 266 | * |
||
| 267 | * @param array $headers The array with the header row |
||
| 268 | * |
||
| 269 | * @return void |
||
| 270 | */ |
||
| 271 | 3 | public function setHeaders(array $headers) |
|
| 275 | |||
| 276 | /** |
||
| 277 | * Return's the array containing header row. |
||
| 278 | * |
||
| 279 | * @return array The array with the header row |
||
| 280 | */ |
||
| 281 | 1 | public function getHeaders() |
|
| 285 | |||
| 286 | /** |
||
| 287 | * Queries whether or not the header with the passed name is available. |
||
| 288 | * |
||
| 289 | * @param string $name The header name to query |
||
| 290 | * |
||
| 291 | * @return boolean TRUE if the header is available, else FALSE |
||
| 292 | */ |
||
| 293 | 6 | public function hasHeader($name) |
|
| 297 | |||
| 298 | /** |
||
| 299 | * Return's the header value for the passed name. |
||
| 300 | * |
||
| 301 | * @param string $name The name of the header to return the value for |
||
| 302 | * |
||
| 303 | * @return mixed The header value |
||
| 304 | * \InvalidArgumentException Is thrown, if the header with the passed name is NOT available |
||
| 305 | */ |
||
| 306 | 5 | public function getHeader($name) |
|
| 317 | |||
| 318 | /** |
||
| 319 | * Add's the header with the passed name and position, if not NULL. |
||
| 320 | * |
||
| 321 | * @param string $name The header name to add |
||
| 322 | * |
||
| 323 | * @return integer The new headers position |
||
| 324 | */ |
||
| 325 | 2 | public function addHeader($name) |
|
| 334 | |||
| 335 | /** |
||
| 336 | * Query whether or not a value for the column with the passed name exists. |
||
| 337 | * |
||
| 338 | * @param string $name The column name to query for a valid value |
||
| 339 | * |
||
| 340 | * @return boolean TRUE if the value is set, else FALSE |
||
| 341 | */ |
||
| 342 | 2 | View Code Duplication | public function hasValue($name) |
| 357 | |||
| 358 | /** |
||
| 359 | * Set the value in the passed column name. |
||
| 360 | * |
||
| 361 | * @param string $name The column name to set the value for |
||
| 362 | * @param mixed $value The value to set |
||
| 363 | * |
||
| 364 | * @return void |
||
| 365 | */ |
||
| 366 | 2 | public function setValue($name, $value) |
|
| 370 | |||
| 371 | /** |
||
| 372 | * Resolve's the value with the passed colum name from the actual row. If a callback will |
||
| 373 | * be passed, the callback will be invoked with the found value as parameter. If |
||
| 374 | * the value is NULL or empty, the default value will be returned. |
||
| 375 | * |
||
| 376 | * @param string $name The name of the column to return the value for |
||
| 377 | * @param mixed|null $default The default value, that has to be returned, if the row's value is empty |
||
| 378 | * @param callable|null $callback The callback that has to be invoked on the value, e. g. to format it |
||
| 379 | * |
||
| 380 | * @return mixed|null The, almost formatted, value |
||
| 381 | */ |
||
| 382 | 3 | View Code Duplication | public function getValue($name, $default = null, callable $callback = null) |
| 411 | |||
| 412 | /** |
||
| 413 | * Tries to format the passed value to a valid date with format 'Y-m-d H:i:s'. |
||
| 414 | * If the passed value is NOT a valid date, NULL will be returned. |
||
| 415 | * |
||
| 416 | * @param string $value The value to format |
||
| 417 | * |
||
| 418 | * @return string|null The formatted date or NULL if the date is not valid |
||
| 419 | */ |
||
| 420 | 2 | public function formatDate($value) |
|
| 431 | |||
| 432 | /** |
||
| 433 | * Extracts the elements of the passed value by exploding them |
||
| 434 | * with the also passed delimiter. |
||
| 435 | * |
||
| 436 | * @param string $value The value to extract |
||
| 437 | * @param string|null $delimiter The delimiter used to extrace the elements |
||
| 438 | * |
||
| 439 | * @return array The exploded values |
||
| 440 | */ |
||
| 441 | public function explode($value, $delimiter = null) |
||
| 454 | |||
| 455 | /** |
||
| 456 | * Queries whether or not debug mode is enabled or not, default is TRUE. |
||
| 457 | * |
||
| 458 | * @return boolean TRUE if debug mode is enabled, else FALSE |
||
| 459 | */ |
||
| 460 | public function isDebugMode() |
||
| 464 | |||
| 465 | /** |
||
| 466 | * Set's the subject configuration. |
||
| 467 | * |
||
| 468 | * @param \TechDivision\Import\Configuration\SubjectConfigurationInterface $configuration The subject configuration |
||
| 469 | * |
||
| 470 | * @return void |
||
| 471 | */ |
||
| 472 | 13 | public function setConfiguration(SubjectConfigurationInterface $configuration) |
|
| 476 | |||
| 477 | /** |
||
| 478 | * Return's the subject configuration. |
||
| 479 | * |
||
| 480 | * @return \TechDivision\Import\Configuration\SubjectConfigurationInterface The subject configuration |
||
| 481 | */ |
||
| 482 | 5 | public function getConfiguration() |
|
| 486 | |||
| 487 | /** |
||
| 488 | * Return's the logger with the passed name, by default the system logger. |
||
| 489 | * |
||
| 490 | * @param string $name The name of the requested system logger |
||
| 491 | * |
||
| 492 | * @return \Psr\Log\LoggerInterface The logger instance |
||
| 493 | * @throws \Exception Is thrown, if the requested logger is NOT available |
||
| 494 | */ |
||
| 495 | 2 | public function getSystemLogger($name = LoggerKeys::SYSTEM) |
|
| 506 | |||
| 507 | /** |
||
| 508 | * Set's the import adapter instance. |
||
| 509 | * |
||
| 510 | * @param \TechDivision\Import\Adapter\ImportAdapterInterface $importAdapter The import adapter instance |
||
| 511 | * |
||
| 512 | * @return void |
||
| 513 | */ |
||
| 514 | 2 | public function setImportAdapter(ImportAdapterInterface $importAdapter) |
|
| 518 | |||
| 519 | /** |
||
| 520 | * Return's the import adapter instance. |
||
| 521 | * |
||
| 522 | * @return \TechDivision\Import\Adapter\ImportAdapterInterface The import adapter instance |
||
| 523 | */ |
||
| 524 | 2 | public function getImportAdapter() |
|
| 528 | |||
| 529 | /** |
||
| 530 | * Return's the array with the system logger instances. |
||
| 531 | * |
||
| 532 | * @return array The logger instance |
||
| 533 | */ |
||
| 534 | public function getSystemLoggers() |
||
| 538 | |||
| 539 | /** |
||
| 540 | * Return's the RegistryProcessor instance to handle the running threads. |
||
| 541 | * |
||
| 542 | * @return \TechDivision\Import\Services\RegistryProcessorInterface The registry processor instance |
||
| 543 | */ |
||
| 544 | public function getRegistryProcessor() |
||
| 548 | |||
| 549 | /** |
||
| 550 | * Set's the unique serial for this import process. |
||
| 551 | * |
||
| 552 | * @param string $serial The unique serial |
||
| 553 | * |
||
| 554 | * @return void |
||
| 555 | */ |
||
| 556 | 2 | public function setSerial($serial) |
|
| 560 | |||
| 561 | /** |
||
| 562 | * Return's the unique serial for this import process. |
||
| 563 | * |
||
| 564 | * @return string The unique serial |
||
| 565 | */ |
||
| 566 | public function getSerial() |
||
| 570 | |||
| 571 | /** |
||
| 572 | * Set's the name of the file to import |
||
| 573 | * |
||
| 574 | * @param string $filename The filename |
||
| 575 | * |
||
| 576 | * @return void |
||
| 577 | */ |
||
| 578 | 2 | public function setFilename($filename) |
|
| 582 | |||
| 583 | /** |
||
| 584 | * Return's the name of the file to import. |
||
| 585 | * |
||
| 586 | * @return string The filename |
||
| 587 | */ |
||
| 588 | 1 | public function getFilename() |
|
| 592 | |||
| 593 | /** |
||
| 594 | * Return's the source date format to use. |
||
| 595 | * |
||
| 596 | * @return string The source date format |
||
| 597 | */ |
||
| 598 | 2 | public function getSourceDateFormat() |
|
| 602 | |||
| 603 | /** |
||
| 604 | * Return's the multiple field delimiter character to use, default value is comma (,). |
||
| 605 | * |
||
| 606 | * @return string The multiple field delimiter character |
||
| 607 | */ |
||
| 608 | public function getMultipleFieldDelimiter() |
||
| 612 | |||
| 613 | /** |
||
| 614 | * Return's the multiple value delimiter character to use, default value is comma (|). |
||
| 615 | * |
||
| 616 | * @return string The multiple value delimiter character |
||
| 617 | */ |
||
| 618 | public function getMultipleValueDelimiter() |
||
| 622 | |||
| 623 | /** |
||
| 624 | * Return's the initialized PDO connection. |
||
| 625 | * |
||
| 626 | * @return \PDO The initialized PDO connection |
||
| 627 | */ |
||
| 628 | public function getConnection() |
||
| 632 | |||
| 633 | /** |
||
| 634 | * Intializes the previously loaded global data for exactly one bunch. |
||
| 635 | * |
||
| 636 | * @param string $serial The serial of the actual import |
||
| 637 | * |
||
| 638 | * @return void |
||
| 639 | * @see \Importer\Csv\Actions\ProductImportAction::prepare() |
||
| 640 | */ |
||
| 641 | public function setUp($serial) |
||
| 675 | |||
| 676 | /** |
||
| 677 | * Clean up the global data after importing the variants. |
||
| 678 | * |
||
| 679 | * @param string $serial The serial of the actual import |
||
| 680 | * |
||
| 681 | * @return void |
||
| 682 | */ |
||
| 683 | public function tearDown($serial) |
||
| 700 | |||
| 701 | /** |
||
| 702 | * Return's the next source directory, which will be the target directory |
||
| 703 | * of this subject, in most cases. |
||
| 704 | * |
||
| 705 | * @param string $serial The serial of the actual import |
||
| 706 | * |
||
| 707 | * @return string The new source directory |
||
| 708 | */ |
||
| 709 | protected function getNewSourceDir($serial) |
||
| 713 | |||
| 714 | /** |
||
| 715 | * Register the passed observer with the specific type. |
||
| 716 | * |
||
| 717 | * @param \TechDivision\Import\Observers\ObserverInterface $observer The observer to register |
||
| 718 | * @param string $type The type to register the observer with |
||
| 719 | * |
||
| 720 | * @return void |
||
| 721 | */ |
||
| 722 | public function registerObserver(ObserverInterface $observer, $type) |
||
| 734 | |||
| 735 | /** |
||
| 736 | * Register the passed callback with the specific type. |
||
| 737 | * |
||
| 738 | * @param \TechDivision\Import\Callbacks\CallbackInterface $callback The subject to register the callbacks for |
||
| 739 | * @param string $type The type to register the callback with |
||
| 740 | * |
||
| 741 | * @return void |
||
| 742 | */ |
||
| 743 | public function registerCallback(CallbackInterface $callback, $type) |
||
| 755 | |||
| 756 | /** |
||
| 757 | * Return's the array with callbacks for the passed type. |
||
| 758 | * |
||
| 759 | * @param string $type The type of the callbacks to return |
||
| 760 | * |
||
| 761 | * @return array The callbacks |
||
| 762 | */ |
||
| 763 | public function getCallbacksByType($type) |
||
| 777 | |||
| 778 | /** |
||
| 779 | * Return's the array with the available observers. |
||
| 780 | * |
||
| 781 | * @return array The observers |
||
| 782 | */ |
||
| 783 | public function getObservers() |
||
| 787 | |||
| 788 | /** |
||
| 789 | * Return's the array with the available callbacks. |
||
| 790 | * |
||
| 791 | * @return array The callbacks |
||
| 792 | */ |
||
| 793 | public function getCallbacks() |
||
| 797 | |||
| 798 | /** |
||
| 799 | * Return's the callback mappings for this subject. |
||
| 800 | * |
||
| 801 | * @return array The array with the subject's callback mappings |
||
| 802 | */ |
||
| 803 | public function getCallbackMappings() |
||
| 807 | |||
| 808 | /** |
||
| 809 | * Imports the content of the file with the passed filename. |
||
| 810 | * |
||
| 811 | * |
||
| 812 | * @param string $serial The serial of the actual import |
||
| 813 | * @param string $filename The filename to process |
||
| 814 | * |
||
| 815 | * @return void |
||
| 816 | * @throws \Exception Is thrown, if the import can't be processed |
||
| 817 | */ |
||
| 818 | 3 | public function import($serial, $filename) |
|
| 884 | |||
| 885 | /** |
||
| 886 | * This method queries whether or not the passed filename matches |
||
| 887 | * the pattern, based on the subjects configured prefix. |
||
| 888 | * |
||
| 889 | * @param string $filename The filename to match |
||
| 890 | * |
||
| 891 | * @return boolean TRUE if the filename matches, else FALSE |
||
| 892 | */ |
||
| 893 | 3 | protected function match($filename) |
|
| 906 | |||
| 907 | /** |
||
| 908 | * Imports the passed row into the database. If the import failed, the exception |
||
| 909 | * will be catched and logged, but the import process will be continued. |
||
| 910 | * |
||
| 911 | * @param array $row The row with the data to be imported |
||
| 912 | * |
||
| 913 | * @return void |
||
| 914 | */ |
||
| 915 | public function importRow(array $row) |
||
| 959 | |||
| 960 | /** |
||
| 961 | * Map the passed attribute code, if a header mapping exists and return the |
||
| 962 | * mapped mapping. |
||
| 963 | * |
||
| 964 | * @param string $attributeCode The attribute code to map |
||
| 965 | * |
||
| 966 | * @return string The mapped attribute code, or the original one |
||
| 967 | */ |
||
| 968 | public function mapAttributeCodeByHeaderMapping($attributeCode) |
||
| 982 | |||
| 983 | /** |
||
| 984 | * Queries whether or not that the subject needs an OK file to be processed. |
||
| 985 | * |
||
| 986 | * @return boolean TRUE if the subject needs an OK file, else FALSE |
||
| 987 | */ |
||
| 988 | public function isOkFileNeeded() |
||
| 992 | |||
| 993 | /** |
||
| 994 | * Return's the default store. |
||
| 995 | * |
||
| 996 | * @return array The default store |
||
| 997 | */ |
||
| 998 | public function getDefaultStore() |
||
| 1002 | |||
| 1003 | /** |
||
| 1004 | * Set's the store view code the create the product/attributes for. |
||
| 1005 | * |
||
| 1006 | * @param string $storeViewCode The store view code |
||
| 1007 | * |
||
| 1008 | * @return void |
||
| 1009 | */ |
||
| 1010 | public function setStoreViewCode($storeViewCode) |
||
| 1014 | |||
| 1015 | /** |
||
| 1016 | * Return's the store view code the create the product/attributes for. |
||
| 1017 | * |
||
| 1018 | * @param string|null $default The default value to return, if the store view code has not been set |
||
| 1019 | * |
||
| 1020 | * @return string The store view code |
||
| 1021 | */ |
||
| 1022 | public function getStoreViewCode($default = null) |
||
| 1036 | |||
| 1037 | /** |
||
| 1038 | * Return's the store ID of the store with the passed store view code |
||
| 1039 | * |
||
| 1040 | * @param string $storeViewCode The store view code to return the store ID for |
||
| 1041 | * |
||
| 1042 | * @return integer The ID of the store with the passed ID |
||
| 1043 | * @throws \Exception Is thrown, if the store with the actual code is not available |
||
| 1044 | */ |
||
| 1045 | public function getStoreId($storeViewCode) |
||
| 1063 | |||
| 1064 | /** |
||
| 1065 | * Return's the store ID of the actual row, or of the default store |
||
| 1066 | * if no store view code is set in the CSV file. |
||
| 1067 | * |
||
| 1068 | * @param string|null $default The default store view code to use, if no store view code is set in the CSV file |
||
| 1069 | * |
||
| 1070 | * @return integer The ID of the actual store |
||
| 1071 | * @throws \Exception Is thrown, if the store with the actual code is not available |
||
| 1072 | */ |
||
| 1073 | public function getRowStoreId($default = null) |
||
| 1085 | |||
| 1086 | /** |
||
| 1087 | * Prepare's the store view code in the subject. |
||
| 1088 | * |
||
| 1089 | * @return void |
||
| 1090 | */ |
||
| 1091 | public function prepareStoreViewCode() |
||
| 1102 | |||
| 1103 | /** |
||
| 1104 | * Return's the root category for the actual view store. |
||
| 1105 | * |
||
| 1106 | * @return array The store's root category |
||
| 1107 | * @throws \Exception Is thrown if the root category for the passed store code is NOT available |
||
| 1108 | */ |
||
| 1109 | public function getRootCategory() |
||
| 1126 | |||
| 1127 | /** |
||
| 1128 | * Return's the Magento configuration value. |
||
| 1129 | * |
||
| 1130 | * @param string $path The Magento path of the requested configuration value |
||
| 1131 | * @param mixed $default The default value that has to be returned, if the requested configuration value is not set |
||
| 1132 | * @param string $scope The scope the configuration value has been set |
||
| 1133 | * @param integer $scopeId The scope ID the configuration value has been set |
||
| 1134 | * |
||
| 1135 | * @return mixed The configuration value |
||
| 1136 | * @throws \Exception Is thrown, if nor a value can be found or a default value has been passed |
||
| 1137 | */ |
||
| 1138 | public function getCoreConfigData($path, $default = null, $scope = ScopeKeys::SCOPE_DEFAULT, $scopeId = 0) |
||
| 1209 | |||
| 1210 | /** |
||
| 1211 | * Resolve the original column name for the passed one. |
||
| 1212 | * |
||
| 1213 | * @param string $columnName The column name that has to be resolved |
||
| 1214 | * |
||
| 1215 | * @return string|null The original column name |
||
| 1216 | */ |
||
| 1217 | public function resolveOriginalColumnName($columnName) |
||
| 1239 | |||
| 1240 | /** |
||
| 1241 | * Return's the original data if available, or an empty array. |
||
| 1242 | * |
||
| 1243 | * @return array The original data |
||
| 1244 | */ |
||
| 1245 | public function getOriginalData() |
||
| 1260 | |||
| 1261 | /** |
||
| 1262 | * Query's whether or not the actual column contains original data like |
||
| 1263 | * filename, line number and column names. |
||
| 1264 | * |
||
| 1265 | * @return boolean TRUE if the actual column contains origin data, else FALSE |
||
| 1266 | */ |
||
| 1267 | 1 | public function hasOriginalData() |
|
| 1271 | |||
| 1272 | /** |
||
| 1273 | * Wraps the passed exeception into a new one by trying to resolve the original filname, |
||
| 1274 | * line number and column names and use it for a detailed exception message. |
||
| 1275 | * |
||
| 1276 | * @param array $columnNames The column names that should be resolved and wrapped |
||
| 1277 | * @param \Exception $parent The exception we want to wrap |
||
| 1278 | * @param string $className The class name of the exception type we want to wrap the parent one |
||
| 1279 | * |
||
| 1280 | * @return \Exception the wrapped exception |
||
| 1281 | */ |
||
| 1282 | 1 | public function wrapException( |
|
| 1327 | |||
| 1328 | /** |
||
| 1329 | * Strip's the exception suffix containing filename and line number from the |
||
| 1330 | * passed message. |
||
| 1331 | * |
||
| 1332 | * @param string $message The message to strip the exception suffix from |
||
| 1333 | * |
||
| 1334 | * @return mixed The message without the exception suffix |
||
| 1335 | */ |
||
| 1336 | 1 | public function stripExceptionSuffix($message) |
|
| 1340 | |||
| 1341 | /** |
||
| 1342 | * Append's the exception suffix containing filename and line number to the |
||
| 1343 | * passed message. If no message has been passed, only the suffix will be |
||
| 1344 | * returned |
||
| 1345 | * |
||
| 1346 | * @param string|null $message The message to append the exception suffix to |
||
| 1347 | * @param string|null $filename The filename used to create the suffix |
||
| 1348 | * @param string|null $lineNumber The line number used to create the suffx |
||
| 1349 | * |
||
| 1350 | * @return string The message with the appended exception suffix |
||
| 1351 | */ |
||
| 1352 | 1 | public function appendExceptionSuffix($message = null, $filename = null, $lineNumber = null) |
|
| 1373 | |||
| 1374 | /** |
||
| 1375 | * Raises the value for the counter with the passed key by one. |
||
| 1376 | * |
||
| 1377 | * @param mixed $counterName The name of the counter to raise |
||
| 1378 | * |
||
| 1379 | * @return integer The counter's new value |
||
| 1380 | */ |
||
| 1381 | public function raiseCounter($counterName) |
||
| 1390 | |||
| 1391 | /** |
||
| 1392 | * Merge the passed array into the status of the actual import. |
||
| 1393 | * |
||
| 1394 | * @param array $status The status information to be merged |
||
| 1395 | * |
||
| 1396 | * @return void |
||
| 1397 | */ |
||
| 1398 | public function mergeAttributesRecursive(array $status) |
||
| 1407 | } |
||
| 1408 |
Loading history...
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.