Worksheet::isEmptyRow() - Code Metrics - Inspection of "Cell value objects" - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#383)

by Hura

created 2017-04-29 07:39 UTC

Worksheet::isEmptyRow() A

↳ Parent: Worksheet

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	3
cts	3
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	3
nc	2
nop	1
crap	2

<?php

namespace Box\Spout\Writer\XLSX\Internal;

use Box\Spout\Common\Exception\InvalidArgumentException;
use Box\Spout\Common\Exception\IOException;
use Box\Spout\Common\Helper\StringHelper;
use Box\Spout\Writer\Common\Cell;
use Box\Spout\Writer\Common\Helper\CellHelper;
use Box\Spout\Writer\Common\Internal\WorksheetInterface;

/**
 * Class Worksheet
 * Represents a worksheet within a XLSX file. The difference with the Sheet object is
 * that this class provides an interface to write data
 *
 * @package Box\Spout\Writer\XLSX\Internal
 */
class Worksheet implements WorksheetInterface
{
    /**
     * 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 \Box\Spout\Writer\Common\Sheet The "external" sheet */
    protected $externalSheet;

    /** @var string Path to the XML file that will contain the sheet data */
    protected $worksheetFilePath;

    /** @var \Box\Spout\Writer\XLSX\Helper\SharedStringsHelper Helper to write shared strings */
    protected $sharedStringsHelper;

    /** @var \Box\Spout\Writer\XLSX\Helper\StyleHelper Helper to work with styles */
    protected $styleHelper;

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

    /** @var \Box\Spout\Common\Escaper\XLSX Strings escaper */
    protected $stringsEscaper;

    /** @var \Box\Spout\Common\Helper\StringHelper String helper */
    protected $stringHelper;

    /** @var Resource Pointer to the sheet data file (e.g. xl/worksheets/sheet1.xml) */
    protected $sheetFilePointer;

    /** @var int Index of the last written row */
    protected $lastWrittenRowIndex = 0;

    /**
     * @param \Box\Spout\Writer\Common\Sheet $externalSheet The associated "external" sheet
     * @param string $worksheetFilesFolder Temporary folder where the files to create the XLSX will be stored
     * @param \Box\Spout\Writer\XLSX\Helper\SharedStringsHelper $sharedStringsHelper Helper for shared strings
     * @param \Box\Spout\Writer\XLSX\Helper\StyleHelper Helper to work with styles
     * @param bool $shouldUseInlineStrings Whether inline or shared strings should be used
     * @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
     */
    public function __construct($externalSheet, $worksheetFilesFolder, $sharedStringsHelper, $styleHelper, $shouldUseInlineStrings)
    {
        $this->externalSheet = $externalSheet;
        $this->sharedStringsHelper = $sharedStringsHelper;
        $this->styleHelper = $styleHelper;
        $this->shouldUseInlineStrings = $shouldUseInlineStrings;

        /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
        $this->stringsEscaper = \Box\Spout\Common\Escaper\XLSX::getInstance();
        $this->stringHelper = new StringHelper();

        $this->worksheetFilePath = $worksheetFilesFolder . '/' . strtolower($this->externalSheet->getName()) . '.xml';
        $this->startSheet();
    }

