WorksheetManager::startSheet() - Code Metrics - Inspection of "XLSX and ODS write optimization" - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#763)

unknown

created 2020-08-25 14:39 UTC

WorksheetManager::startSheet() A

↳ Parent: WorksheetManager

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	7
ccs	5
cts	5
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php

namespace Box\Spout\Writer\ODS\Manager;

use Box\Spout\Common\Entity\Cell;
use Box\Spout\Common\Entity\Row;
use Box\Spout\Common\Entity\Style\EmptyStyle;
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\ODS as ODSEscaper;
use Box\Spout\Common\Helper\StringHelper;
use Box\Spout\Writer\Common\Entity\Worksheet;
use Box\Spout\Writer\Common\Manager\Style\StyleMerger;
use Box\Spout\Writer\Common\Manager\WorksheetManagerInterface;
use Box\Spout\Writer\ODS\Manager\Style\StyleManager;

/**
 * Class WorksheetManager
 * ODS worksheet manager, providing the interfaces to work with ODS worksheets.
 */
class WorksheetManager implements WorksheetManagerInterface
{
    /** @var \Box\Spout\Common\Helper\Escaper\ODS Strings escaper */
    private $stringsEscaper;

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

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

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

    /**
     * WorksheetManager constructor.
     *
     * @param StyleManager $styleManager
     * @param StyleMerger $styleMerger
     * @param ODSEscaper $stringsEscaper
     * @param StringHelper $stringHelper
     */
    public function __construct(
        StyleManager $styleManager,
        StyleMerger $styleMerger,
        ODSEscaper $stringsEscaper,
        StringHelper $stringHelper
    ) {
        $this->styleManager = $styleManager;
        $this->styleMerger = $styleMerger;
        $this->stringsEscaper = $stringsEscaper;
        $this->stringHelper = $stringHelper;
    }

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

