WorksheetManager::throwIfSheetFilePointerIsNotAvailable() - Code Metrics - Inspection of "Refactor writers for better DI" - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop_3.0 (#427)

by Adrien

created 2017-05-29 19:38 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\ODS\Manager;

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\Entity\Worksheet;
use Box\Spout\Writer\Manager\WorksheetManagerInterface;
use Box\Spout\Writer\ODS\Helper\StyleHelper;
use Box\Spout\Writer\Style\Style;

/**
 * Class WorksheetManager
 * ODS worksheet manager, providing the interfaces to work with ODS worksheets.
 *
 * @package Box\Spout\Writer\ODS\Manager
 */
class WorksheetManager implements WorksheetManagerInterface
{
    /** @var StyleHelper Helper to work with styles */
    private $styleHelper;

    /** @var \Box\Spout\Common\Escaper\ODS Strings escaper */
    private $stringsEscaper;

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

    /**
     * WorksheetManager constructor.
     *
     * @param StyleHelper $styleHelper
     * @param \Box\Spout\Common\Escaper\ODS $stringsEscaper
     * @param StringHelper $stringHelper
     */
    public function __construct(
        StyleHelper $styleHelper,
        \Box\Spout\Common\Escaper\ODS $stringsEscaper,
        StringHelper $stringHelper)
    {
        $this->styleHelper = $styleHelper;
        $this->stringsEscaper = $stringsEscaper;
        $this->stringHelper = $stringHelper;
    }

    /**
     * Prepares the worksheet to accept data
     *
     * @param Worksheet $worksheet The worksheet to start
     * @return void
     * @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
     */
    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
     * @return void
     * @throws IOException If the sheet data file cannot be opened for writing
     */
    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 data to the given worksheet.
     *
     * @param Worksheet $worksheet The worksheet to add the row to
     * @param array $dataRow Array containing data to be written. Cannot be empty.
     *          Example $dataRow = ['data1', 1234, null, '', 'data5'];
     * @param Style $rowStyle Style to be applied to the row. NULL means use default style.
     * @return void
     * @throws IOException If the data cannot be written
     * @throws InvalidArgumentException If a cell value's type is not supported
     */
    public function addRow(Worksheet $worksheet, $dataRow, $rowStyle)
    {
        // $dataRow can be an associative array. We need to transform
        // it into a regular array, as we'll use the numeric indexes.
        $dataRowWithNumericIndexes = array_values($dataRow);

        $styleIndex = ($rowStyle->getId() + 1); // 1-based
        $cellsCount = count($dataRow);

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

        $currentCellIndex = 0;
        $nextCellIndex = 1;

        for ($i = 0; $i < $cellsCount; $i++) {
            $currentCellValue = $dataRowWithNumericIndexes[$currentCellIndex];

            // Using isset here because it is way faster than array_key_exists...
            if (!isset($dataRowWithNumericIndexes[$nextCellIndex]) ||
                $currentCellValue !== $dataRowWithNumericIndexes[$nextCellIndex]) {

                $numTimesValueRepeated = ($nextCellIndex - $currentCellIndex);
                $data .= $this->getCellXML($currentCellValue, $styleIndex, $numTimesValueRepeated);

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

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

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

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

        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>';
        } else if ($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>';
        } else if ($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>';
        } else if ($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\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\Entity\Worksheet;
10		use Box\Spout\Writer\Manager\WorksheetManagerInterface;
11		use Box\Spout\Writer\ODS\Helper\StyleHelper;
12		use Box\Spout\Writer\Style\Style;
13
14		/**
15		* Class WorksheetManager
16		* ODS worksheet manager, providing the interfaces to work with ODS worksheets.
17		*
18		* @package Box\Spout\Writer\ODS\Manager
19		*/
20		class WorksheetManager implements WorksheetManagerInterface
21		{
22		/** @var StyleHelper Helper to work with styles */
23		private $styleHelper;
24
25		/** @var \Box\Spout\Common\Escaper\ODS Strings escaper */
26		private $stringsEscaper;
27
28		/** @var StringHelper String helper */
29		private $stringHelper;
30
31		/**
32		* WorksheetManager constructor.
33		*
34		* @param StyleHelper $styleHelper
35		* @param \Box\Spout\Common\Escaper\ODS $stringsEscaper
36		* @param StringHelper $stringHelper
37		*/
38	43	public function __construct(
39		StyleHelper $styleHelper,
40		\Box\Spout\Common\Escaper\ODS $stringsEscaper,
41		StringHelper $stringHelper)
42		{
43	43	$this->styleHelper = $styleHelper;
44	43	$this->stringsEscaper = $stringsEscaper;
45	43	$this->stringHelper = $stringHelper;
46	43	}
47
48		/**
49		* Prepares the worksheet to accept data
50		*
51		* @param Worksheet $worksheet The worksheet to start
52		* @return void
53		* @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
54		*/
55	43	public function startSheet(Worksheet $worksheet)
56		{
57	43	$sheetFilePointer = fopen($worksheet->getFilePath(), 'w');
58	43	$this->throwIfSheetFilePointerIsNotAvailable($sheetFilePointer);
59
60	43	$worksheet->setFilePointer($sheetFilePointer);
61	43	}
62
63		/**
64		* Checks if the sheet has been sucessfully created. Throws an exception if not.
65		*
66		* @param bool\|resource $sheetFilePointer Pointer to the sheet data file or FALSE if unable to open the file
67		* @return void
68		* @throws IOException If the sheet data file cannot be opened for writing
69		*/
70	43	private function throwIfSheetFilePointerIsNotAvailable($sheetFilePointer)
71		{
72	43	if (!$sheetFilePointer) {
73		throw new IOException('Unable to open sheet for writing.');
74		}
75	43	}
76
77		/**
78		* Returns the table XML root node as string.
79		*
80		* @param Worksheet $worksheet
81		* @return string <table> node as string
82		*/
83	34	public function getTableElementStartAsString(Worksheet $worksheet)
84		{
85	34	$externalSheet = $worksheet->getExternalSheet();
86	34	$escapedSheetName = $this->stringsEscaper->escape($externalSheet->getName());
87	34	$tableStyleName = 'ta' . ($externalSheet->getIndex() + 1);
88
89	34	$tableElement = '<table:table table:style-name="' . $tableStyleName . '" table:name="' . $escapedSheetName . '">';
90	34	$tableElement .= '<table:table-column table:default-cell-style-name="ce1" table:style-name="co1" table:number-columns-repeated="' . $worksheet->getMaxNumColumns() . '"/>';
91
92	34	return $tableElement;
93		}
94
95		/**
96		* Adds data to the given worksheet.
97		*
98		* @param Worksheet $worksheet The worksheet to add the row to
99		* @param array $dataRow Array containing data to be written. Cannot be empty.
100		* Example $dataRow = ['data1', 1234, null, '', 'data5'];
101		* @param Style $rowStyle Style to be applied to the row. NULL means use default style.
102		* @return void
103		* @throws IOException If the data cannot be written
104		* @throws InvalidArgumentException If a cell value's type is not supported
105		*/
106	31	public function addRow(Worksheet $worksheet, $dataRow, $rowStyle)
107		{
108		// $dataRow can be an associative array. We need to transform
109		// it into a regular array, as we'll use the numeric indexes.
110	31	$dataRowWithNumericIndexes = array_values($dataRow);
111
112	31	$styleIndex = ($rowStyle->getId() + 1); // 1-based
113	31	$cellsCount = count($dataRow);
114
115	31	$data = '<table:table-row table:style-name="ro1">';
116
117	31	$currentCellIndex = 0;
118	31	$nextCellIndex = 1;
119
120	31	for ($i = 0; $i < $cellsCount; $i++) {
121	31	$currentCellValue = $dataRowWithNumericIndexes[$currentCellIndex];
122
123		// Using isset here because it is way faster than array_key_exists...
124	31	if (!isset($dataRowWithNumericIndexes[$nextCellIndex]) \|\|
125	21	$currentCellValue !== $dataRowWithNumericIndexes[$nextCellIndex]) {
126
127	31	$numTimesValueRepeated = ($nextCellIndex - $currentCellIndex);
128	31	$data .= $this->getCellXML($currentCellValue, $styleIndex, $numTimesValueRepeated);
129
130	30	$currentCellIndex = $nextCellIndex;
131		}
132
133	30	$nextCellIndex++;
134		}
135
136	30	$data .= '</table:table-row>';
137
138	30	$wasWriteSuccessful = fwrite($worksheet->getFilePointer(), $data);
139	30	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	30	$lastWrittenRowIndex = $worksheet->getLastWrittenRowIndex();
145	30	$worksheet->setLastWrittenRowIndex($lastWrittenRowIndex + 1);
146	30	}
147
148		/**
149		* Returns the cell XML content, given its value.
150		*
151		* @param mixed $cellValue The value to be written
152		* @param int $styleIndex Index of the used style
153		* @param int $numTimesValueRepeated Number of times the value is consecutively repeated
154		* @return string The cell XML content
155		* @throws \Box\Spout\Common\Exception\InvalidArgumentException If a cell value's type is not supported
156		*/
157	31	private function getCellXML($cellValue, $styleIndex, $numTimesValueRepeated)
158		{
159	31	$data = '<table:table-cell table:style-name="ce' . $styleIndex . '"';
160
161	31	if ($numTimesValueRepeated !== 1) {
162	4	$data .= ' table:number-columns-repeated="' . $numTimesValueRepeated . '"';
163		}
164
165		/** @TODO Remove code duplication with XLSX writer: https://github.com/box/spout/pull/383#discussion_r113292746 */
166	31	if ($cellValue instanceof Cell) {
167	2	$cell = $cellValue;
168		} else {
169	29	$cell = new Cell($cellValue);
170		}
171
172	31	if ($cell->isString()) {
173	27	$data .= ' office:value-type="string" calcext:value-type="string">';
174
175	27	$cellValueLines = explode("\n", $cell->getValue());
176	27	foreach ($cellValueLines as $cellValueLine) {
177	27	$data .= '<text:p>' . $this->stringsEscaper->escape($cellValueLine) . '</text:p>';
178		}
179
180	27	$data .= '</table:table-cell>';
181	7	} else if ($cell->isBoolean()) {
182	3	$data .= ' office:value-type="boolean" calcext:value-type="boolean" office:boolean-value="' . $cell->getValue() . '">';
183	3	$data .= '<text:p>' . $cell->getValue() . '</text:p>';
184	3	$data .= '</table:table-cell>';
185	6	} else if ($cell->isNumeric()) {
186	3	$data .= ' office:value-type="float" calcext:value-type="float" office:value="' . $cell->getValue() . '">';
187	3	$data .= '<text:p>' . $cell->getValue() . '</text:p>';
188	3	$data .= '</table:table-cell>';
189	4	} else if ($cell->isEmpty()) {
190	2	$data .= '/>';
191		} else {
192	2	throw new InvalidArgumentException('Trying to add a value with an unsupported type: ' . gettype($cell->getValue()));
193		}
194
195	30	return $data;
196		}
197
198		/**
199		* Closes the worksheet
200		*
201		* @param Worksheet $worksheet
202		* @return void
203		*/
204	34	public function close(Worksheet $worksheet)
205		{
206	34	$worksheetFilePointer = $worksheet->getFilePointer();
207
208	34	if (!is_resource($worksheetFilePointer)) {
209		return;
210		}
211
212	34	fclose($worksheetFilePointer);
213		}
214		}

box / spout

Pull Request — develop_3.0 (#427)

throwIfSheetFilePointerIsNotAvailable() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like