WorksheetManager::addNonEmptyRow() - Code Metrics - Inspection of "Add support for cells in error when writing XLSX a..." - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( eb88bb...7964da )

by Adrien

created 2019-12-02 21:21 UTC

WorksheetManager::addNonEmptyRow() A

↳ Parent: WorksheetManager

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	3.0052

Importance

Changes

Metric	Value
dl	0
loc	19
ccs	11
cts	12
cp	0.9167
rs	9.6333
c	0
b	0
f	0
cc	3
nc	4
nop	2
crap	3.0052

<?php

namespace Box\Spout\Writer\XLSX\Manager;

use Box\Spout\Common\Entity\Cell;
use Box\Spout\Common\Entity\Row;
use Box\Spout\Common\Entity\Style\Style;
use Box\Spout\Common\Exception\InvalidArgumentException;
use Box\Spout\Common\Exception\IOException;
use Box\Spout\Common\Helper\Escaper\XLSX as XLSXEscaper;
use Box\Spout\Common\Helper\StringHelper;
use Box\Spout\Common\Manager\OptionsManagerInterface;
use Box\Spout\Writer\Common\Creator\InternalEntityFactory;
use Box\Spout\Writer\Common\Entity\Options;
use Box\Spout\Writer\Common\Entity\Worksheet;
use Box\Spout\Writer\Common\Helper\CellHelper;
use Box\Spout\Writer\Common\Manager\RowManager;
use Box\Spout\Writer\Common\Manager\Style\StyleMerger;
use Box\Spout\Writer\Common\Manager\WorksheetManagerInterface;
use Box\Spout\Writer\XLSX\Manager\Style\StyleManager;

/**
 * Class WorksheetManager
 * XLSX worksheet manager, providing the interfaces to work with XLSX worksheets.
 */
class WorksheetManager implements WorksheetManagerInterface
{
    /**
     * Maximum number of characters a cell can contain
     * @see https://support.office.com/en-us/article/Excel-specifications-and-limits-16c69c74-3d6a-4aaf-ba35-e6eb276e8eaa [Excel 2007]
     * @see https://support.office.com/en-us/article/Excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3 [Excel 2010]
     * @see https://support.office.com/en-us/article/Excel-specifications-and-limits-ca36e2dc-1f09-4620-b726-67c00b05040f [Excel 2013/2016]
     */
    const MAX_CHARACTERS_PER_CELL = 32767;

    const SHEET_XML_FILE_HEADER = <<<'EOD'
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">
EOD;

    /** @var bool Whether inline or shared strings should be used */
    protected $shouldUseInlineStrings;

    /** @var RowManager Manages rows */
    private $rowManager;

    /** @var StyleManager Manages styles */
    private $styleManager;

    /** @var StyleMerger Helper to merge styles together */
    private $styleMerger;

    /** @var SharedStringsManager Helper to write shared strings */
    private $sharedStringsManager;

    /** @var XLSXEscaper Strings escaper */
    private $stringsEscaper;

    /** @var StringHelper String helper */
    private $stringHelper;

    /** @var InternalEntityFactory Factory to create entities */
    private $entityFactory;

    /**
     * WorksheetManager constructor.
     *
     * @param OptionsManagerInterface $optionsManager
     * @param RowManager $rowManager
     * @param StyleManager $styleManager
     * @param StyleMerger $styleMerger
     * @param SharedStringsManager $sharedStringsManager
     * @param XLSXEscaper $stringsEscaper
     * @param StringHelper $stringHelper
     * @param InternalEntityFactory $entityFactory
     */
    public function __construct(
        OptionsManagerInterface $optionsManager,
        RowManager $rowManager,
        StyleManager $styleManager,
        StyleMerger $styleMerger,
        SharedStringsManager $sharedStringsManager,
        XLSXEscaper $stringsEscaper,
        StringHelper $stringHelper,
        InternalEntityFactory $entityFactory
    ) {
        $this->shouldUseInlineStrings = $optionsManager->getOption(Options::SHOULD_USE_INLINE_STRINGS);
        $this->rowManager = $rowManager;
        $this->styleManager = $styleManager;
        $this->styleMerger = $styleMerger;
        $this->sharedStringsManager = $sharedStringsManager;
        $this->stringsEscaper = $stringsEscaper;
        $this->stringHelper = $stringHelper;
        $this->entityFactory = $entityFactory;
    }

