WorksheetManager::throwIfSheetFilePointerIsNotAvailable() - Code Metrics - Inspection of "Row objects and Cell styling - v2" - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — develop_3.0 (#485)

by Adrien

created 2017-11-05 00:42 UTC

throwIfSheetFilePointerIsNotAvailable() A

↳ Parent: WorksheetManager

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2.0625

Importance

Changes

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

<?php

namespace Box\Spout\Writer\XLSX\Manager;

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\EntityFactory;
use Box\Spout\Writer\Common\Entity\Cell;
use Box\Spout\Writer\Common\Entity\Options;
use Box\Spout\Writer\Common\Entity\Row;
use Box\Spout\Writer\Common\Entity\Style\Style;
use Box\Spout\Writer\Common\Entity\Worksheet;
use Box\Spout\Writer\Common\Helper\CellHelper;
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 StyleManager Manages styles */
    private $styleManager;

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

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

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

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

    /**
     * WorksheetManager constructor.
     *
     * @param OptionsManagerInterface $optionsManager
     * @param StyleManager $styleManager
     * @param SharedStringsManager $sharedStringsManager
     * @param XLSXEscaper $stringsEscaper
     * @param StringHelper $stringHelper
     * @param EntityFactory $entityFactory
     */
    public function __construct(
        OptionsManagerInterface $optionsManager,
        StyleManager $styleManager,
        SharedStringsManager $sharedStringsManager,
        XLSXEscaper $stringsEscaper,
        StringHelper $stringHelper,
        EntityFactory $entityFactory
    ) {
        $this->shouldUseInlineStrings = $optionsManager->getOption(Options::SHOULD_USE_INLINE_STRINGS);
        $this->styleManager = $styleManager;
        $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 (!$row->isEmpty()) {
            $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)
    {
        $cellIndex = 0;
        $rowStyle = $row->getStyle();
        $rowIndex = $worksheet->getLastWrittenRowIndex() + 1;
        $numCells = count($row->getCells());

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

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

        $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 $rowIndex
     * @param int $cellIndex
     * @throws InvalidArgumentException If the given value cannot be processed
     * @return string
     */
    private function applyStyleAndGetCellXML(Cell $cell, Style $rowStyle, $rowIndex, $cellIndex)
    {
        // Apply styles - the row style is merged at this point
        $cell->applyStyle($rowStyle);
        $this->styleManager->applyExtraStylesIfNeeded($cell);
        $registeredStyle = $this->styleManager->registerStyle($cell->getStyle());

        return $this->getCellXML($rowIndex, $cellIndex, $cell, $registeredStyle->getId());
    }

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

box / spout

Pull Request — develop_3.0 (#485)

throwIfSheetFilePointerIsNotAvailable() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like