mcndave/spout
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

various improvements

Browse Source
This commit is contained in:
Adrien Loison 2017-11-19 02:11:03 +01:00
parent 102e17159c
commit 4d1d1c1e87
19 changed files with 90 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/Spout/Reader/CSV/Creator/InternalEntityFactory.php
View File

@ -65,6 +65,24 @@ class InternalEntityFactory implements InternalEntityFactoryInterface
return new RowIterator($filePointer, $optionsManager, $encodingHelper, $this, $globalFunctionsHelper);
}
/**
* @param Cell[] $cells
* @return Row
*/
public function createRow(array $cells = [])
{
return new Row($cells);
}
/**
* @param mixed $cellValue
* @return Cell
*/
public function createCell($cellValue)
{
return new Cell($cellValue);
}
/**
* @param array $cellValues
* @return Row
@ -72,9 +90,9 @@ class InternalEntityFactory implements InternalEntityFactoryInterface
public function createRowFromArray(array $cellValues = [])
{
$cells = array_map(function ($cellValue) {
return new Cell($cellValue);
return $this->createCell($cellValue);
}, $cellValues);
return new Row($cells);
return $this->createRow($cells);
}
}

14
src/Spout/Reader/Common/Creator/InternalEntityFactoryInterface.php
View File

@ -2,9 +2,23 @@
namespace Box\Spout\Reader\Common\Creator;
use Box\Spout\Reader\Common\Entity\Cell;
use Box\Spout\Reader\Common\Entity\Row;
/**
* Interface EntityFactoryInterface
*/
interface InternalEntityFactoryInterface
{
/**
* @param Cell[] $cells
* @return Row
*/
public function createRow(array $cells = []);
/**
* @param mixed $cellValue
* @return Cell
*/
public function createCell($cellValue);
}

8
src/Spout/Reader/Common/Entity/Row.php
View File

@ -65,6 +65,14 @@ class Row
return $this;
}
/**
* @return int
*/
public function getNumCells()
{
return count($this->cells);
}
/**
* @return array The row values, as array
*/

14
src/Spout/Reader/XLSX/Manager/RowManager.php → src/Spout/Reader/Common/Manager/RowManager.php
View File