    /**
     * @return SharedStringsManager
     */
    public function getSharedStringsManager()
    {
        return $this->sharedStringsManager;
    }

    /**
     * {@inheritdoc}
     */
    public function startSheet(Worksheet $worksheet)
    {
        $sheetFilePointer = \fopen($worksheet->getFilePath(), 'w');
        $this->throwIfSheetFilePointerIsNotAvailable($sheetFilePointer);

        $worksheet->setFilePointer($sheetFilePointer);

        \fwrite($sheetFilePointer, self::SHEET_XML_FILE_HEADER);
        \fwrite($sheetFilePointer, '<sheetData>');
    }

    /**
     * Checks if the sheet has been sucessfully created. Throws an exception if not.
     *
     * @param bool|resource $sheetFilePointer Pointer to the sheet data file or FALSE if unable to open the file
     * @throws IOException If the sheet data file cannot be opened for writing
     * @return void
     */
    private function throwIfSheetFilePointerIsNotAvailable($sheetFilePointer)
    {
        if (!$sheetFilePointer) {
            throw new IOException('Unable to open sheet for writing.');
        }
    }

    /**
     * {@inheritdoc}
     */
    public function addRow(Worksheet $worksheet, Row $row)
    {
        if (!$this->rowManager->isEmpty($row)) {
            $this->addNonEmptyRow($worksheet, $row);
        }

        $worksheet->setLastWrittenRowIndex($worksheet->getLastWrittenRowIndex() + 1);
    }

    /**
     * Adds non empty row to the worksheet.
     *
     * @param Worksheet $worksheet The worksheet to add the row to
     * @param Row $row The row to be written
     * @throws IOException If the data cannot be written
     * @throws InvalidArgumentException If a cell value's type is not supported
     * @return void
     */
    private function addNonEmptyRow(Worksheet $worksheet, Row $row)
    {
        $rowStyle = $row->getStyle();
        $rowIndexOneBased = $worksheet->getLastWrittenRowIndex() + 1;
        $numCells = $row->getNumCells();

        $rowXML = '<row r="' . $rowIndexOneBased . '" spans="1:' . $numCells . '">';

        foreach ($row->getCells() as $columnIndexZeroBased => $cell) {
            $rowXML .= $this->applyStyleAndGetCellXML($cell, $rowStyle, $rowIndexOneBased, $columnIndexZeroBased);
        }

        $rowXML .= '</row>';

        $wasWriteSuccessful = \fwrite($worksheet->getFilePointer(), $rowXML);
        if ($wasWriteSuccessful === false) {
            throw new IOException("Unable to write data in {$worksheet->getFilePath()}");
        }
    }

    /**
     * Applies styles to the given style, merging the cell's style with its row's style
     * Then builds and returns xml for the cell.
     *
     * @param Cell  $cell
     * @param Style $rowStyle
     * @param int   $rowIndexOneBased
     * @param int   $columnIndexZeroBased
     *
     * @throws InvalidArgumentException If the given value cannot be processed
     * @return string
     */
    private function applyStyleAndGetCellXML(Cell $cell, Style $rowStyle, $rowIndexOneBased, $columnIndexZeroBased)
    {
        // Apply row and extra styles
        $mergedCellAndRowStyle = $this->styleMerger->merge($cell->getStyle(), $rowStyle);
        $cell->setStyle($mergedCellAndRowStyle);
        $newCellStyle = $this->styleManager->applyExtraStylesIfNeeded($cell);

        $registeredStyle = $this->styleManager->registerStyle($newCellStyle);

        return $this->getCellXML($rowIndexOneBased, $columnIndexZeroBased, $cell, $registeredStyle->getId());
    }