        $worksheet->setFilePointer($sheetFilePointer);
    }

    /**
     * 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.');
        }
    }

    /**
     * Returns the table XML root node as string.
     *
     * @param Worksheet $worksheet
     * @return string <table> node as string
     */
    public function getTableElementStartAsString(Worksheet $worksheet)
    {
        $externalSheet = $worksheet->getExternalSheet();
        $escapedSheetName = $this->stringsEscaper->escape($externalSheet->getName());
        $tableStyleName = 'ta' . ($externalSheet->getIndex() + 1);

        $tableElement  = '<table:table table:style-name="' . $tableStyleName . '" table:name="' . $escapedSheetName . '">';
        $tableElement .= '<table:table-column table:default-cell-style-name="ce1" table:style-name="co1" table:number-columns-repeated="' . $worksheet->getMaxNumColumns() . '"/>';

        return $tableElement;
    }

    /**
     * Adds a row to the given worksheet.
     *
     * @param Worksheet $worksheet The worksheet to add the row to
     * @param Row $row The row to be added
     * @throws IOException If the data cannot be written
     * @throws InvalidArgumentException If a cell value's type is not supported
     * @return void
     */
    public function addRow(Worksheet $worksheet, Row $row)
    {
        $cells = $row->getCells();
        $rowStyle = $row->getStyle();

        $data = '<table:table-row table:style-name="ro1">';

        $currentCellIndex = 0;
        $nextCellIndex = 1;

        for ($i = 0; $i < $row->getNumCells(); $i++) {
            /** @var Cell $cell */
            $cell = $cells[$currentCellIndex];
            /** @var Cell|null $nextCell */
            $nextCell = isset($cells[$nextCellIndex]) ? $cells[$nextCellIndex] : null;

            if ($nextCell === null || $cell->getValue() !== $nextCell->getValue()) {
                $data .= $this->applyStyleAndGetCellXML($cell, $rowStyle, $currentCellIndex, $nextCellIndex);
                $currentCellIndex = $nextCellIndex;
            }

            $nextCellIndex++;
        }

        $data .= '</table:table-row>';

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

        // only update the count if the write worked
        $lastWrittenRowIndex = $worksheet->getLastWrittenRowIndex();
        $worksheet->setLastWrittenRowIndex($lastWrittenRowIndex + 1);
    }

    /**
     * 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 $currentCellIndex
     * @param int $nextCellIndex
     * @throws InvalidArgumentException If a cell value's type is not supported
     * @return string
     */
    private function applyStyleAndGetCellXML(Cell $cell, Style $rowStyle, $currentCellIndex, $nextCellIndex)
    {
        if ($cell->getStyle() instanceof EmptyStyle) {
            $cell->setStyle($rowStyle);
        } else {
            $mergedCellAndRowStyle = $this->styleMerger->merge($cell->getStyle(), $rowStyle);
            $cell->setStyle($mergedCellAndRowStyle);
        }

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

        $registeredStyle = $this->styleManager->registerStyle($newCellStyle);
        $styleIndex = $registeredStyle->getId() + 1; // 1-based

        $numTimesValueRepeated = ($nextCellIndex - $currentCellIndex);

        return $this->getCellXML($cell, $styleIndex, $numTimesValueRepeated);
    }

    /**
     * Returns the cell XML content, given its value.
     *
     * @param Cell $cell The cell to be written
     * @param int $styleIndex Index of the used style
     * @param int $numTimesValueRepeated Number of times the value is consecutively repeated
     * @throws InvalidArgumentException If a cell value's type is not supported
     * @return string The cell XML content
     */
    private function getCellXML(Cell $cell, $styleIndex, $numTimesValueRepeated)
    {
        $data = '<table:table-cell table:style-name="ce' . $styleIndex . '"';

        if ($numTimesValueRepeated !== 1) {
            $data .= ' table:number-columns-repeated="' . $numTimesValueRepeated . '"';
        }

        if ($cell->isString()) {
            $data .= ' office:value-type="string" calcext:value-type="string">';

            $cellValueLines = \explode("\n", $cell->getValue());
            foreach ($cellValueLines as $cellValueLine) {
                $data .= '<text:p>' . $this->stringsEscaper->escape($cellValueLine) . '</text:p>';
            }

            $data .= '</table:table-cell>';
        } elseif ($cell->isBoolean()) {
            $data .= ' office:value-type="boolean" calcext:value-type="boolean" office:boolean-value="' . $cell->getValue() . '">';
            $data .= '<text:p>' . $cell->getValue() . '</text:p>';
            $data .= '</table:table-cell>';
        } elseif ($cell->isNumeric()) {
            $data .= ' office:value-type="float" calcext:value-type="float" office:value="' . $cell->getValue() . '">';
            $data .= '<text:p>' . $cell->getValue() . '</text:p>';
            $data .= '</table:table-cell>';
        } elseif ($cell->isError() && is_string($cell->getValueEvenIfError())) {
            // only writes the error value if it's a string
            $data .= ' office:value-type="string" calcext:value-type="error" office:value="">';
            $data .= '<text:p>' . $cell->getValueEvenIfError() . '</text:p>';
            $data .= '</table:table-cell>';
        } elseif ($cell->isEmpty()) {
            $data .= '/>';
        } else {
            throw new InvalidArgumentException('Trying to add a value with an unsupported type: ' . \gettype($cell->getValue()));
        }

        return $data;
    }

    /**
     * Closes the worksheet
     *
     * @param Worksheet $worksheet
     * @return void
     */
    public function close(Worksheet $worksheet)
    {
        $worksheetFilePointer = $worksheet->getFilePointer();

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

        \fclose($worksheetFilePointer);
    }
}


