Worksheet::getExternalSheet() - Code Metrics - Inspection of "Add consistency using getCellXML() (#306)" - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 435a9a...d4e57b )

by Adrien

created 2016-09-07 02:47 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	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
ccs	2
cts	2
cp	1
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 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 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, $shouldUseInlineStrings)
    {
        $this->externalSheet = $externalSheet;
        $this->sharedStringsHelper = $sharedStringsHelper;
        $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)
    {
        $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}");
        }

        // only update the count if the write worked
        $this->lastWrittenRowIndex++;
    }

    /**
     * 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)) {
            // don't write empty cells (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 bool Whether inline or shared strings should be used */
34		protected $shouldUseInlineStrings;
35
36		/** @var \Box\Spout\Common\Escaper\XLSX Strings escaper */
37		protected $stringsEscaper;
38
39		/** @var Resource Pointer to the sheet data file (e.g. xl/worksheets/sheet1.xml) */
40		protected $sheetFilePointer;
41
42		/** @var int Index of the last written row */
43		protected $lastWrittenRowIndex = 0;
44
45		/**
46		* @param \Box\Spout\Writer\Common\Sheet $externalSheet The associated "external" sheet
47		* @param string $worksheetFilesFolder Temporary folder where the files to create the XLSX will be stored
48		* @param \Box\Spout\Writer\XLSX\Helper\SharedStringsHelper $sharedStringsHelper Helper for shared strings
49		* @param bool $shouldUseInlineStrings Whether inline or shared strings should be used
50		* @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
51		*/
52	117	public function __construct($externalSheet, $worksheetFilesFolder, $sharedStringsHelper, $shouldUseInlineStrings)
53		{
54	117	$this->externalSheet = $externalSheet;
55	117	$this->sharedStringsHelper = $sharedStringsHelper;
56	117	$this->shouldUseInlineStrings = $shouldUseInlineStrings;
57
58		/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
59	117	$this->stringsEscaper = \Box\Spout\Common\Escaper\XLSX::getInstance();
60
61	117	$this->worksheetFilePath = $worksheetFilesFolder . '/' . strtolower($this->externalSheet->getName()) . '.xml';
62	117	$this->startSheet();
63	117	}
64
65		/**
66		* Prepares the worksheet to accept data
67		*
68		* @return void
69		* @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
70		*/
71	117	protected function startSheet()
72		{
73	117	$this->sheetFilePointer = fopen($this->worksheetFilePath, 'w');
74	117	$this->throwIfSheetFilePointerIsNotAvailable();
75
76	117	fwrite($this->sheetFilePointer, self::SHEET_XML_FILE_HEADER);
77	117	fwrite($this->sheetFilePointer, '<sheetData>');
78	117	}
79
80		/**
81		* Checks if the book has been created. Throws an exception if not created yet.
82		*
83		* @return void
84		* @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
85		*/
86	117	protected function throwIfSheetFilePointerIsNotAvailable()
87		{
88	117	if (!$this->sheetFilePointer) {
89		throw new IOException('Unable to open sheet for writing.');
90		}
91	117	}
92
93		/**
94		* @return \Box\Spout\Writer\Common\Sheet The "external" sheet
95		*/
96	87	public function getExternalSheet()
97		{
98	87	return $this->externalSheet;
99		}
100
101		/**
102		* @return int The index of the last written row
103		*/
104	81	public function getLastWrittenRowIndex()
105		{
106	81	return $this->lastWrittenRowIndex;
107		}
108
109		/**
110		* @return int The ID of the worksheet
111		*/
112	84	public function getId()
113		{
114		// sheet index is zero-based, while ID is 1-based
115	84	return $this->externalSheet->getIndex() + 1;
116		}
117
118		/**
119		* Adds data to the worksheet.
120		*
121		* @param array $dataRow Array containing data to be written. Cannot be empty.
122		* Example $dataRow = ['data1', 1234, null, '', 'data5'];
123		* @param \Box\Spout\Writer\Style\Style $style Style to be applied to the row. NULL means use default style.
124		* @return void
125		* @throws \Box\Spout\Common\Exception\IOException If the data cannot be written
126		* @throws \Box\Spout\Common\Exception\InvalidArgumentException If a cell value's type is not supported
127		*/
128	81	public function addRow($dataRow, $style)
129		{
130	81	$cellNumber = 0;
131	81	$rowIndex = $this->lastWrittenRowIndex + 1;
132	81	$numCells = count($dataRow);
133
134	81	$rowXML = '<row r="' . $rowIndex . '" spans="1:' . $numCells . '">';
135
136	81	foreach($dataRow as $cellValue) {
137	81	$rowXML .= $this->getCellXML($rowIndex, $cellNumber, $cellValue, $style->getId());
138	78	$cellNumber++;
139	78	}
140
141	78	$rowXML .= '</row>';
142
143	78	$wasWriteSuccessful = fwrite($this->sheetFilePointer, $rowXML);
144	78	if ($wasWriteSuccessful === false) {
145		throw new IOException("Unable to write data in {$this->worksheetFilePath}");
146		}
147
148		// only update the count if the write worked
149	78	$this->lastWrittenRowIndex++;
150	78	}
151
152		/**
153		* Build and return xml for a single cell.
154		*
155		* @param int $rowIndex
156		* @param int $cellNumber
157		* @param mixed $cellValue
158		* @param int $styleId
159		* @return string
160		* @throws InvalidArgumentException
161		*/
162	81	private function getCellXML($rowIndex, $cellNumber, $cellValue, $styleId)
163		{
164	81	$columnIndex = CellHelper::getCellIndexFromColumnIndex($cellNumber);
165	81	$cellXML = '<c r="' . $columnIndex . $rowIndex . '"';
166	81	$cellXML .= ' s="' . $styleId . '"';
167
168	81	if (CellHelper::isNonEmptyString($cellValue)) {
169	78	if ($this->shouldUseInlineStrings) {
170	69	$cellXML .= ' t="inlineStr"><is><t>' . $this->stringsEscaper->escape($cellValue) . '</t></is></c>';
171	69	} else {
172	9	$sharedStringId = $this->sharedStringsHelper->writeString($cellValue);
173	9	$cellXML .= ' t="s"><v>' . $sharedStringId . '</v></c>';
174		}
175	81	} else if (CellHelper::isBoolean($cellValue)) {
176	3	$cellXML .= ' t="b"><v>' . intval($cellValue) . '</v></c>';
177	6	} else if (CellHelper::isNumeric($cellValue)) {
178	3	$cellXML .= '><v>' . $cellValue . '</v></c>';
179	6	} else if (empty($cellValue)) {
180		// don't write empty cells (not appending to $cellXML is the right behavior!)
181	3	$cellXML = '';
182	3	} else {
183	3	throw new InvalidArgumentException('Trying to add a value with an unsupported type: ' . gettype($cellValue));
184		}
185
186	78	return $cellXML;
187		}
188
189		/**
190		* Closes the worksheet
191		*
192		* @return void
193		*/
194	84	public function close()
195		{
196	84	if (!is_resource($this->sheetFilePointer)) {
197		return;
198		}
199
200	84	fwrite($this->sheetFilePointer, '</sheetData>');
201	84	fwrite($this->sheetFilePointer, '</worksheet>');
202	84	fclose($this->sheetFilePointer);
203	84	}
204		}
205

box / spout

Push — master ( 435a9a...d4e57b )

Worksheet::getExternalSheet() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like