    /**
     * Builds and returns xml for a single cell.
     *
     * @param int  $rowIndexOneBased
     * @param int  $columnIndexZeroBased
     * @param Cell $cell
     * @param int  $styleId
     *
     * @throws InvalidArgumentException If the given value cannot be processed
     * @return string
     */
    private function getCellXML($rowIndexOneBased, $columnIndexZeroBased, Cell $cell, $styleId)
    {
        $columnLetters = CellHelper::getColumnLettersFromColumnIndex($columnIndexZeroBased);
        $cellXML = '<c r="' . $columnLetters . $rowIndexOneBased . '"';
        $cellXML .= ' s="' . $styleId . '"';

        if ($cell->isString()) {
            $cellXML .= $this->getCellXMLFragmentForNonEmptyString($cell->getValue());
        } elseif ($cell->isBoolean()) {
            $cellXML .= ' t="b"><v>' . (int) ($cell->getValue()) . '</v></c>';
        } elseif ($cell->isNumeric()) {
            $cellXML .= '><v>' . $cell->getValue() . '</v></c>';
        } elseif ($cell->isError() && is_string($cell->getValueEvenIfError())) {
            // only writes the error value if it's a string
            $cellXML .= ' t="e"><v>' . $cell->getValueEvenIfError() . '</v></c>';
        } elseif ($cell->isEmpty()) {
            if ($this->styleManager->shouldApplyStyleOnEmptyCell($styleId)) {
                $cellXML .= '/>';
            } else {
                // don't write empty cells that do no need styling
                // NOTE: not appending to $cellXML is the right behavior!!
                $cellXML = '';
            }
        } else {
            throw new InvalidArgumentException('Trying to add a value with an unsupported type: ' . \gettype($cell->getValue()));
        }

        return $cellXML;
    }

    /**
     * Returns the XML fragment for a cell containing a non empty string
     *
     * @param string $cellValue The cell value
     * @throws InvalidArgumentException If the string exceeds the maximum number of characters allowed per cell
     * @return string The XML fragment representing the cell
     */
    private function getCellXMLFragmentForNonEmptyString($cellValue)
    {
        if ($this->stringHelper->getStringLength($cellValue) > self::MAX_CHARACTERS_PER_CELL) {
            throw new InvalidArgumentException('Trying to add a value that exceeds the maximum number of characters allowed in a cell (32,767)');
        }

        if ($this->shouldUseInlineStrings) {
            $cellXMLFragment = ' t="inlineStr"><is><t>' . $this->stringsEscaper->escape($cellValue) . '</t></is></c>';
        } else {
            $sharedStringId = $this->sharedStringsManager->writeString($cellValue);
            $cellXMLFragment = ' t="s"><v>' . $sharedStringId . '</v></c>';
        }

        return $cellXMLFragment;
    }

    /**
     * {@inheritdoc}
     */
    public function close(Worksheet $worksheet)
    {
        $worksheetFilePointer = $worksheet->getFilePointer();

        if (!\is_resource($worksheetFilePointer)) {
            return;
        }

        \fwrite($worksheetFilePointer, '</sheetData>');
        \fwrite($worksheetFilePointer, '</worksheet>');
        \fclose($worksheetFilePointer);
    }
}