@ -1,22 +1,22 @@
<?php
namespace Box\Spout\Reader\XLSX\Manager;
namespace Box\Spout\Reader\Common\Manager;
use Box\Spout\Reader\Common\Creator\InternalEntityFactoryInterface;
use Box\Spout\Reader\Common\Entity\Row;
use Box\Spout\Reader\XLSX\Creator\InternalEntityFactory;
/**
* Class RowManager
*/
class RowManager
{
/** @var InternalEntityFactory Factory to create entities */
/** @var InternalEntityFactoryInterface Factory to create entities */
private $entityFactory;
/**
* @param InternalEntityFactory $entityFactory Factory to create entities
* @param InternalEntityFactoryInterface $entityFactory Factory to create entities
*/
public function __construct(InternalEntityFactory $entityFactory)
public function __construct(InternalEntityFactoryInterface $entityFactory)
{
$this->entityFactory = $entityFactory;
}
@ -47,11 +47,11 @@ class RowManager
*/
public function fillMissingIndexesWithEmptyCells(Row $row)
{
$rowCells = $row->getCells();
if (count($rowCells) === 0) {
if ($row->getNumCells() === 0) {
return $row;
}
$rowCells = $row->getCells();
$maxCellIndex = max(array_keys($rowCells));
for ($cellIndex = 0; $cellIndex < $maxCellIndex; $cellIndex++) {

4
src/Spout/Reader/ODS/Creator/InternalEntityFactory.php
View File

@ -73,7 +73,7 @@ class InternalEntityFactory implements InternalEntityFactoryInterface
$shouldFormatDates = $optionsManager->getOption(Options::SHOULD_FORMAT_DATES);
$cellValueFormatter = $this->helperFactory->createCellValueFormatter($shouldFormatDates);
$xmlProcessor = $this->createXMLProcessor($xmlReader);
$rowManager = $this->managerFactory->createRowManager();
$rowManager = $this->managerFactory->createRowManager($this);
return new RowIterator($xmlReader, $optionsManager, $cellValueFormatter, $xmlProcessor, $rowManager, $this);
}
@ -82,7 +82,7 @@ class InternalEntityFactory implements InternalEntityFactoryInterface
* @param Cell[] $cells
* @return Row
*/
public function createRow(array $cells)
public function createRow(array $cells = [])
{
return new Row($cells);
}

7
src/Spout/Reader/ODS/Creator/ManagerFactory.php
View File

@ -2,7 +2,7 @@
namespace Box\Spout\Reader\ODS\Creator;
use Box\Spout\Reader\ODS\Manager\RowManager;
use Box\Spout\Reader\Common\Manager\RowManager;
/**
* Class ManagerFactory
@ -11,10 +11,11 @@ use Box\Spout\Reader\ODS\Manager\RowManager;
class ManagerFactory
{
/**
* @param InternalEntityFactory $entityFactory Factory to create entities
* @return RowManager
*/
public function createRowManager()
public function createRowManager($entityFactory)
{
return new RowManager();
return new RowManager($entityFactory);
}
}

29
src/Spout/Reader/ODS/Manager/RowManager.php
View File

@ -1,29 +0,0 @@
<?php
namespace Box\Spout\Reader\ODS\Manager;
use Box\Spout\Reader\Common\Entity\Row;
/**
* Class RowManager
*/
class RowManager
{
/**
* Detect whether a row is considered empty.
* An empty row has all of its cells empty.
*
* @param Row $row
* @return bool
*/
public function isEmpty(Row $row)
{
foreach ($row->getCells() as $cell) {
if (!$cell->isEmpty()) {
return false;
}
}
return true;
}
}

6
src/Spout/Reader/ODS/RowIterator.php
View File

@ -7,6 +7,7 @@ use Box\Spout\Common\Manager\OptionsManagerInterface;
use Box\Spout\Reader\Common\Entity\Cell;
use Box\Spout\Reader\Common\Entity\Options;
use Box\Spout\Reader\Common\Entity\Row;
use Box\Spout\Reader\Common\Manager\RowManager;
use Box\Spout\Reader\Common\XMLProcessor;
use Box\Spout\Reader\Exception\InvalidValueException;
use Box\Spout\Reader\Exception\IteratorNotRewindableException;
@ -14,7 +15,6 @@ use Box\Spout\Reader\Exception\XMLProcessingException;
use Box\Spout\Reader\IteratorInterface;
use Box\Spout\Reader\ODS\Creator\InternalEntityFactory;
use Box\Spout\Reader\ODS\Helper\CellValueFormatter;
use Box\Spout\Reader\ODS\Manager\RowManager;
use Box\Spout\Reader\Wrapper\XMLReader;
/**
@ -190,7 +190,7 @@ class RowIterator implements IteratorInterface
*/
protected function readDataForNextRow()
{
$this->currentlyProcessedRow = $this->entityFactory->createRow([]);
$this->currentlyProcessedRow = $this->entityFactory->createRow();
try {
$this->xmlProcessor->readUntilStopped();
@ -257,7 +257,7 @@ class RowIterator implements IteratorInterface
// if the row is empty, we don't want to return more than one cell
$actualNumColumnsRepeated = (!$isEmptyRow) ? $this->numColumnsRepeated : 1;
$numCellsInCurrentlyProcessedRow = count($this->currentlyProcessedRow->getCells());
$numCellsInCurrentlyProcessedRow = $this->currentlyProcessedRow->getNumCells();
// Only add the value if the last read cell is not a trailing empty cell repeater in Excel.
// The current count of read columns is determined by counting the values in "$this->currentlyProcessedRowData".

2
src/Spout/Reader/XLSX/Creator/InternalEntityFactory.php
View File

@ -116,7 +116,7 @@ class InternalEntityFactory implements InternalEntityFactoryInterface
* @param Cell[] $cells
* @return Row
*/
public function createRow(array $cells)
public function createRow(array $cells = [])
{
return new Row($cells);
}

2
src/Spout/Reader/XLSX/Creator/ManagerFactory.php
View File

@ -2,7 +2,7 @@
namespace Box\Spout\Reader\XLSX\Creator;
use Box\Spout\Reader\XLSX\Manager\RowManager;
use Box\Spout\Reader\Common\Manager\RowManager;
use Box\Spout\Reader\XLSX\Manager\SharedStringsCaching\CachingStrategyFactory;
use Box\Spout\Reader\XLSX\Manager\SharedStringsManager;
use Box\Spout\Reader\XLSX\Manager\SheetManager;

8
src/Spout/Reader/XLSX/RowIterator.php
View File

@ -5,6 +5,7 @@ namespace Box\Spout\Reader\XLSX;
use Box\Spout\Common\Exception\IOException;
use Box\Spout\Reader\Common\Entity\Cell;
use Box\Spout\Reader\Common\Entity\Row;
use Box\Spout\Reader\Common\Manager\RowManager;
use Box\Spout\Reader\Common\XMLProcessor;
use Box\Spout\Reader\Exception\InvalidValueException;
use Box\Spout\Reader\Exception\XMLProcessingException;
@ -13,7 +14,6 @@ use Box\Spout\Reader\Wrapper\XMLReader;
use Box\Spout\Reader\XLSX\Creator\InternalEntityFactory;
use Box\Spout\Reader\XLSX\Helper\CellHelper;
use Box\Spout\Reader\XLSX\Helper\CellValueFormatter;
use Box\Spout\Reader\XLSX\Manager\RowManager;
/**
* Class RowIterator
@ -47,7 +47,7 @@ class RowIterator implements IteratorInterface
/** @var Helper\CellValueFormatter Helper to format cell values */
protected $cellValueFormatter;
/** @var \Box\Spout\Reader\XLSX\Manager\RowManager Manages rows */
/** @var \Box\Spout\Reader\Common\Manager\RowManager Manages rows */
protected $rowManager;
/** @var \Box\Spout\Reader\XLSX\Creator\InternalEntityFactory Factory to create entities */
@ -215,7 +215,7 @@ class RowIterator implements IteratorInterface
*/
protected function readDataForNextRow()
{
$this->currentlyProcessedRow = $this->entityFactory->createRow([]);
$this->currentlyProcessedRow = $this->entityFactory->createRow();
try {
$this->xmlProcessor->readUntilStopped();
@ -386,7 +386,7 @@ class RowIterator implements IteratorInterface
if ($this->lastRowIndexProcessed !== $this->nextRowIndexToBeProcessed) {
// return empty row if mismatch between last processed row
// and the row that needs to be returned
$rowToBeProcessed = $this->entityFactory->createRow([]);
$rowToBeProcessed = $this->entityFactory->createRow();
}
}

8
src/Spout/Writer/Common/Entity/Row.php
View File

@ -81,4 +81,12 @@ class Row
return $this;
}
/**
* @return int
*/
public function getNumCells()
{
return count($this->cells);
}
}

2
src/Spout/Writer/Common/Manager/WorkbookManagerAbstract.php
View File

@ -259,7 +259,7 @@ abstract class WorkbookManagerAbstract implements WorkbookManagerInterface
// update max num columns for the worksheet
$currentMaxNumColumns = $worksheet->getMaxNumColumns();
$cellsCount = count($row->getCells());
$cellsCount = $row->getNumCells();
$worksheet->setMaxNumColumns(max($currentMaxNumColumns, $cellsCount));
}

3
src/Spout/Writer/ODS/Manager/WorksheetManager.php
View File

@ -111,7 +111,6 @@ class WorksheetManager implements WorksheetManagerInterface
public function addRow(Worksheet $worksheet, Row $row)
{
$cells = $row->getCells();
$cellsCount = count($cells);
$rowStyle = $row->getStyle();
$data = '<table:table-row table:style-name="ro1">';
@ -119,7 +118,7 @@ class WorksheetManager implements WorksheetManagerInterface
$currentCellIndex = 0;
$nextCellIndex = 1;
for ($i = 0; $i < $cellsCount; $i++) {
for ($i = 0; $i < $row->getNumCells(); $i++) {
/** @var Cell $cell */
$cell = $cells[$currentCellIndex];
/** @var Cell|null $nextCell */

2
src/Spout/Writer/XLSX/Manager/WorksheetManager.php
View File

@ -156,7 +156,7 @@ EOD;
$cellIndex = 0;
$rowStyle = $row->getStyle();
$rowIndex = $worksheet->getLastWrittenRowIndex() + 1;
$numCells = count($row->getCells());
$numCells = $row->getNumCells();
$rowXML = '<row r="' . $rowIndex . '" spans="1:' . $numCells . '">';

14
tests/Spout/Reader/Common/Entity/RowTest.php
View File

@ -28,7 +28,7 @@ class RowTest extends \PHPUnit\Framework\TestCase
$row = new Row([], null);
$row->setCells([$this->getCellMock(), $this->getCellMock()]);
$this->assertEquals(2, count($row->getCells()));
$this->assertEquals(2, $row->getNumCells());
}
/**
@ -39,11 +39,11 @@ class RowTest extends \PHPUnit\Framework\TestCase
$row = new Row([], null);
$row->setCells([$this->getCellMock(), $this->getCellMock()]);
$this->assertEquals(2, count($row->getCells()));
$this->assertEquals(2, $row->getNumCells());
$row->setCells([$this->getCellMock()]);
$this->assertEquals(1, count($row->getCells()));
$this->assertEquals(1, $row->getNumCells());
}
/**
@ -53,11 +53,11 @@ class RowTest extends \PHPUnit\Framework\TestCase
{
$row = new Row([], null);
$this->assertEquals(0, count($row->getCells()));
$this->assertEquals(0, $row->getNumCells());
$row->setCells([$this->getCellMock(), $this->getCellMock()]);
$this->assertEquals(2, count($row->getCells()));
$this->assertEquals(2, $row->getNumCells());
}
/**
@ -68,11 +68,11 @@ class RowTest extends \PHPUnit\Framework\TestCase
$row = new Row([], null);
$row->setCells([$this->getCellMock(), $this->getCellMock()]);
$this->assertEquals(2, count($row->getCells()));
$this->assertEquals(2, $row->getNumCells());
$row->addCell($this->getCellMock());
$this->assertEquals(3, count($row->getCells()));
$this->assertEquals(3, $row->getNumCells());
}
/**

2
tests/Spout/Reader/XLSX/Manager/RowManagerTest.php → tests/Spout/Reader/Common/Manager/RowManagerTest.php
View File

@ -1,6 +1,6 @@
<?php
namespace Box\Spout\Reader\XLSX\Manager;
namespace Box\Spout\Reader\Common\Manager;
use Box\Spout\Reader\Common\Entity\Cell;
use Box\Spout\Reader\Common\Entity\Row;

41
tests/Spout/Reader/ODS/Manager/RowManagerTest.php
View File

@ -1,41 +0,0 @@
<?php
namespace Box\Spout\Reader\ODS\Manager;
use Box\Spout\Reader\Common\Entity\Cell;
use Box\Spout\Reader\Common\Entity\Row;
/**
* Class RowManagerTest
*/
class RowManagerTest extends \PHPUnit_Framework_TestCase
{
/**
* @return array
*/
public function dataProviderForTestIsEmptyRow()
{
return [
// cells, expected isEmpty
[[], true],
[[new Cell('')], true],
[[new Cell(''), new Cell('')], true],
[[new Cell(''), new Cell(''), new Cell('Okay')], false],
];
}
/**
* @dataProvider dataProviderForTestIsEmptyRow
*
* @param array $cells
* @param bool $expectedIsEmpty
* @return void
*/
public function testIsEmptyRow(array $cells, $expectedIsEmpty)
{
$rowManager = new RowManager();
$row = new Row($cells);
$this->assertEquals($expectedIsEmpty, $rowManager->isEmpty($row));
}
}

14
tests/Spout/Writer/Common/Entity/RowTest.php
View File

@ -39,7 +39,7 @@ class RowTest extends TestCase
$row = new Row([], null);
$row->setCells([$this->getCellMock(), $this->getCellMock()]);
$this->assertEquals(2, count($row->getCells()));
$this->assertEquals(2, $row->getNumCells());
}
/**
@ -50,11 +50,11 @@ class RowTest extends TestCase
$row = new Row([], null);
$row->setCells([$this->getCellMock(), $this->getCellMock()]);
$this->assertEquals(2, count($row->getCells()));
$this->assertEquals(2, $row->getNumCells());
$row->setCells([$this->getCellMock()]);
$this->assertEquals(1, count($row->getCells()));
$this->assertEquals(1, $row->getNumCells());
}
/**
@ -64,11 +64,11 @@ class RowTest extends TestCase
{
$row = new Row([], null);
$this->assertEquals(0, count($row->getCells()));
$this->assertEquals(0, $row->getNumCells());
$row->setCells([$this->getCellMock(), $this->getCellMock()]);
$this->assertEquals(2, count($row->getCells()));
$this->assertEquals(2, $row->getNumCells());
}
/**
@ -79,11 +79,11 @@ class RowTest extends TestCase
$row = new Row([], null);
$row->setCells([$this->getCellMock(), $this->getCellMock()]);
$this->assertEquals(2, count($row->getCells()));
$this->assertEquals(2, $row->getNumCells());
$row->addCell($this->getCellMock());
$this->assertEquals(3, count($row->getCells()));
$this->assertEquals(3, $row->getNumCells());
}
/**