1		<?php
2
3		namespace Box\Spout\Writer\ODS\Manager;
4
5		use Box\Spout\Common\Entity\Cell;
6		use Box\Spout\Common\Entity\Row;
7		use Box\Spout\Common\Entity\Style\EmptyStyle;
8		use Box\Spout\Common\Entity\Style\Style;
9		use Box\Spout\Common\Exception\InvalidArgumentException;
10		use Box\Spout\Common\Exception\IOException;
11		use Box\Spout\Common\Helper\Escaper\ODS as ODSEscaper;
12		use Box\Spout\Common\Helper\StringHelper;
13		use Box\Spout\Writer\Common\Entity\Worksheet;
14		use Box\Spout\Writer\Common\Manager\Style\StyleMerger;
15		use Box\Spout\Writer\Common\Manager\WorksheetManagerInterface;
16		use Box\Spout\Writer\ODS\Manager\Style\StyleManager;
17
18		/**
19		* Class WorksheetManager
20		* ODS worksheet manager, providing the interfaces to work with ODS worksheets.
21		*/
22		class WorksheetManager implements WorksheetManagerInterface
23		{
24		/** @var \Box\Spout\Common\Helper\Escaper\ODS Strings escaper */
25		private $stringsEscaper;
26
27		/** @var StringHelper String helper */
28		private $stringHelper;
29
30		/** @var StyleManager Manages styles */
31		private $styleManager;
32
33		/** @var StyleMerger Helper to merge styles together */
34		private $styleMerger;
35
36		/**
37		* WorksheetManager constructor.
38		*
39		* @param StyleManager $styleManager
40		* @param StyleMerger $styleMerger
41		* @param ODSEscaper $stringsEscaper
42		* @param StringHelper $stringHelper
43		*/
44	38	public function __construct(
45		StyleManager $styleManager,
46		StyleMerger $styleMerger,
47		ODSEscaper $stringsEscaper,
48		StringHelper $stringHelper
49		) {
50	38	$this->styleManager = $styleManager;
51	38	$this->styleMerger = $styleMerger;
52	38	$this->stringsEscaper = $stringsEscaper;
53	38	$this->stringHelper = $stringHelper;
54	38	}
55
56		/**
57		* Prepares the worksheet to accept data
58		*
59		* @param Worksheet $worksheet The worksheet to start
60		* @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
61		* @return void
62		*/
63	38	public function startSheet(Worksheet $worksheet)
64		{
65	38	$sheetFilePointer = \fopen($worksheet->getFilePath(), 'w');
66	38	$this->throwIfSheetFilePointerIsNotAvailable($sheetFilePointer);
67
68	38	$worksheet->setFilePointer($sheetFilePointer);
69	38	}
70
71		/**
72		* Checks if the sheet has been sucessfully created. Throws an exception if not.
73		*
74		* @param bool\|resource $sheetFilePointer Pointer to the sheet data file or FALSE if unable to open the file
75		* @throws IOException If the sheet data file cannot be opened for writing
76		* @return void
77		*/
78	38	private function throwIfSheetFilePointerIsNotAvailable($sheetFilePointer)
79		{
80	38	if (!$sheetFilePointer) {
81		throw new IOException('Unable to open sheet for writing.');
82		}
83	38	}
84
85		/**
86		* Returns the table XML root node as string.
87		*
88		* @param Worksheet $worksheet
89		* @return string <table> node as string
90		*/
91	35	public function getTableElementStartAsString(Worksheet $worksheet)
92		{
93	35	$externalSheet = $worksheet->getExternalSheet();
94	35	$escapedSheetName = $this->stringsEscaper->escape($externalSheet->getName());
95	35	$tableStyleName = 'ta' . ($externalSheet->getIndex() + 1);
96
97	35	$tableElement = '<table:table table:style-name="' . $tableStyleName . '" table:name="' . $escapedSheetName . '">';
98	35	$tableElement .= '<table:table-column table:default-cell-style-name="ce1" table:style-name="co1" table:number-columns-repeated="' . $worksheet->getMaxNumColumns() . '"/>';
99
100	35	return $tableElement;
101		}
102
103		/**
104		* Adds a row to the given worksheet.
105		*
106		* @param Worksheet $worksheet The worksheet to add the row to
107		* @param Row $row The row to be added
108		* @throws IOException If the data cannot be written
109		* @throws InvalidArgumentException If a cell value's type is not supported
110		* @return void
111		*/
112	33	public function addRow(Worksheet $worksheet, Row $row)
113		{
114	33	$cells = $row->getCells();
115	33	$rowStyle = $row->getStyle();
116
117	33	$data = '<table:table-row table:style-name="ro1">';
118
119	33	$currentCellIndex = 0;
120	33	$nextCellIndex = 1;
121
122	33	for ($i = 0; $i < $row->getNumCells(); $i++) {
123		/** @var Cell $cell */
124	33	$cell = $cells[$currentCellIndex];
125		/** @var Cell\|null $nextCell */
126	33	$nextCell = isset($cells[$nextCellIndex]) ? $cells[$nextCellIndex] : null;
127
128	33	if ($nextCell === null \|\| $cell->getValue() !== $nextCell->getValue()) {
129	33	$data .= $this->applyStyleAndGetCellXML($cell, $rowStyle, $currentCellIndex, $nextCellIndex);
130	32	$currentCellIndex = $nextCellIndex;
131		}
132
133	32	$nextCellIndex++;
134		}
135
136	32	$data .= '</table:table-row>';
137
138	32	$wasWriteSuccessful = \fwrite($worksheet->getFilePointer(), $data);
139	32	if ($wasWriteSuccessful === false) {
140		throw new IOException("Unable to write data in {$worksheet->getFilePath()}");
141		}
142
143		// only update the count if the write worked
144	32	$lastWrittenRowIndex = $worksheet->getLastWrittenRowIndex();
145	32	$worksheet->setLastWrittenRowIndex($lastWrittenRowIndex + 1);
146	32	}
147
148		/**
149		* Applies styles to the given style, merging the cell's style with its row's style
150		* Then builds and returns xml for the cell.
151		*
152		* @param Cell $cell
153		* @param Style $rowStyle
154		* @param int $currentCellIndex
155		* @param int $nextCellIndex
156		* @throws InvalidArgumentException If a cell value's type is not supported
157		* @return string
158		*/
159	33	private function applyStyleAndGetCellXML(Cell $cell, Style $rowStyle, $currentCellIndex, $nextCellIndex)
160		{
161	33	if ($cell->getStyle() instanceof EmptyStyle) {
162	32	$cell->setStyle($rowStyle);
163		} else {
164	2	$mergedCellAndRowStyle = $this->styleMerger->merge($cell->getStyle(), $rowStyle);
165	2	$cell->setStyle($mergedCellAndRowStyle);
166		}
167
168	33	$newCellStyle = $this->styleManager->applyExtraStylesIfNeeded($cell);
169
170	33	$registeredStyle = $this->styleManager->registerStyle($newCellStyle);
171	33	$styleIndex = $registeredStyle->getId() + 1; // 1-based
172
173	33	$numTimesValueRepeated = ($nextCellIndex - $currentCellIndex);
174
175	33	return $this->getCellXML($cell, $styleIndex, $numTimesValueRepeated);
176		}
177
178		/**
179		* Returns the cell XML content, given its value.
180		*
181		* @param Cell $cell The cell to be written
182		* @param int $styleIndex Index of the used style
183		* @param int $numTimesValueRepeated Number of times the value is consecutively repeated
184		* @throws InvalidArgumentException If a cell value's type is not supported
185		* @return string The cell XML content
186		*/
187	33	private function getCellXML(Cell $cell, $styleIndex, $numTimesValueRepeated)
188		{
189	33	$data = '<table:table-cell table:style-name="ce' . $styleIndex . '"';
190
191	33	if ($numTimesValueRepeated !== 1) {
192	4	$data .= ' table:number-columns-repeated="' . $numTimesValueRepeated . '"';
193		}
194
195	33	if ($cell->isString()) {
196	28	$data .= ' office:value-type="string" calcext:value-type="string">';
197
198	28	$cellValueLines = \explode("\n", $cell->getValue());
199	28	foreach ($cellValueLines as $cellValueLine) {
200	28	$data .= '<text:p>' . $this->stringsEscaper->escape($cellValueLine) . '</text:p>';
201		}
202
203	28	$data .= '</table:table-cell>';
204	7	} elseif ($cell->isBoolean()) {
205	2	$data .= ' office:value-type="boolean" calcext:value-type="boolean" office:boolean-value="' . $cell->getValue() . '">';
206	2	$data .= '<text:p>' . $cell->getValue() . '</text:p>';
207	2	$data .= '</table:table-cell>';
208	6	} elseif ($cell->isNumeric()) {
209	2	$data .= ' office:value-type="float" calcext:value-type="float" office:value="' . $cell->getValue() . '">';
210	2	$data .= '<text:p>' . $cell->getValue() . '</text:p>';
211	2	$data .= '</table:table-cell>';
212	5	} elseif ($cell->isError() && is_string($cell->getValueEvenIfError())) {
213		// only writes the error value if it's a string
214	1	$data .= ' office:value-type="string" calcext:value-type="error" office:value="">';
215	1	$data .= '<text:p>' . $cell->getValueEvenIfError() . '</text:p>';
216	1	$data .= '</table:table-cell>';
217	4	} elseif ($cell->isEmpty()) {
218	2	$data .= '/>';
219		} else {
220	2	throw new InvalidArgumentException('Trying to add a value with an unsupported type: ' . \gettype($cell->getValue()));
221		}
222
223	32	return $data;
224		}
225
226		/**
227		* Closes the worksheet
228		*
229		* @param Worksheet $worksheet
230		* @return void
231		*/
232	35	public function close(Worksheet $worksheet)
233		{
234	35	$worksheetFilePointer = $worksheet->getFilePointer();
235
236	35	if (!\is_resource($worksheetFilePointer)) {
237		return;
238		}
239
240	35	\fclose($worksheetFilePointer);
241	35	}
242		}
243

box / spout

Pull Request — master (#763)

WorksheetManager::startSheet() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like