1		<?php
2
3		namespace Box\Spout\Writer\XLSX\Manager;
4
5		use Box\Spout\Common\Entity\Cell;
6		use Box\Spout\Common\Entity\Row;
7		use Box\Spout\Common\Entity\Style\Style;
8		use Box\Spout\Common\Exception\InvalidArgumentException;
9		use Box\Spout\Common\Exception\IOException;
10		use Box\Spout\Common\Helper\Escaper\XLSX as XLSXEscaper;
11		use Box\Spout\Common\Helper\StringHelper;
12		use Box\Spout\Common\Manager\OptionsManagerInterface;
13		use Box\Spout\Writer\Common\Creator\InternalEntityFactory;
14		use Box\Spout\Writer\Common\Entity\Options;
15		use Box\Spout\Writer\Common\Entity\Worksheet;
16		use Box\Spout\Writer\Common\Helper\CellHelper;
17		use Box\Spout\Writer\Common\Manager\RowManager;
18		use Box\Spout\Writer\Common\Manager\Style\StyleMerger;
19		use Box\Spout\Writer\Common\Manager\WorksheetManagerInterface;
20		use Box\Spout\Writer\XLSX\Manager\Style\StyleManager;
21
22		/**
23		* Class WorksheetManager
24		* XLSX worksheet manager, providing the interfaces to work with XLSX worksheets.
25		*/
26		class WorksheetManager implements WorksheetManagerInterface
27		{
28		/**
29		* Maximum number of characters a cell can contain
30		* @see https://support.office.com/en-us/article/Excel-specifications-and-limits-16c69c74-3d6a-4aaf-ba35-e6eb276e8eaa [Excel 2007]
31		* @see https://support.office.com/en-us/article/Excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3 [Excel 2010]
32		* @see https://support.office.com/en-us/article/Excel-specifications-and-limits-ca36e2dc-1f09-4620-b726-67c00b05040f [Excel 2013/2016]
33		*/
34		const MAX_CHARACTERS_PER_CELL = 32767;
35
36		const SHEET_XML_FILE_HEADER = <<<'EOD'
37		<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
38		<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">
39		EOD;
40
41		/** @var bool Whether inline or shared strings should be used */
42		protected $shouldUseInlineStrings;
43
44		/** @var RowManager Manages rows */
45		private $rowManager;
46
47		/** @var StyleManager Manages styles */
48		private $styleManager;
49
50		/** @var StyleMerger Helper to merge styles together */
51		private $styleMerger;
52
53		/** @var SharedStringsManager Helper to write shared strings */
54		private $sharedStringsManager;
55
56		/** @var XLSXEscaper Strings escaper */
57		private $stringsEscaper;
58
59		/** @var StringHelper String helper */
60		private $stringHelper;
61
62		/** @var InternalEntityFactory Factory to create entities */
63		private $entityFactory;
64
65		/**
66		* WorksheetManager constructor.
67		*
68		* @param OptionsManagerInterface $optionsManager
69		* @param RowManager $rowManager
70		* @param StyleManager $styleManager
71		* @param StyleMerger $styleMerger
72		* @param SharedStringsManager $sharedStringsManager
73		* @param XLSXEscaper $stringsEscaper
74		* @param StringHelper $stringHelper
75		* @param InternalEntityFactory $entityFactory
76		*/
77	42	public function __construct(
78		OptionsManagerInterface $optionsManager,
79		RowManager $rowManager,
80		StyleManager $styleManager,
81		StyleMerger $styleMerger,
82		SharedStringsManager $sharedStringsManager,
83		XLSXEscaper $stringsEscaper,
84		StringHelper $stringHelper,
85		InternalEntityFactory $entityFactory
86		) {
87	42	$this->shouldUseInlineStrings = $optionsManager->getOption(Options::SHOULD_USE_INLINE_STRINGS);
88	42	$this->rowManager = $rowManager;
89	42	$this->styleManager = $styleManager;
90	42	$this->styleMerger = $styleMerger;
91	42	$this->sharedStringsManager = $sharedStringsManager;
92	42	$this->stringsEscaper = $stringsEscaper;
93	42	$this->stringHelper = $stringHelper;
94	42	$this->entityFactory = $entityFactory;
95	42	}
96
97		/**
98		* @return SharedStringsManager
99		*/
100	38	public function getSharedStringsManager()
101		{
102	38	return $this->sharedStringsManager;
103		}
104
105		/**
106		* {@inheritdoc}
107		*/
108	42	public function startSheet(Worksheet $worksheet)
109		{
110	42	$sheetFilePointer = \fopen($worksheet->getFilePath(), 'w');
111	42	$this->throwIfSheetFilePointerIsNotAvailable($sheetFilePointer);
112
113	42	$worksheet->setFilePointer($sheetFilePointer);
114
115	42	\fwrite($sheetFilePointer, self::SHEET_XML_FILE_HEADER);
116	42	\fwrite($sheetFilePointer, '<sheetData>');
117	42	}
118
119		/**
120		* Checks if the sheet has been sucessfully created. Throws an exception if not.
121		*
122		* @param bool\|resource $sheetFilePointer Pointer to the sheet data file or FALSE if unable to open the file
123		* @throws IOException If the sheet data file cannot be opened for writing
124		* @return void
125		*/
126	42	private function throwIfSheetFilePointerIsNotAvailable($sheetFilePointer)
127		{
128	42	if (!$sheetFilePointer) {
129		throw new IOException('Unable to open sheet for writing.');
130		}
131	42	}
132
133		/**
134		* {@inheritdoc}
135		*/
136	35	public function addRow(Worksheet $worksheet, Row $row)
137		{
138	35	if (!$this->rowManager->isEmpty($row)) {
139	35	$this->addNonEmptyRow($worksheet, $row);
140		}
141
142	34	$worksheet->setLastWrittenRowIndex($worksheet->getLastWrittenRowIndex() + 1);
143	34	}
144
145		/**
146		* Adds non empty row to the worksheet.
147		*
148		* @param Worksheet $worksheet The worksheet to add the row to
149		* @param Row $row The row to be written
150		* @throws IOException If the data cannot be written
151		* @throws InvalidArgumentException If a cell value's type is not supported
152		* @return void
153		*/
154	35	private function addNonEmptyRow(Worksheet $worksheet, Row $row)
155		{
156	35	$rowStyle = $row->getStyle();
157	35	$rowIndexOneBased = $worksheet->getLastWrittenRowIndex() + 1;
158	35	$numCells = $row->getNumCells();
159
160	35	$rowXML = '<row r="' . $rowIndexOneBased . '" spans="1:' . $numCells . '">';
161
162	35	foreach ($row->getCells() as $columnIndexZeroBased => $cell) {
163	35	$rowXML .= $this->applyStyleAndGetCellXML($cell, $rowStyle, $rowIndexOneBased, $columnIndexZeroBased);
164		}
165
166	34	$rowXML .= '</row>';
167
168	34	$wasWriteSuccessful = \fwrite($worksheet->getFilePointer(), $rowXML);
169	34	if ($wasWriteSuccessful === false) {
170		throw new IOException("Unable to write data in {$worksheet->getFilePath()}");
171		}
172	34	}
173
174		/**
175		* Applies styles to the given style, merging the cell's style with its row's style
176		* Then builds and returns xml for the cell.
177		*
178		* @param Cell $cell
179		* @param Style $rowStyle
180		* @param int $rowIndexOneBased
181		* @param int $columnIndexZeroBased
182		*
183		* @throws InvalidArgumentException If the given value cannot be processed
184		* @return string
185		*/
186	35	private function applyStyleAndGetCellXML(Cell $cell, Style $rowStyle, $rowIndexOneBased, $columnIndexZeroBased)
187		{
188		// Apply row and extra styles
189	35	$mergedCellAndRowStyle = $this->styleMerger->merge($cell->getStyle(), $rowStyle);
190	35	$cell->setStyle($mergedCellAndRowStyle);
191	35	$newCellStyle = $this->styleManager->applyExtraStylesIfNeeded($cell);
192
193	35	$registeredStyle = $this->styleManager->registerStyle($newCellStyle);
194
195	35	return $this->getCellXML($rowIndexOneBased, $columnIndexZeroBased, $cell, $registeredStyle->getId());
196		}
197
198		/**
199		* Builds and returns xml for a single cell.
200		*
201		* @param int $rowIndexOneBased
202		* @param int $columnIndexZeroBased
203		* @param Cell $cell
204		* @param int $styleId
205		*
206		* @throws InvalidArgumentException If the given value cannot be processed
207		* @return string
208		*/
209	35	private function getCellXML($rowIndexOneBased, $columnIndexZeroBased, Cell $cell, $styleId)
210		{
211	35	$columnLetters = CellHelper::getColumnLettersFromColumnIndex($columnIndexZeroBased);
212	35	$cellXML = '<c r="' . $columnLetters . $rowIndexOneBased . '"';
213	35	$cellXML .= ' s="' . $styleId . '"';
214
215	35	if ($cell->isString()) {
216	32	$cellXML .= $this->getCellXMLFragmentForNonEmptyString($cell->getValue());
217	6	} elseif ($cell->isBoolean()) {
218	1	$cellXML .= ' t="b"><v>' . (int) ($cell->getValue()) . '</v></c>';
219	6	} elseif ($cell->isNumeric()) {
220	2	$cellXML .= '><v>' . $cell->getValue() . '</v></c>';
221	5	} elseif ($cell->isError() && is_string($cell->getValueEvenIfError())) {
222		// only writes the error value if it's a string
223	1	$cellXML .= ' t="e"><v>' . $cell->getValueEvenIfError() . '</v></c>';
224	4	} elseif ($cell->isEmpty()) {
225	2	if ($this->styleManager->shouldApplyStyleOnEmptyCell($styleId)) {
226	1	$cellXML .= '/>';
227		} else {
228		// don't write empty cells that do no need styling
229		// NOTE: not appending to $cellXML is the right behavior!!
230	2	$cellXML = '';
231		}
232		} else {
233	2	throw new InvalidArgumentException('Trying to add a value with an unsupported type: ' . \gettype($cell->getValue()));
234		}
235
236	34	return $cellXML;
237		}
238
239		/**
240		* Returns the XML fragment for a cell containing a non empty string
241		*
242		* @param string $cellValue The cell value
243		* @throws InvalidArgumentException If the string exceeds the maximum number of characters allowed per cell
244		* @return string The XML fragment representing the cell
245		*/
246	32	private function getCellXMLFragmentForNonEmptyString($cellValue)
247		{
248	32	if ($this->stringHelper->getStringLength($cellValue) > self::MAX_CHARACTERS_PER_CELL) {
249		throw new InvalidArgumentException('Trying to add a value that exceeds the maximum number of characters allowed in a cell (32,767)');
250		}
251
252	32	if ($this->shouldUseInlineStrings) {
253	29	$cellXMLFragment = ' t="inlineStr"><is><t>' . $this->stringsEscaper->escape($cellValue) . '</t></is></c>';
254		} else {
255	3	$sharedStringId = $this->sharedStringsManager->writeString($cellValue);
256	3	$cellXMLFragment = ' t="s"><v>' . $sharedStringId . '</v></c>';
257		}
258
259	32	return $cellXMLFragment;
260		}
261
262		/**
263		* {@inheritdoc}
264		*/
265	38	public function close(Worksheet $worksheet)
266		{
267	38	$worksheetFilePointer = $worksheet->getFilePointer();
268
269	38	if (!\is_resource($worksheetFilePointer)) {
270		return;
271		}
272
273	38	\fwrite($worksheetFilePointer, '</sheetData>');
274	38	\fwrite($worksheetFilePointer, '</worksheet>');
275	38	\fclose($worksheetFilePointer);
276	38	}
277		}
278

box / spout

Push — master ( eb88bb...7964da )

WorksheetManager::addNonEmptyRow() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like