    /**
     * Prepares the worksheet to accept data
     *
     * @return void
     * @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
     */
    protected function startSheet()
    {
        $this->sheetFilePointer = fopen($this->worksheetFilePath, 'w');
        $this->throwIfSheetFilePointerIsNotAvailable();

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

    /**
     * Checks if the book has been created. Throws an exception if not created yet.
     *
     * @return void
     * @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
     */
    protected function throwIfSheetFilePointerIsNotAvailable()
    {
        if (!$this->sheetFilePointer) {
            throw new IOException('Unable to open sheet for writing.');
        }
    }

    /**
     * @return \Box\Spout\Writer\Common\Sheet The "external" sheet
     */
    public function getExternalSheet()
    {
        return $this->externalSheet;
    }

    /**
     * @return int The index of the last written row
     */
    public function getLastWrittenRowIndex()
    {
        return $this->lastWrittenRowIndex;
    }

    /**
     * @return int The ID of the worksheet
     */
    public function getId()
    {
        // sheet index is zero-based, while ID is 1-based
        return $this->externalSheet->getIndex() + 1;
    }

    /**
     * Adds data to the worksheet.
     *
     * @param array $dataRow Array containing data to be written. Cannot be empty.
     *          Example $dataRow = ['data1', 1234, null, '', 'data5'];
     * @param \Box\Spout\Writer\Style\Style $style Style to be applied to the row. NULL means use default style.
     * @return void
     * @throws \Box\Spout\Common\Exception\IOException If the data cannot be written
     * @throws \Box\Spout\Common\Exception\InvalidArgumentException If a cell value's type is not supported
     */
    public function addRow($dataRow, $style)
    {
        if (!$this->isEmptyRow($dataRow)) {
            $this->addNonEmptyRow($dataRow, $style);
        }

        $this->lastWrittenRowIndex++;
    }

    /**
     * Returns whether the given row is empty
     *
     * @param array $dataRow Array containing data to be written. Cannot be empty.
     *          Example $dataRow = ['data1', 1234, null, '', 'data5'];
     * @return bool Whether the given row is empty
     */
    private function isEmptyRow($dataRow)
    {
        $numCells = count($dataRow);
        // using "reset()" instead of "$dataRow[0]" because $dataRow can be an associative array
        return ($numCells === 1 && CellHelper::isEmpty(reset($dataRow)));
    }

    /**
     * Adds non empty row to the worksheet.
     *
     * @param array $dataRow Array containing data to be written. Cannot be empty.
     *          Example $dataRow = ['data1', 1234, null, '', 'data5'];
     * @param \Box\Spout\Writer\Style\Style $style Style to be applied to the row. NULL means use default style.
     * @return void
     * @throws \Box\Spout\Common\Exception\IOException If the data cannot be written
     * @throws \Box\Spout\Common\Exception\InvalidArgumentException If a cell value's type is not supported
     */
    private function addNonEmptyRow($dataRow, $style)
    {
        $cellNumber = 0;
        $rowIndex = $this->lastWrittenRowIndex + 1;
        $numCells = count($dataRow);

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

        foreach($dataRow as $cellValue) {
            $rowXML .= $this->getCellXML($rowIndex, $cellNumber, $cellValue, $style->getId());
            $cellNumber++;
        }

        $rowXML .= '</row>';

        $wasWriteSuccessful = fwrite($this->sheetFilePointer, $rowXML);
        if ($wasWriteSuccessful === false) {
            throw new IOException("Unable to write data in {$this->worksheetFilePath}");
        }
    }

    /**
     * Build and return xml for a single cell.
     *
     * @param int $rowIndex
     * @param int $cellNumber
     * @param mixed $cellValue
     * @param int $styleId
     * @return string
     * @throws InvalidArgumentException If the given value cannot be processed
     */
    private function getCellXML($rowIndex, $cellNumber, $cellValue, $styleId)
    {
        $columnIndex = CellHelper::getCellIndexFromColumnIndex($cellNumber);
        $cellXML = '<c r="' . $columnIndex . $rowIndex . '"';
        $cellXML .= ' s="' . $styleId . '"';

        /** @TODO Remove code duplication with ODS writer: https://github.com/box/spout/pull/383#discussion_r113292746 */
        if ($cellValue instanceof Cell) {
            $cell = $cellValue;
        } else {
            $cell = new Cell($cellValue);
        }

        if ($cell->isString()) {
            $cellXML .= $this->getCellXMLFragmentForNonEmptyString($cell->getValue());
        } else if ($cell->isBoolean()) {
            $cellXML .= ' t="b"><v>' . intval($cell->getValue()) . '</v></c>';
        } else if ($cell->isNumeric()) {
            $cellXML .= '><v>' . $cell->getValue() . '</v></c>';
        } else if ($cell->isEmpty()) {
            if ($this->styleHelper->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
     * @return string The XML fragment representing the cell
     * @throws InvalidArgumentException If the string exceeds the maximum number of characters allowed per 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->sharedStringsHelper->writeString($cellValue);
            $cellXMLFragment = ' t="s"><v>' . $sharedStringId . '</v></c>';
        }

        return $cellXMLFragment;
    }

    /**
     * Closes the worksheet
     *
     * @return void
     */
    public function close()
    {
        if (!is_resource($this->sheetFilePointer)) {
            return;
        }

        fwrite($this->sheetFilePointer, '</sheetData>');
        fwrite($this->sheetFilePointer, '</worksheet>');
        fclose($this->sheetFilePointer);
    }
}


1		<?php
2
3		namespace Box\Spout\Writer\XLSX\Internal;
4
5		use Box\Spout\Common\Exception\InvalidArgumentException;
6		use Box\Spout\Common\Exception\IOException;
7		use Box\Spout\Common\Helper\StringHelper;
8		use Box\Spout\Writer\Common\Cell;
9		use Box\Spout\Writer\Common\Helper\CellHelper;
10		use Box\Spout\Writer\Common\Internal\WorksheetInterface;
11
12		/**
13		* Class Worksheet
14		* Represents a worksheet within a XLSX file. The difference with the Sheet object is
15		* that this class provides an interface to write data
16		*
17		* @package Box\Spout\Writer\XLSX\Internal
18		*/
19		class Worksheet implements WorksheetInterface
20		{
21		/**
22		* Maximum number of characters a cell can contain
23		* @see https://support.office.com/en-us/article/Excel-specifications-and-limits-16c69c74-3d6a-4aaf-ba35-e6eb276e8eaa [Excel 2007]
24		* @see https://support.office.com/en-us/article/Excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3 [Excel 2010]
25		* @see https://support.office.com/en-us/article/Excel-specifications-and-limits-ca36e2dc-1f09-4620-b726-67c00b05040f [Excel 2013/2016]
26		*/
27		const MAX_CHARACTERS_PER_CELL = 32767;
28
29		const SHEET_XML_FILE_HEADER = <<<EOD
30		<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
31		<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">
32		EOD;
33
34		/** @var \Box\Spout\Writer\Common\Sheet The "external" sheet */
35		protected $externalSheet;
36
37		/** @var string Path to the XML file that will contain the sheet data */
38		protected $worksheetFilePath;
39
40		/** @var \Box\Spout\Writer\XLSX\Helper\SharedStringsHelper Helper to write shared strings */
41		protected $sharedStringsHelper;
42
43		/** @var \Box\Spout\Writer\XLSX\Helper\StyleHelper Helper to work with styles */
44		protected $styleHelper;
45
46		/** @var bool Whether inline or shared strings should be used */
47		protected $shouldUseInlineStrings;
48
49		/** @var \Box\Spout\Common\Escaper\XLSX Strings escaper */
50		protected $stringsEscaper;
51
52		/** @var \Box\Spout\Common\Helper\StringHelper String helper */
53		protected $stringHelper;
54
55		/** @var Resource Pointer to the sheet data file (e.g. xl/worksheets/sheet1.xml) */
56		protected $sheetFilePointer;
57
58		/** @var int Index of the last written row */
59		protected $lastWrittenRowIndex = 0;
60
61		/**
62		* @param \Box\Spout\Writer\Common\Sheet $externalSheet The associated "external" sheet
63		* @param string $worksheetFilesFolder Temporary folder where the files to create the XLSX will be stored
64		* @param \Box\Spout\Writer\XLSX\Helper\SharedStringsHelper $sharedStringsHelper Helper for shared strings
65		* @param \Box\Spout\Writer\XLSX\Helper\StyleHelper Helper to work with styles
66		* @param bool $shouldUseInlineStrings Whether inline or shared strings should be used
67		* @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
68		*/
69	138	public function __construct($externalSheet, $worksheetFilesFolder, $sharedStringsHelper, $styleHelper, $shouldUseInlineStrings)
70		{
71	138	$this->externalSheet = $externalSheet;
72	138	$this->sharedStringsHelper = $sharedStringsHelper;
73	138	$this->styleHelper = $styleHelper;
74	138	$this->shouldUseInlineStrings = $shouldUseInlineStrings;
75
76		/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
77	138	$this->stringsEscaper = \Box\Spout\Common\Escaper\XLSX::getInstance();
78	138	$this->stringHelper = new StringHelper();
79
80	138	$this->worksheetFilePath = $worksheetFilesFolder . '/' . strtolower($this->externalSheet->getName()) . '.xml';
81	138	$this->startSheet();
82	138	}
83
84		/**
85		* Prepares the worksheet to accept data
86		*
87		* @return void
88		* @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
89		*/
90	138	protected function startSheet()
91		{
92	138	$this->sheetFilePointer = fopen($this->worksheetFilePath, 'w');
93	138	$this->throwIfSheetFilePointerIsNotAvailable();
94
95	138	fwrite($this->sheetFilePointer, self::SHEET_XML_FILE_HEADER);
96	138	fwrite($this->sheetFilePointer, '<sheetData>');
97	138	}
98
99		/**
100		* Checks if the book has been created. Throws an exception if not created yet.
101		*
102		* @return void
103		* @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
104		*/
105	138	protected function throwIfSheetFilePointerIsNotAvailable()
106		{
107	138	if (!$this->sheetFilePointer) {
108		throw new IOException('Unable to open sheet for writing.');
109		}
110	138	}
111
112		/**
113		* @return \Box\Spout\Writer\Common\Sheet The "external" sheet
114		*/
115	111	public function getExternalSheet()
116		{
117	111	return $this->externalSheet;
118		}
119
120		/**
121		* @return int The index of the last written row
122		*/
123	99	public function getLastWrittenRowIndex()
124		{
125	99	return $this->lastWrittenRowIndex;
126		}
127
128		/**
129		* @return int The ID of the worksheet
130		*/
131	108	public function getId()
132		{
133		// sheet index is zero-based, while ID is 1-based
134	108	return $this->externalSheet->getIndex() + 1;
135		}
136
137		/**
138		* Adds data to the worksheet.
139		*
140		* @param array $dataRow Array containing data to be written. Cannot be empty.
141		* Example $dataRow = ['data1', 1234, null, '', 'data5'];
142		* @param \Box\Spout\Writer\Style\Style $style Style to be applied to the row. NULL means use default style.
143		* @return void
144		* @throws \Box\Spout\Common\Exception\IOException If the data cannot be written
145		* @throws \Box\Spout\Common\Exception\InvalidArgumentException If a cell value's type is not supported
146		*/
147	99	public function addRow($dataRow, $style)
148		{
149	99	if (!$this->isEmptyRow($dataRow)) {
150	99	$this->addNonEmptyRow($dataRow, $style);
151	93	}
152
153	93	$this->lastWrittenRowIndex++;
154	93	}
155
156		/**
157		* Returns whether the given row is empty
158		*
159		* @param array $dataRow Array containing data to be written. Cannot be empty.
160		* Example $dataRow = ['data1', 1234, null, '', 'data5'];
161		* @return bool Whether the given row is empty
162		*/
163	99	private function isEmptyRow($dataRow)
164		{
165	99	$numCells = count($dataRow);
166		// using "reset()" instead of "$dataRow[0]" because $dataRow can be an associative array
167	99	return ($numCells === 1 && CellHelper::isEmpty(reset($dataRow)));
168		}
169
170		/**
171		* Adds non empty row to the worksheet.
172		*
173		* @param array $dataRow Array containing data to be written. Cannot be empty.
174		* Example $dataRow = ['data1', 1234, null, '', 'data5'];
175		* @param \Box\Spout\Writer\Style\Style $style Style to be applied to the row. NULL means use default style.
176		* @return void
177		* @throws \Box\Spout\Common\Exception\IOException If the data cannot be written
178		* @throws \Box\Spout\Common\Exception\InvalidArgumentException If a cell value's type is not supported
179		*/
180	99	private function addNonEmptyRow($dataRow, $style)
181		{
182	99	$cellNumber = 0;
183	99	$rowIndex = $this->lastWrittenRowIndex + 1;
184	99	$numCells = count($dataRow);
185
186	99	$rowXML = '<row r="' . $rowIndex . '" spans="1:' . $numCells . '">';
187
188	99	foreach($dataRow as $cellValue) {
189	99	$rowXML .= $this->getCellXML($rowIndex, $cellNumber, $cellValue, $style->getId());
190	93	$cellNumber++;
191	93	}
192
193	93	$rowXML .= '</row>';
194
195	93	$wasWriteSuccessful = fwrite($this->sheetFilePointer, $rowXML);
196	93	if ($wasWriteSuccessful === false) {
197		throw new IOException("Unable to write data in {$this->worksheetFilePath}");
198		}
199	93	}
200
201		/**
202		* Build and return xml for a single cell.
203		*
204		* @param int $rowIndex
205		* @param int $cellNumber
206		* @param mixed $cellValue
207		* @param int $styleId
208		* @return string
209		* @throws InvalidArgumentException If the given value cannot be processed
210		*/
211	99	private function getCellXML($rowIndex, $cellNumber, $cellValue, $styleId)
212		{
213	99	$columnIndex = CellHelper::getCellIndexFromColumnIndex($cellNumber);
214	99	$cellXML = '<c r="' . $columnIndex . $rowIndex . '"';
215	99	$cellXML .= ' s="' . $styleId . '"';
216
217		/** @TODO Remove code duplication with ODS writer: https://github.com/box/spout/pull/383#discussion_r113292746 */
218	99	if ($cellValue instanceof Cell) {
219	6	$cell = $cellValue;
220	6	} else {
221	93	$cell = new Cell($cellValue);
222		}
223
224	99	if ($cell->isString()) {
225	96	$cellXML .= $this->getCellXMLFragmentForNonEmptyString($cell->getValue());
226	96	} else if ($cell->isBoolean()) {
227	6	$cellXML .= ' t="b"><v>' . intval($cell->getValue()) . '</v></c>';
228	15	} else if ($cell->isNumeric()) {
229	6	$cellXML .= '><v>' . $cell->getValue() . '</v></c>';
230	15	} else if ($cell->isEmpty()) {
231	6	if ($this->styleHelper->shouldApplyStyleOnEmptyCell($styleId)) {
232	3	$cellXML .= '/>';
233	3	} else {
234		// don't write empty cells that do no need styling
235		// NOTE: not appending to $cellXML is the right behavior!!
236	6	$cellXML = '';
237		}
238	6	} else {
239	6	throw new InvalidArgumentException('Trying to add a value with an unsupported type: ' . gettype($cell->getValue()));
240		}
241
242	93	return $cellXML;
243		}
244
245		/**
246		* Returns the XML fragment for a cell containing a non empty string
247		*
248		* @param string $cellValue The cell value
249		* @return string The XML fragment representing the cell
250		* @throws InvalidArgumentException If the string exceeds the maximum number of characters allowed per cell
251		*/
252	96	private function getCellXMLFragmentForNonEmptyString($cellValue)
253		{
254	96	if ($this->stringHelper->getStringLength($cellValue) > self::MAX_CHARACTERS_PER_CELL) {
255	3	throw new InvalidArgumentException('Trying to add a value that exceeds the maximum number of characters allowed in a cell (32,767)');
256		}
257
258	93	if ($this->shouldUseInlineStrings) {
259	78	$cellXMLFragment = ' t="inlineStr"><is><t>' . $this->stringsEscaper->escape($cellValue) . '</t></is></c>';
260	78	} else {
261	15	$sharedStringId = $this->sharedStringsHelper->writeString($cellValue);
262	15	$cellXMLFragment = ' t="s"><v>' . $sharedStringId . '</v></c>';
263		}
264
265	93	return $cellXMLFragment;
266		}
267
268		/**
269		* Closes the worksheet
270		*
271		* @return void
272		*/
273	108	public function close()
274		{
275	108	if (!is_resource($this->sheetFilePointer)) {
276		return;
277		}
278
279	108	fwrite($this->sheetFilePointer, '</sheetData>');
280	108	fwrite($this->sheetFilePointer, '</worksheet>');
281	108	fclose($this->sheetFilePointer);
282	108	}
283		}
284

box / spout

Pull Request — master (#383)

Worksheet::isEmptyRow() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like