WorksheetManager::ensureSheetDataStated() - Code Metrics - Inspection of "Custom column widths" - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#808)

unknown

created 2021-05-05 22:21 UTC

WorksheetManager::ensureSheetDataStated() A

↳ Parent: WorksheetManager

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

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

<?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\RegisteredStyle;
use Box\Spout\Writer\Common\Manager\ManagesCellSize;
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
{
    use ManagesCellSize;

    /**
     * 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->setDefaultColumnWidth($optionsManager->getOption(Options::DEFAULT_COLUMN_WIDTH));
        $this->setDefaultRowHeight($optionsManager->getOption(Options::DEFAULT_ROW_HEIGHT));
        $this->columnWidths = $optionsManager->getOption(Options::COLUMN_WIDTHS) ?? [];

        $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);
    }

    /**
     * Writes the sheet data header
     *
     * @param Worksheet $worksheet The worksheet to add the row to
     * @return void
     */
    private function ensureSheetDataStated(Worksheet $worksheet)
    {
        if (!$worksheet->getSheetDataStarted()) {
            $worksheetFilePointer = $worksheet->getFilePointer();
            \fwrite($worksheetFilePointer, $this->getXMLFragmentForDefaultCellSizing());
            \fwrite($worksheetFilePointer, $this->getXMLFragmentForColumnWidths());
            \fwrite($worksheetFilePointer, '<sheetData>');
            $worksheet->setSheetDataStarted(true);
        }
    }

    /**
     * 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 InvalidArgumentException If a cell value's type is not supported
     * @throws IOException If the data cannot be written
     * @return void
     */
    private function addNonEmptyRow(Worksheet $worksheet, Row $row)
    {
        $this->ensureSheetDataStated($worksheet);
        $sheetFilePointer = $worksheet->getFilePointer();
        $rowStyle = $row->getStyle();
        $rowIndexOneBased = $worksheet->getLastWrittenRowIndex() + 1;
        $numCells = $row->getNumCells();

        $hasCustomHeight = $this->defaultRowHeight > 0 ? '1' : '0';
        $rowXML = "<row r=\"{$rowIndexOneBased}\" spans=\"1:{$numCells}\" customHeight=\"{$hasCustomHeight}\">";

        foreach ($row->getCells() as $columnIndexZeroBased => $cell) {
            $registeredStyle = $this->applyStyleAndRegister($cell, $rowStyle);
            $cellStyle = $registeredStyle->getStyle();
            if ($registeredStyle->isMatchingRowStyle()) {
                $rowStyle = $cellStyle; // Replace actual rowStyle (possibly with null id) by registered style (with id)
            }
            $rowXML .= $this->getCellXML($rowIndexOneBased, $columnIndexZeroBased, $cell, $cellStyle->getId());
        }

        $rowXML .= '</row>';

        $wasWriteSuccessful = \fwrite($sheetFilePointer, $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
     *
     * @param Cell $cell
     * @param Style $rowStyle
     *
     * @throws InvalidArgumentException If the given value cannot be processed
     * @return RegisteredStyle
     */
    private function applyStyleAndRegister(Cell $cell, Style $rowStyle) : RegisteredStyle
    {
        $isMatchingRowStyle = false;
        if ($cell->getStyle()->isEmpty()) {
            $cell->setStyle($rowStyle);

            $possiblyUpdatedStyle = $this->styleManager->applyExtraStylesIfNeeded($cell);

            if ($possiblyUpdatedStyle->isUpdated()) {
                $registeredStyle = $this->styleManager->registerStyle($possiblyUpdatedStyle->getStyle());
            } else {
                $registeredStyle = $this->styleManager->registerStyle($rowStyle);
                $isMatchingRowStyle = true;
            }
        } else {
            $mergedCellAndRowStyle = $this->styleMerger->merge($cell->getStyle(), $rowStyle);
            $cell->setStyle($mergedCellAndRowStyle);

            $possiblyUpdatedStyle = $this->styleManager->applyExtraStylesIfNeeded($cell);

            if ($possiblyUpdatedStyle->isUpdated()) {
                $newCellStyle = $possiblyUpdatedStyle->getStyle();
            } else {
                $newCellStyle = $mergedCellAndRowStyle;
            }

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

        return new RegisteredStyle($registeredStyle, $isMatchingRowStyle);
    }

    /**
     * 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>' . $this->stringHelper->formatNumericValue($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;
    }

    /**
     * Construct column width references xml to inject into worksheet xml file
     *
     * @return string
     */
    public function getXMLFragmentForColumnWidths()
    {
        if (empty($this->columnWidths)) {
            return '';
        }
        $xml = '<cols>';
        foreach ($this->columnWidths as $entry) {
            $xml .= '<col min="' . $entry[0] . '" max="' . $entry[1] . '" width="' . $entry[2] . '" customWidth="true"/>';
        }
        $xml .= '</cols>';

        return $xml;
    }

    /**
     * Constructs default row height and width xml to inject into worksheet xml file
     *
     * @return string
     */
    public function getXMLFragmentForDefaultCellSizing()
    {
        $rowHeightXml = empty($this->defaultRowHeight) ? '' : " defaultRowHeight=\"{$this->defaultRowHeight}\"";
        $colWidthXml = empty($this->defaultColumnWidth) ? '' : " defaultColWidth=\"{$this->defaultColumnWidth}\"";
        if (empty($colWidthXml) && empty($rowHeightXml)) {
            return '';
        }
        // Ensure that the required defaultRowHeight is set
        $rowHeightXml = empty($rowHeightXml) ? ' defaultRowHeight="0"' : $rowHeightXml;

        return "<sheetFormatPr{$colWidthXml}{$rowHeightXml}/>";
    }

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

        if (!\is_resource($worksheetFilePointer)) {
            return;
        }
        $this->ensureSheetDataStated($worksheet);
        \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\RegisteredStyle;
18		use Box\Spout\Writer\Common\Manager\ManagesCellSize;
19		use Box\Spout\Writer\Common\Manager\RowManager;
20		use Box\Spout\Writer\Common\Manager\Style\StyleMerger;
21		use Box\Spout\Writer\Common\Manager\WorksheetManagerInterface;
22		use Box\Spout\Writer\XLSX\Manager\Style\StyleManager;
23
24		/**
25		* Class WorksheetManager
26		* XLSX worksheet manager, providing the interfaces to work with XLSX worksheets.
27		*/
28		class WorksheetManager implements WorksheetManagerInterface
29		{
30		use ManagesCellSize;
31
32		/**
33		* Maximum number of characters a cell can contain
34		* @see https://support.office.com/en-us/article/Excel-specifications-and-limits-16c69c74-3d6a-4aaf-ba35-e6eb276e8eaa [Excel 2007]
35		* @see https://support.office.com/en-us/article/Excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3 [Excel 2010]
36		* @see https://support.office.com/en-us/article/Excel-specifications-and-limits-ca36e2dc-1f09-4620-b726-67c00b05040f [Excel 2013/2016]
37		*/
38		const MAX_CHARACTERS_PER_CELL = 32767;
39
40		const SHEET_XML_FILE_HEADER = <<<'EOD'
41		<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
42		<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">
43		EOD;
44
45		/** @var bool Whether inline or shared strings should be used */
46		protected $shouldUseInlineStrings;
47
48		/** @var RowManager Manages rows */
49		private $rowManager;
50
51		/** @var StyleManager Manages styles */
52		private $styleManager;
53
54		/** @var StyleMerger Helper to merge styles together */
55		private $styleMerger;
56
57		/** @var SharedStringsManager Helper to write shared strings */
58		private $sharedStringsManager;
59
60		/** @var XLSXEscaper Strings escaper */
61		private $stringsEscaper;
62
63		/** @var StringHelper String helper */
64		private $stringHelper;
65
66		/** @var InternalEntityFactory Factory to create entities */
67		private $entityFactory;
68
69		/**
70		* WorksheetManager constructor.
71		*
72		* @param OptionsManagerInterface $optionsManager
73		* @param RowManager $rowManager
74		* @param StyleManager $styleManager
75		* @param StyleMerger $styleMerger
76		* @param SharedStringsManager $sharedStringsManager
77		* @param XLSXEscaper $stringsEscaper
78	43	* @param StringHelper $stringHelper
79		* @param InternalEntityFactory $entityFactory
80		*/
81		public function __construct(
82		OptionsManagerInterface $optionsManager,
83		RowManager $rowManager,
84		StyleManager $styleManager,
85		StyleMerger $styleMerger,
86		SharedStringsManager $sharedStringsManager,
87		XLSXEscaper $stringsEscaper,
88	43	StringHelper $stringHelper,
89	43	InternalEntityFactory $entityFactory
90	43	) {
91	43	$this->shouldUseInlineStrings = $optionsManager->getOption(Options::SHOULD_USE_INLINE_STRINGS);
92	43	$this->setDefaultColumnWidth($optionsManager->getOption(Options::DEFAULT_COLUMN_WIDTH));
93	43	$this->setDefaultRowHeight($optionsManager->getOption(Options::DEFAULT_ROW_HEIGHT));
94	43	$this->columnWidths = $optionsManager->getOption(Options::COLUMN_WIDTHS) ?? [];
		0 ignored issues – show Documentation Bug introduced 2020-10-29 21:45 UTC by Report Bug Copy Issue Report It seems like `$optionsManager->getOpti...LUMN_WIDTHS) ?? array()` of type `*` is incompatible with the declared type `array` of property `$columnWidths`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
95	43	$this->rowManager = $rowManager;
96	43	$this->styleManager = $styleManager;
97		$this->styleMerger = $styleMerger;
98		$this->sharedStringsManager = $sharedStringsManager;
99		$this->stringsEscaper = $stringsEscaper;
100		$this->stringHelper = $stringHelper;
101	39	$this->entityFactory = $entityFactory;
102		}
103	39
104		/**
105		* @return SharedStringsManager
106		*/
107		public function getSharedStringsManager()
108		{
109	43	return $this->sharedStringsManager;
110		}
111	43
112	43	/**
113		* {@inheritdoc}
114	43	*/
115		public function startSheet(Worksheet $worksheet)
116	43	{
117	43	$sheetFilePointer = \fopen($worksheet->getFilePath(), 'w');
118	43	$this->throwIfSheetFilePointerIsNotAvailable($sheetFilePointer);
119
120		$worksheet->setFilePointer($sheetFilePointer);
121
122		\fwrite($sheetFilePointer, self::SHEET_XML_FILE_HEADER);
123		}
124
125		/**
126		* Writes the sheet data header
127	43	*
128		* @param Worksheet $worksheet The worksheet to add the row to
129	43	* @return void
130		*/
131		private function ensureSheetDataStated(Worksheet $worksheet)
132	43	{
133		if (!$worksheet->getSheetDataStarted()) {
134		$worksheetFilePointer = $worksheet->getFilePointer();
135		\fwrite($worksheetFilePointer, $this->getXMLFragmentForDefaultCellSizing());
136		\fwrite($worksheetFilePointer, $this->getXMLFragmentForColumnWidths());
137	36	\fwrite($worksheetFilePointer, '<sheetData>');
138		$worksheet->setSheetDataStarted(true);
139	36	}
140	36	}
141
142		/**
143	35	* Checks if the sheet has been sucessfully created. Throws an exception if not.
144	35	*
145		* @param bool\|resource $sheetFilePointer Pointer to the sheet data file or FALSE if unable to open the file
146		* @throws IOException If the sheet data file cannot be opened for writing
147		* @return void
148		*/
149		private function throwIfSheetFilePointerIsNotAvailable($sheetFilePointer)
150		{
151		if (!$sheetFilePointer) {
152		throw new IOException('Unable to open sheet for writing.');
153		}
154		}
155	36
156		/**
157	36	* {@inheritdoc}
158	36	*/
159	36	public function addRow(Worksheet $worksheet, Row $row)
160		{
161	36	if (!$this->rowManager->isEmpty($row)) {
162		$this->addNonEmptyRow($worksheet, $row);
163	36	}
164	36
165	36	$worksheet->setLastWrittenRowIndex($worksheet->getLastWrittenRowIndex() + 1);
166	36	}
167	35
168		/**
169	36	* Adds non empty row to the worksheet.
170		*
171		* @param Worksheet $worksheet The worksheet to add the row to
172	35	* @param Row $row The row to be written
173		* @throws InvalidArgumentException If a cell value's type is not supported
174	35	* @throws IOException If the data cannot be written
175	35	* @return void
176		*/
177		private function addNonEmptyRow(Worksheet $worksheet, Row $row)
178	35	{
179		$this->ensureSheetDataStated($worksheet);
180		$sheetFilePointer = $worksheet->getFilePointer();
181		$rowStyle = $row->getStyle();
182		$rowIndexOneBased = $worksheet->getLastWrittenRowIndex() + 1;
183		$numCells = $row->getNumCells();
184
185		$hasCustomHeight = $this->defaultRowHeight > 0 ? '1' : '0';
186		$rowXML = "<row r=\"{$rowIndexOneBased}\" spans=\"1:{$numCells}\" customHeight=\"{$hasCustomHeight}\">";
187
188		foreach ($row->getCells() as $columnIndexZeroBased => $cell) {
189	36	$registeredStyle = $this->applyStyleAndRegister($cell, $rowStyle);
190		$cellStyle = $registeredStyle->getStyle();
191	36	if ($registeredStyle->isMatchingRowStyle()) {
192	36	$rowStyle = $cellStyle; // Replace actual rowStyle (possibly with null id) by registered style (with id)
193	35	}
194		$rowXML .= $this->getCellXML($rowIndexOneBased, $columnIndexZeroBased, $cell, $cellStyle->getId());
195	35	}
196
197	35	$rowXML .= '</row>';
198	1
199		$wasWriteSuccessful = \fwrite($sheetFilePointer, $rowXML);
200	35	if ($wasWriteSuccessful === false) {
201	35	throw new IOException("Unable to write data in {$worksheet->getFilePath()}");
202		}
203		}
204	3
205	3	/**
206		* Applies styles to the given style, merging the cell's style with its row's style
207	3	*
208		* @param Cell $cell
209	3	* @param Style $rowStyle
210		*
211		* @throws InvalidArgumentException If the given value cannot be processed
212	3	* @return RegisteredStyle
213		*/
214		private function applyStyleAndRegister(Cell $cell, Style $rowStyle) : RegisteredStyle
215	3	{
216		$isMatchingRowStyle = false;
217		if ($cell->getStyle()->isEmpty()) {
218	36	$cell->setStyle($rowStyle);
219
220		$possiblyUpdatedStyle = $this->styleManager->applyExtraStylesIfNeeded($cell);
221
222		if ($possiblyUpdatedStyle->isUpdated()) {
223		$registeredStyle = $this->styleManager->registerStyle($possiblyUpdatedStyle->getStyle());
224		} else {
225		$registeredStyle = $this->styleManager->registerStyle($rowStyle);
226		$isMatchingRowStyle = true;
227		}
228		} else {
229		$mergedCellAndRowStyle = $this->styleMerger->merge($cell->getStyle(), $rowStyle);
230		$cell->setStyle($mergedCellAndRowStyle);
231
232	36	$possiblyUpdatedStyle = $this->styleManager->applyExtraStylesIfNeeded($cell);
233
234	36	if ($possiblyUpdatedStyle->isUpdated()) {
235	36	$newCellStyle = $possiblyUpdatedStyle->getStyle();
236	36	} else {
237		$newCellStyle = $mergedCellAndRowStyle;
238	36	}
239	32
240	7	$registeredStyle = $this->styleManager->registerStyle($newCellStyle);
241	1	}
242	7
243	3	return new RegisteredStyle($registeredStyle, $isMatchingRowStyle);
244	5	}
245
246	1	/**
247	4	* Builds and returns xml for a single cell.
248	2	*
249	1	* @param int $rowIndexOneBased
250		* @param int $columnIndexZeroBased
251		* @param Cell $cell
252		* @param int $styleId
253	2	*
254		* @throws InvalidArgumentException If the given value cannot be processed
255		* @return string
256	2	*/
257		private function getCellXML($rowIndexOneBased, $columnIndexZeroBased, Cell $cell, $styleId)
258		{
259	35	$columnLetters = CellHelper::getColumnLettersFromColumnIndex($columnIndexZeroBased);
260		$cellXML = '<c r="' . $columnLetters . $rowIndexOneBased . '"';
261		$cellXML .= ' s="' . $styleId . '"';
262
263		if ($cell->isString()) {
264		$cellXML .= $this->getCellXMLFragmentForNonEmptyString($cell->getValue());
265		} elseif ($cell->isBoolean()) {
266		$cellXML .= ' t="b"><v>' . (int) ($cell->getValue()) . '</v></c>';
267		} elseif ($cell->isNumeric()) {
268		$cellXML .= '><v>' . $this->stringHelper->formatNumericValue($cell->getValue()) . '</v></c>';
269	32	} elseif ($cell->isError() && is_string($cell->getValueEvenIfError())) {
270		// only writes the error value if it's a string
271	32	$cellXML .= ' t="e"><v>' . $cell->getValueEvenIfError() . '</v></c>';
272		} elseif ($cell->isEmpty()) {
273		if ($this->styleManager->shouldApplyStyleOnEmptyCell($styleId)) {
274		$cellXML .= '/>';
275	32	} else {
276	29	// don't write empty cells that do no need styling
277		// NOTE: not appending to $cellXML is the right behavior!!
278	3	$cellXML = '';
279	3	}
280		} else {
281		throw new InvalidArgumentException('Trying to add a value with an unsupported type: ' . \gettype($cell->getValue()));
282	32	}
283
284		return $cellXML;
285		}
286
287		/**
288	39	* Returns the XML fragment for a cell containing a non empty string
289		*
290	39	* @param string $cellValue The cell value
291		* @throws InvalidArgumentException If the string exceeds the maximum number of characters allowed per cell
292	39	* @return string The XML fragment representing the cell
293		*/
294		private function getCellXMLFragmentForNonEmptyString($cellValue)
295		{
296	39	if ($this->stringHelper->getStringLength($cellValue) > self::MAX_CHARACTERS_PER_CELL) {
297	39	throw new InvalidArgumentException('Trying to add a value that exceeds the maximum number of characters allowed in a cell (32,767)');
298	39	}
299	39
300		if ($this->shouldUseInlineStrings) {
301		$cellXMLFragment = ' t="inlineStr"><is><t>' . $this->stringsEscaper->escape($cellValue) . '</t></is></c>';
302		} else {
303		$sharedStringId = $this->sharedStringsManager->writeString($cellValue);
304		$cellXMLFragment = ' t="s"><v>' . $sharedStringId . '</v></c>';
305		}
306
307		return $cellXMLFragment;
308		}
309
310		/**
311		* Construct column width references xml to inject into worksheet xml file
312		*
313		* @return string
314		*/
315		public function getXMLFragmentForColumnWidths()
316		{
317		if (empty($this->columnWidths)) {
318		return '';
319		}
320		$xml = '<cols>';
321		foreach ($this->columnWidths as $entry) {
322		$xml .= '<col min="' . $entry[0] . '" max="' . $entry[1] . '" width="' . $entry[2] . '" customWidth="true"/>';
323		}
324		$xml .= '</cols>';
325
326		return $xml;
327		}
328
329		/**
330		* Constructs default row height and width xml to inject into worksheet xml file
331		*
332		* @return string
333		*/
334		public function getXMLFragmentForDefaultCellSizing()
335		{
336		$rowHeightXml = empty($this->defaultRowHeight) ? '' : " defaultRowHeight=\"{$this->defaultRowHeight}\"";
337		$colWidthXml = empty($this->defaultColumnWidth) ? '' : " defaultColWidth=\"{$this->defaultColumnWidth}\"";
338		if (empty($colWidthXml) && empty($rowHeightXml)) {
339		return '';
340		}
341		// Ensure that the required defaultRowHeight is set
342		$rowHeightXml = empty($rowHeightXml) ? ' defaultRowHeight="0"' : $rowHeightXml;
343
344		return "<sheetFormatPr{$colWidthXml}{$rowHeightXml}/>";
345		}
346
347		/**
348		* {@inheritdoc}
349		*/
350		public function close(Worksheet $worksheet)
351		{
352		$worksheetFilePointer = $worksheet->getFilePointer();
353
354		if (!\is_resource($worksheetFilePointer)) {
355		return;
356		}
357		$this->ensureSheetDataStated($worksheet);
358		\fwrite($worksheetFilePointer, '</sheetData>');
359		\fwrite($worksheetFilePointer, '</worksheet>');
360		\fclose($worksheetFilePointer);
361		}
362		}
363

box / spout

Pull Request — master (#808)

WorksheetManager::ensureSheetDataStated() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like