Worksheet::getExternalSheet() - Code Metrics - Inspection of "Empty rows do not need to be written for XLSX file..." - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#336)

by Adrien

created 2016-10-17 18:28 UTC

Worksheet::getExternalSheet() A

↳ Parent: Worksheet

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php

namespace Box\Spout\Writer\XLSX\Internal;

use Box\Spout\Common\Exception\InvalidArgumentException;
use Box\Spout\Common\Exception\IOException;
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
{
    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 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->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);
        return ($numCells === 1 && CellHelper::isEmpty($dataRow[0]));
    }

    /**
     * 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
     */
    private function getCellXML($rowIndex, $cellNumber, $cellValue, $styleId)
    {
        $columnIndex = CellHelper::getCellIndexFromColumnIndex($cellNumber);
        $cellXML = '<c r="' . $columnIndex . $rowIndex . '"';
        $cellXML .= ' s="' . $styleId . '"';

        if (CellHelper::isNonEmptyString($cellValue)) {
            if ($this->shouldUseInlineStrings) {
                $cellXML .= ' t="inlineStr"><is><t>' . $this->stringsEscaper->escape($cellValue) . '</t></is></c>';
            } else {
                $sharedStringId = $this->sharedStringsHelper->writeString($cellValue);
                $cellXML .= ' t="s"><v>' . $sharedStringId . '</v></c>';
            }
        } else if (CellHelper::isBoolean($cellValue)) {
            $cellXML .= ' t="b"><v>' . intval($cellValue) . '</v></c>';
        } else if (CellHelper::isNumeric($cellValue)) {
            $cellXML .= '><v>' . $cellValue . '</v></c>';
        } else if (empty($cellValue)) {
            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($cellValue));
        }

        return $cellXML;
    }

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

box / spout

Pull Request — master (#336)

Worksheet::getExternalSheet() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like