Conditions | 79 |
Paths | > 20000 |
Total Lines | 482 |
Code Lines | 285 |
Lines | 24 |
Ratio | 4.98 % |
Tests | 249 |
CRAP Score | 82.7788 |
Changes | 3 | ||
Bugs | 0 | Features | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
1 | <?php |
||
255 | 7 | public function loadIntoExisting($pFilename, Spreadsheet $spreadsheet) |
|
256 | { |
||
257 | 7 | File::assertFile($pFilename); |
|
258 | |||
259 | 7 | $timezoneObj = new DateTimeZone('Europe/London'); |
|
260 | 7 | $GMT = new \DateTimeZone('UTC'); |
|
261 | |||
262 | 7 | $zip = new ZipArchive(); |
|
263 | 7 | if (!$zip->open($pFilename)) { |
|
264 | throw new Exception('Could not open ' . $pFilename . ' for reading! Error opening file.'); |
||
265 | } |
||
266 | |||
267 | // Meta |
||
268 | |||
269 | 7 | $xml = simplexml_load_string( |
|
270 | 7 | $this->securityScan($zip->getFromName('meta.xml')), |
|
271 | 7 | 'SimpleXMLElement', |
|
272 | 7 | Settings::getLibXmlLoaderOptions() |
|
273 | ); |
||
274 | 7 | $namespacesMeta = $xml->getNamespaces(true); |
|
275 | |||
276 | 7 | $docProps = $spreadsheet->getProperties(); |
|
277 | 7 | $officeProperty = $xml->children($namespacesMeta['office']); |
|
278 | 7 | foreach ($officeProperty as $officePropertyData) { |
|
279 | 7 | $officePropertyDC = []; |
|
280 | 7 | if (isset($namespacesMeta['dc'])) { |
|
281 | 7 | $officePropertyDC = $officePropertyData->children($namespacesMeta['dc']); |
|
282 | } |
||
283 | 7 | foreach ($officePropertyDC as $propertyName => $propertyValue) { |
|
284 | 7 | $propertyValue = (string) $propertyValue; |
|
285 | switch ($propertyName) { |
||
286 | 7 | case 'title': |
|
287 | 5 | $docProps->setTitle($propertyValue); |
|
288 | |||
289 | 5 | break; |
|
290 | 7 | case 'subject': |
|
291 | 5 | $docProps->setSubject($propertyValue); |
|
292 | |||
293 | 5 | break; |
|
294 | 7 | case 'creator': |
|
295 | $docProps->setCreator($propertyValue); |
||
296 | $docProps->setLastModifiedBy($propertyValue); |
||
297 | |||
298 | break; |
||
299 | 7 | case 'date': |
|
300 | 7 | $creationDate = strtotime($propertyValue); |
|
301 | 7 | $docProps->setCreated($creationDate); |
|
302 | 7 | $docProps->setModified($creationDate); |
|
303 | |||
304 | 7 | break; |
|
305 | 5 | case 'description': |
|
306 | 5 | $docProps->setDescription($propertyValue); |
|
307 | |||
308 | 7 | break; |
|
309 | } |
||
310 | } |
||
311 | 7 | $officePropertyMeta = []; |
|
312 | 7 | if (isset($namespacesMeta['dc'])) { |
|
313 | 7 | $officePropertyMeta = $officePropertyData->children($namespacesMeta['meta']); |
|
314 | } |
||
315 | 7 | foreach ($officePropertyMeta as $propertyName => $propertyValue) { |
|
316 | 7 | $propertyValueAttributes = $propertyValue->attributes($namespacesMeta['meta']); |
|
317 | 7 | $propertyValue = (string) $propertyValue; |
|
318 | switch ($propertyName) { |
||
319 | 7 | case 'initial-creator': |
|
320 | 5 | $docProps->setCreator($propertyValue); |
|
321 | |||
322 | 5 | break; |
|
323 | 7 | case 'keyword': |
|
324 | 5 | $docProps->setKeywords($propertyValue); |
|
325 | |||
326 | 5 | break; |
|
327 | 7 | case 'creation-date': |
|
328 | 7 | $creationDate = strtotime($propertyValue); |
|
329 | 7 | $docProps->setCreated($creationDate); |
|
330 | |||
331 | 7 | break; |
|
332 | 7 | case 'user-defined': |
|
333 | 5 | $propertyValueType = Properties::PROPERTY_TYPE_STRING; |
|
334 | 5 | foreach ($propertyValueAttributes as $key => $value) { |
|
335 | 5 | if ($key == 'name') { |
|
336 | 5 | $propertyValueName = (string) $value; |
|
337 | } elseif ($key == 'value-type') { |
||
338 | switch ($value) { |
||
339 | case 'date': |
||
340 | $propertyValue = Properties::convertProperty($propertyValue, 'date'); |
||
341 | $propertyValueType = Properties::PROPERTY_TYPE_DATE; |
||
342 | |||
343 | break; |
||
344 | case 'boolean': |
||
345 | $propertyValue = Properties::convertProperty($propertyValue, 'bool'); |
||
346 | $propertyValueType = Properties::PROPERTY_TYPE_BOOLEAN; |
||
347 | |||
348 | break; |
||
349 | case 'float': |
||
350 | $propertyValue = Properties::convertProperty($propertyValue, 'r4'); |
||
351 | $propertyValueType = Properties::PROPERTY_TYPE_FLOAT; |
||
352 | |||
353 | break; |
||
354 | default: |
||
355 | 5 | $propertyValueType = Properties::PROPERTY_TYPE_STRING; |
|
356 | } |
||
357 | } |
||
358 | } |
||
359 | 5 | $docProps->setCustomProperty($propertyValueName, $propertyValue, $propertyValueType); |
|
360 | |||
361 | 7 | break; |
|
362 | } |
||
363 | } |
||
364 | } |
||
365 | |||
366 | // Content |
||
367 | |||
368 | 7 | $dom = new \DOMDocument('1.01', 'UTF-8'); |
|
369 | 7 | $dom->loadXML( |
|
370 | 7 | $this->securityScan($zip->getFromName('content.xml')), |
|
371 | 7 | Settings::getLibXmlLoaderOptions() |
|
372 | ); |
||
373 | |||
374 | 7 | $officeNs = $dom->lookupNamespaceUri('office'); |
|
375 | 7 | $tableNs = $dom->lookupNamespaceUri('table'); |
|
376 | 7 | $textNs = $dom->lookupNamespaceUri('text'); |
|
377 | 7 | $xlinkNs = $dom->lookupNamespaceUri('xlink'); |
|
378 | |||
379 | 7 | $spreadsheets = $dom->getElementsByTagNameNS($officeNs, 'body') |
|
380 | 7 | ->item(0) |
|
381 | 7 | ->getElementsByTagNameNS($officeNs, 'spreadsheet'); |
|
382 | |||
383 | 7 | foreach ($spreadsheets as $workbookData) { |
|
384 | /** @var \DOMElement $workbookData */ |
||
385 | 7 | $tables = $workbookData->getElementsByTagNameNS($tableNs, 'table'); |
|
386 | |||
387 | 7 | $worksheetID = 0; |
|
388 | 7 | foreach ($tables as $worksheetDataSet) { |
|
389 | /** @var \DOMElement $worksheetDataSet */ |
||
390 | 7 | $worksheetName = $worksheetDataSet->getAttributeNS($tableNs, 'name'); |
|
391 | |||
392 | // Check loadSheetsOnly |
||
393 | 7 | if (isset($this->loadSheetsOnly) |
|
394 | 7 | && $worksheetName |
|
395 | 7 | && !in_array($worksheetName, $this->loadSheetsOnly)) { |
|
396 | continue; |
||
397 | } |
||
398 | |||
399 | // Create sheet |
||
400 | 7 | if ($worksheetID > 0) { |
|
401 | 7 | $spreadsheet->createSheet(); // First sheet is added by default |
|
402 | } |
||
403 | 7 | $spreadsheet->setActiveSheetIndex($worksheetID); |
|
404 | |||
405 | 7 | if ($worksheetName) { |
|
406 | // Use false for $updateFormulaCellReferences to prevent adjustment of worksheet references in |
||
407 | // formula cells... during the load, all formulae should be correct, and we're simply |
||
408 | // bringing the worksheet name in line with the formula, not the reverse |
||
409 | 7 | $spreadsheet->getActiveSheet()->setTitle($worksheetName, false, false); |
|
410 | } |
||
411 | |||
412 | // Go through every child of table element |
||
413 | 7 | $rowID = 1; |
|
414 | 7 | foreach ($worksheetDataSet->childNodes as $childNode) { |
|
415 | /** @var \DOMElement $childNode */ |
||
416 | |||
417 | // Filter elements which are not under the "table" ns |
||
418 | 7 | if ($childNode->namespaceURI != $tableNs) { |
|
419 | 5 | continue; |
|
420 | } |
||
421 | |||
422 | 7 | $key = $childNode->nodeName; |
|
423 | |||
424 | // Remove ns from node name |
||
425 | 7 | if (strpos($key, ':') !== false) { |
|
426 | 7 | $keyChunks = explode(':', $key); |
|
427 | 7 | $key = array_pop($keyChunks); |
|
428 | } |
||
429 | |||
430 | switch ($key) { |
||
431 | 7 | case 'table-header-rows': |
|
432 | /// TODO :: Figure this out. This is only a partial implementation I guess. |
||
433 | // ($rowData it's not used at all and I'm not sure that PHPExcel |
||
434 | // has an API for this) |
||
435 | |||
436 | // foreach ($rowData as $keyRowData => $cellData) { |
||
437 | // $rowData = $cellData; |
||
438 | // break; |
||
439 | // } |
||
440 | break; |
||
441 | 7 | case 'table-row': |
|
442 | 7 | if ($childNode->hasAttributeNS($tableNs, 'number-rows-repeated')) { |
|
443 | 7 | $rowRepeats = $childNode->getAttributeNS($tableNs, 'number-rows-repeated'); |
|
444 | } else { |
||
445 | 7 | $rowRepeats = 1; |
|
446 | } |
||
447 | |||
448 | 7 | $columnID = 'A'; |
|
449 | 7 | foreach ($childNode->childNodes as $key => $cellData) { |
|
450 | // @var \DOMElement $cellData |
||
451 | |||
452 | 7 | View Code Duplication | if ($this->getReadFilter() !== null) { |
453 | 7 | if (!$this->getReadFilter()->readCell($columnID, $rowID, $worksheetName)) { |
|
454 | ++$columnID; |
||
455 | |||
456 | continue; |
||
457 | } |
||
458 | } |
||
459 | |||
460 | // Initialize variables |
||
461 | 7 | $formatting = $hyperlink = null; |
|
462 | 7 | $hasCalculatedValue = false; |
|
463 | 7 | $cellDataFormula = ''; |
|
464 | |||
465 | 7 | if ($cellData->hasAttributeNS($tableNs, 'formula')) { |
|
466 | 5 | $cellDataFormula = $cellData->getAttributeNS($tableNs, 'formula'); |
|
467 | 5 | $hasCalculatedValue = true; |
|
468 | } |
||
469 | |||
470 | // Annotations |
||
471 | 7 | $annotation = $cellData->getElementsByTagNameNS($officeNs, 'annotation'); |
|
472 | |||
473 | 7 | if ($annotation->length > 0) { |
|
474 | 5 | $textNode = $annotation->item(0)->getElementsByTagNameNS($textNs, 'p'); |
|
475 | |||
476 | 5 | if ($textNode->length > 0) { |
|
477 | 5 | $text = $this->scanElementForText($textNode->item(0)); |
|
478 | |||
479 | 5 | $spreadsheet->getActiveSheet() |
|
480 | 5 | ->getComment($columnID . $rowID) |
|
481 | 5 | ->setText($this->parseRichText($text)); |
|
482 | // ->setAuthor( $author ) |
||
483 | } |
||
484 | } |
||
485 | |||
486 | // Content |
||
487 | |||
488 | /** @var \DOMElement[] $paragraphs */ |
||
489 | 7 | $paragraphs = []; |
|
490 | |||
491 | 7 | foreach ($cellData->childNodes as $item) { |
|
492 | /** @var \DOMElement $item */ |
||
493 | |||
494 | // Filter text:p elements |
||
495 | 7 | if ($item->nodeName == 'text:p') { |
|
496 | 7 | $paragraphs[] = $item; |
|
497 | } |
||
498 | } |
||
499 | |||
500 | 7 | if (count($paragraphs) > 0) { |
|
501 | // Consolidate if there are multiple p records (maybe with spans as well) |
||
502 | 7 | $dataArray = []; |
|
503 | |||
504 | // Text can have multiple text:p and within those, multiple text:span. |
||
505 | // text:p newlines, but text:span does not. |
||
506 | // Also, here we assume there is no text data is span fields are specified, since |
||
507 | // we have no way of knowing proper positioning anyway. |
||
508 | |||
509 | 7 | foreach ($paragraphs as $pData) { |
|
510 | 7 | $dataArray[] = $this->scanElementForText($pData); |
|
511 | } |
||
512 | 7 | $allCellDataText = implode($dataArray, "\n"); |
|
513 | |||
514 | 7 | $type = $cellData->getAttributeNS($officeNs, 'value-type'); |
|
515 | |||
516 | switch ($type) { |
||
517 | 7 | case 'string': |
|
518 | 7 | $type = DataType::TYPE_STRING; |
|
519 | 7 | $dataValue = $allCellDataText; |
|
520 | |||
521 | 7 | foreach ($paragraphs as $paragraph) { |
|
522 | 7 | $link = $paragraph->getElementsByTagNameNS($textNs, 'a'); |
|
523 | 7 | if ($link->length > 0) { |
|
524 | 7 | $hyperlink = $link->item(0)->getAttributeNS($xlinkNs, 'href'); |
|
525 | } |
||
526 | } |
||
527 | |||
528 | 7 | break; |
|
529 | 7 | case 'boolean': |
|
530 | 5 | $type = DataType::TYPE_BOOL; |
|
531 | 5 | $dataValue = ($allCellDataText == 'TRUE') ? true : false; |
|
532 | |||
533 | 5 | break; |
|
534 | 7 | View Code Duplication | case 'percentage': |
535 | 3 | $type = DataType::TYPE_NUMERIC; |
|
536 | 3 | $dataValue = (float) $cellData->getAttributeNS($officeNs, 'value'); |
|
537 | |||
538 | 3 | if (floor($dataValue) == $dataValue) { |
|
539 | $dataValue = (int) $dataValue; |
||
540 | } |
||
541 | 3 | $formatting = NumberFormat::FORMAT_PERCENTAGE_00; |
|
542 | |||
543 | 3 | break; |
|
544 | 7 | View Code Duplication | case 'currency': |
545 | 3 | $type = DataType::TYPE_NUMERIC; |
|
546 | 3 | $dataValue = (float) $cellData->getAttributeNS($officeNs, 'value'); |
|
547 | |||
548 | 3 | if (floor($dataValue) == $dataValue) { |
|
549 | 3 | $dataValue = (int) $dataValue; |
|
550 | } |
||
551 | 3 | $formatting = NumberFormat::FORMAT_CURRENCY_USD_SIMPLE; |
|
552 | |||
553 | 3 | break; |
|
554 | 5 | case 'float': |
|
555 | 5 | $type = DataType::TYPE_NUMERIC; |
|
556 | 5 | $dataValue = (float) $cellData->getAttributeNS($officeNs, 'value'); |
|
557 | |||
558 | 5 | if (floor($dataValue) == $dataValue) { |
|
559 | 5 | if ($dataValue == (int) $dataValue) { |
|
560 | 5 | $dataValue = (int) $dataValue; |
|
561 | } else { |
||
562 | $dataValue = (float) $dataValue; |
||
563 | } |
||
564 | } |
||
565 | |||
566 | 5 | break; |
|
567 | 5 | case 'date': |
|
568 | 5 | $type = DataType::TYPE_NUMERIC; |
|
569 | 5 | $value = $cellData->getAttributeNS($officeNs, 'date-value'); |
|
570 | |||
571 | 5 | $dateObj = new DateTime($value, $GMT); |
|
572 | 5 | $dateObj->setTimeZone($timezoneObj); |
|
573 | 5 | list($year, $month, $day, $hour, $minute, $second) = explode( |
|
574 | 5 | ' ', |
|
575 | 5 | $dateObj->format('Y m d H i s') |
|
576 | ); |
||
577 | |||
578 | 5 | $dataValue = Date::formattedPHPToExcel( |
|
579 | 5 | $year, |
|
580 | 5 | $month, |
|
581 | 5 | $day, |
|
582 | 5 | $hour, |
|
583 | 5 | $minute, |
|
584 | 5 | $second |
|
585 | ); |
||
586 | |||
587 | 5 | if ($dataValue != floor($dataValue)) { |
|
588 | 1 | $formatting = NumberFormat::FORMAT_DATE_XLSX15 |
|
589 | 1 | . ' ' |
|
590 | 5 | . NumberFormat::FORMAT_DATE_TIME4; |
|
591 | } else { |
||
592 | 5 | $formatting = NumberFormat::FORMAT_DATE_XLSX15; |
|
593 | } |
||
594 | |||
595 | 5 | break; |
|
596 | 5 | case 'time': |
|
597 | 5 | $type = DataType::TYPE_NUMERIC; |
|
598 | |||
599 | 5 | $timeValue = $cellData->getAttributeNS($officeNs, 'time-value'); |
|
600 | |||
601 | 5 | $dataValue = Date::PHPToExcel( |
|
602 | 5 | strtotime( |
|
603 | 5 | '01-01-1970 ' . implode(':', sscanf($timeValue, 'PT%dH%dM%dS')) |
|
604 | ) |
||
605 | ); |
||
606 | 5 | $formatting = NumberFormat::FORMAT_DATE_TIME4; |
|
607 | |||
608 | 5 | break; |
|
609 | default: |
||
610 | 7 | $dataValue = null; |
|
611 | } |
||
612 | } else { |
||
613 | 7 | $type = DataType::TYPE_NULL; |
|
614 | 7 | $dataValue = null; |
|
615 | } |
||
616 | |||
617 | 7 | if ($hasCalculatedValue) { |
|
618 | 5 | $type = DataType::TYPE_FORMULA; |
|
619 | 5 | $cellDataFormula = substr($cellDataFormula, strpos($cellDataFormula, ':=') + 1); |
|
620 | 5 | $temp = explode('"', $cellDataFormula); |
|
1 ignored issue
–
show
|
|||
621 | 5 | $tKey = false; |
|
622 | 5 | foreach ($temp as &$value) { |
|
623 | // Only replace in alternate array entries (i.e. non-quoted blocks) |
||
624 | 5 | if ($tKey = !$tKey) { |
|
625 | // Cell range reference in another sheet |
||
626 | 5 | $value = preg_replace('/\[([^\.]+)\.([^\.]+):\.([^\.]+)\]/U', '$1!$2:$3', $value); |
|
627 | |||
628 | // Cell reference in another sheet |
||
629 | 5 | $value = preg_replace('/\[([^\.]+)\.([^\.]+)\]/U', '$1!$2', $value); |
|
630 | |||
631 | // Cell range reference |
||
632 | 5 | $value = preg_replace('/\[\.([^\.]+):\.([^\.]+)\]/U', '$1:$2', $value); |
|
633 | |||
634 | // Simple cell reference |
||
635 | 5 | $value = preg_replace('/\[\.([^\.]+)\]/U', '$1', $value); |
|
636 | |||
637 | 5 | $value = Calculation::translateSeparator(';', ',', $value, $inBraces); |
|
638 | } |
||
639 | } |
||
640 | 5 | unset($value); |
|
641 | |||
642 | // Then rebuild the formula string |
||
643 | 5 | $cellDataFormula = implode('"', $temp); |
|
644 | } |
||
645 | |||
646 | 7 | if ($cellData->hasAttributeNS($tableNs, 'number-columns-repeated')) { |
|
647 | 7 | $colRepeats = (int) $cellData->getAttributeNS($tableNs, 'number-columns-repeated'); |
|
648 | } else { |
||
649 | 7 | $colRepeats = 1; |
|
650 | } |
||
651 | |||
652 | 7 | if ($type !== null) { |
|
653 | 7 | for ($i = 0; $i < $colRepeats; ++$i) { |
|
654 | 7 | if ($i > 0) { |
|
655 | 7 | ++$columnID; |
|
656 | } |
||
657 | |||
658 | 7 | if ($type !== DataType::TYPE_NULL) { |
|
659 | 7 | for ($rowAdjust = 0; $rowAdjust < $rowRepeats; ++$rowAdjust) { |
|
660 | 7 | $rID = $rowID + $rowAdjust; |
|
661 | |||
662 | 7 | $cell = $spreadsheet->getActiveSheet() |
|
663 | 7 | ->getCell($columnID . $rID); |
|
664 | |||
665 | // Set value |
||
666 | 7 | if ($hasCalculatedValue) { |
|
667 | 5 | $cell->setValueExplicit($cellDataFormula, $type); |
|
668 | } else { |
||
669 | 7 | $cell->setValueExplicit($dataValue, $type); |
|
670 | } |
||
671 | |||
672 | 7 | if ($hasCalculatedValue) { |
|
673 | 5 | $cell->setCalculatedValue($dataValue); |
|
674 | } |
||
675 | |||
676 | // Set other properties |
||
677 | 7 | if ($formatting !== null) { |
|
678 | 7 | $spreadsheet->getActiveSheet() |
|
679 | 7 | ->getStyle($columnID . $rID) |
|
680 | 7 | ->getNumberFormat() |
|
681 | 7 | ->setFormatCode($formatting); |
|
682 | } else { |
||
683 | 7 | $spreadsheet->getActiveSheet() |
|
684 | 7 | ->getStyle($columnID . $rID) |
|
685 | 7 | ->getNumberFormat() |
|
686 | 7 | ->setFormatCode(NumberFormat::FORMAT_GENERAL); |
|
687 | } |
||
688 | |||
689 | 7 | if ($hyperlink !== null) { |
|
690 | 5 | $cell->getHyperlink() |
|
691 | 5 | ->setUrl($hyperlink); |
|
692 | } |
||
693 | } |
||
694 | } |
||
695 | } |
||
696 | } |
||
697 | |||
698 | // Merged cells |
||
699 | 7 | if ($cellData->hasAttributeNS($tableNs, 'number-columns-spanned') |
|
700 | 7 | || $cellData->hasAttributeNS($tableNs, 'number-rows-spanned') |
|
701 | ) { |
||
702 | 5 | if (($type !== DataType::TYPE_NULL) || (!$this->readDataOnly)) { |
|
703 | 5 | $columnTo = $columnID; |
|
704 | |||
705 | 5 | if ($cellData->hasAttributeNS($tableNs, 'number-columns-spanned')) { |
|
706 | 5 | $columnIndex = Coordinate::columnIndexFromString($columnID); |
|
707 | 5 | $columnIndex += (int) $cellData->getAttributeNS($tableNs, 'number-columns-spanned'); |
|
708 | 5 | $columnIndex -= 2; |
|
709 | |||
710 | 5 | $columnTo = Coordinate::stringFromColumnIndex($columnIndex + 1); |
|
711 | } |
||
712 | |||
713 | 5 | $rowTo = $rowID; |
|
714 | |||
715 | 5 | if ($cellData->hasAttributeNS($tableNs, 'number-rows-spanned')) { |
|
716 | 5 | $rowTo = $rowTo + (int) $cellData->getAttributeNS($tableNs, 'number-rows-spanned') - 1; |
|
717 | } |
||
718 | |||
719 | 5 | $cellRange = $columnID . $rowID . ':' . $columnTo . $rowTo; |
|
720 | 5 | $spreadsheet->getActiveSheet()->mergeCells($cellRange); |
|
721 | } |
||
722 | } |
||
723 | |||
724 | 7 | ++$columnID; |
|
725 | } |
||
726 | 7 | $rowID += $rowRepeats; |
|
727 | |||
728 | 7 | break; |
|
729 | } |
||
730 | } |
||
731 | 7 | ++$worksheetID; |
|
732 | } |
||
733 | } |
||
734 | |||
735 | // Return |
||
736 | 7 | return $spreadsheet; |
|
737 | } |
||
789 |
This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.
Consider making the comparison explicit by using
empty(..)
or! empty(...)
instead.