Csv::getSheetIndex() - Code Metrics - Inspection of "Enforce writer parts parent to be concrete writer" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 3ee9cc...870d86 )

by Adrien

created 2017-04-21 05:49 UTC

Csv::getSheetIndex() A

↳ Parent: Csv

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace PhpOffice\PhpSpreadsheet\Writer;

/**
 * Copyright (c) 2006 - 2016 PhpSpreadsheet.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * @category   PhpSpreadsheet
 *
 * @copyright  Copyright (c) 2006 - 2016 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)
 * @license    http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt    LGPL
 */
class Csv extends BaseWriter implements IWriter
{
    /**
     * PhpSpreadsheet object.
     *
     * @var PhpSpreadsheet
     */
    private $spreadsheet;

    /**
     * Delimiter.
     *
     * @var string
     */
    private $delimiter = ',';

    /**
     * Enclosure.
     *
     * @var string
     */
    private $enclosure = '"';

    /**
     * Line ending.
     *
     * @var string
     */
    private $lineEnding = PHP_EOL;

    /**
     * Sheet index to write.
     *
     * @var int
     */
    private $sheetIndex = 0;

    /**
     * Whether to write a BOM (for UTF8).
     *
     * @var bool
     */
    private $useBOM = false;

    /**
     * Whether to write a Separator line as the first line of the file
     *     sep=x.
     *
     * @var bool
     */
    private $includeSeparatorLine = false;

    /**
     * Whether to write a fully Excel compatible CSV file.
     *
     * @var bool
     */
    private $excelCompatibility = false;

    /**
     * Create a new CSV.
     *
     * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet Spreadsheet object
     */
    public function __construct(\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet)
    {
        $this->spreadsheet = $spreadsheet;

    }

    /**
     * Save PhpSpreadsheet to file.
     *
     * @param string $pFilename
     *
     * @throws Exception
     */
    public function save($pFilename)
    {
        // Fetch sheet
        $sheet = $this->spreadsheet->getSheet($this->sheetIndex);

        $saveDebugLog = \PhpOffice\PhpSpreadsheet\Calculation::getInstance($this->spreadsheet)->getDebugLog()->getWriteDebugLog();
        \PhpOffice\PhpSpreadsheet\Calculation::getInstance($this->spreadsheet)->getDebugLog()->setWriteDebugLog(false);
        $saveArrayReturnType = \PhpOffice\PhpSpreadsheet\Calculation::getArrayReturnType();
        \PhpOffice\PhpSpreadsheet\Calculation::setArrayReturnType(\PhpOffice\PhpSpreadsheet\Calculation::RETURN_ARRAY_AS_VALUE);

        // Open file
        $fileHandle = fopen($pFilename, 'wb+');
        if ($fileHandle === false) {
            throw new Exception("Could not open file $pFilename for writing.");
        }

        if ($this->excelCompatibility) {
            $this->setUseBOM(true); //  Enforce UTF-8 BOM Header
            $this->setIncludeSeparatorLine(true); //  Set separator line
            $this->setEnclosure('"'); //  Set enclosure to "
            $this->setDelimiter(';'); //  Set delimiter to a semi-colon
            $this->setLineEnding("\r\n");
        }
        if ($this->useBOM) {
            // Write the UTF-8 BOM code if required
            fwrite($fileHandle, "\xEF\xBB\xBF");
        }
        if ($this->includeSeparatorLine) {
            // Write the separator line if required
            fwrite($fileHandle, 'sep=' . $this->getDelimiter() . $this->lineEnding);
        }

        //    Identify the range that we need to extract from the worksheet
        $maxCol = $sheet->getHighestDataColumn();
        $maxRow = $sheet->getHighestDataRow();

        // Write rows to file
        for ($row = 1; $row <= $maxRow; ++$row) {
            // Convert the row to an array...
            $cellsArray = $sheet->rangeToArray('A' . $row . ':' . $maxCol . $row, '', $this->preCalculateFormulas);
            // ... and write to the file
            $this->writeLine($fileHandle, $cellsArray[0]);
        }

        // Close file
        fclose($fileHandle);

        \PhpOffice\PhpSpreadsheet\Calculation::setArrayReturnType($saveArrayReturnType);
        \PhpOffice\PhpSpreadsheet\Calculation::getInstance($this->spreadsheet)->getDebugLog()->setWriteDebugLog($saveDebugLog);
    }

    /**
     * Get delimiter.
     *
     * @return string
     */
    public function getDelimiter()
    {
        return $this->delimiter;
    }

    /**
     * Set delimiter.
     *
     * @param string $pValue Delimiter, defaults to ','
     *
     * @return CSV
     */
    public function setDelimiter($pValue)
    {
        $this->delimiter = $pValue;

        return $this;
    }

    /**
     * Get enclosure.
     *
     * @return string
     */
    public function getEnclosure()
    {
        return $this->enclosure;
    }

    /**
     * Set enclosure.
     *
     * @param string $pValue Enclosure, defaults to "
     *
     * @return CSV
     */
    public function setEnclosure($pValue)
    {
        if ($pValue == '') {
            $pValue = null;
        }
        $this->enclosure = $pValue;

        return $this;
    }

    /**
     * Get line ending.
     *
     * @return string
     */
    public function getLineEnding()
    {
        return $this->lineEnding;
    }

    /**
     * Set line ending.
     *
     * @param string $pValue Line ending, defaults to OS line ending (PHP_EOL)
     *
     * @return CSV
     */
    public function setLineEnding($pValue)
    {
        $this->lineEnding = $pValue;

        return $this;
    }

    /**
     * Get whether BOM should be used.
     *
     * @return bool
     */
    public function getUseBOM()
    {
        return $this->useBOM;
    }

    /**
     * Set whether BOM should be used.
     *
     * @param bool $pValue Use UTF-8 byte-order mark? Defaults to false
     *
     * @return CSV
     */
    public function setUseBOM($pValue)
    {
        $this->useBOM = $pValue;

        return $this;
    }

    /**
     * Get whether a separator line should be included.
     *
     * @return bool
     */
    public function getIncludeSeparatorLine()
    {
        return $this->includeSeparatorLine;
    }

    /**
     * Set whether a separator line should be included as the first line of the file.
     *
     * @param bool $pValue Use separator line? Defaults to false
     *
     * @return CSV
     */
    public function setIncludeSeparatorLine($pValue)
    {
        $this->includeSeparatorLine = $pValue;

        return $this;
    }

    /**
     * Get whether the file should be saved with full Excel Compatibility.
     *
     * @return bool
     */
    public function getExcelCompatibility()
    {
        return $this->excelCompatibility;
    }

    /**
     * Set whether the file should be saved with full Excel Compatibility.
     *
     * @param bool $pValue Set the file to be written as a fully Excel compatible csv file
     *                                Note that this overrides other settings such as useBOM, enclosure and delimiter
     *
     * @return CSV
     */
    public function setExcelCompatibility($pValue)
    {
        $this->excelCompatibility = $pValue;

        return $this;
    }

    /**
     * Get sheet index.
     *
     * @return int
     */
    public function getSheetIndex()
    {
        return $this->sheetIndex;
    }

    /**
     * Set sheet index.
     *
     * @param int $pValue Sheet index
     *
     * @return CSV
     */
    public function setSheetIndex($pValue)
    {
        $this->sheetIndex = $pValue;

        return $this;
    }

    /**
     * Write line to CSV file.
     *
     * @param resource $pFileHandle PHP filehandle
     * @param array $pValues Array containing values in a row
     *
     * @throws Exception
     */
    private function writeLine($pFileHandle, array $pValues)
    {
        // No leading delimiter
        $writeDelimiter = false;

        // Build the line
        $line = '';

        foreach ($pValues as $element) {
            // Escape enclosures
            $element = str_replace($this->enclosure, $this->enclosure . $this->enclosure, $element);

            // Add delimiter
            if ($writeDelimiter) {
                $line .= $this->delimiter;
            } else {
                $writeDelimiter = true;
            }

            // Add enclosed string
            $line .= $this->enclosure . $element . $this->enclosure;
        }

        // Add line ending
        $line .= $this->lineEnding;

        // Write to file
        fwrite($pFileHandle, $line);
    }
}


1		<?php
2
3		namespace PhpOffice\PhpSpreadsheet\Writer;
4
5		/**
6		* Copyright (c) 2006 - 2016 PhpSpreadsheet.
7		*
8		* This library is free software; you can redistribute it and/or
9		* modify it under the terms of the GNU Lesser General Public
10		* License as published by the Free Software Foundation; either
11		* version 2.1 of the License, or (at your option) any later version.
12		*
13		* This library is distributed in the hope that it will be useful,
14		* but WITHOUT ANY WARRANTY; without even the implied warranty of
15		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16		* Lesser General Public License for more details.
17		*
18		* You should have received a copy of the GNU Lesser General Public
19		* License along with this library; if not, write to the Free Software
20		* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21		*
22		* @category PhpSpreadsheet
23		*
24		* @copyright Copyright (c) 2006 - 2016 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)
25		* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
26		*/
27		class Csv extends BaseWriter implements IWriter
28		{
29		/**
30		* PhpSpreadsheet object.
31		*
32		* @var PhpSpreadsheet
33		*/
34		private $spreadsheet;
35
36		/**
37		* Delimiter.
38		*
39		* @var string
40		*/
41		private $delimiter = ',';
42
43		/**
44		* Enclosure.
45		*
46		* @var string
47		*/
48		private $enclosure = '"';
49
50		/**
51		* Line ending.
52		*
53		* @var string
54		*/
55		private $lineEnding = PHP_EOL;
56
57		/**
58		* Sheet index to write.
59		*
60		* @var int
61		*/
62		private $sheetIndex = 0;
63
64		/**
65		* Whether to write a BOM (for UTF8).
66		*
67		* @var bool
68		*/
69		private $useBOM = false;
70
71		/**
72		* Whether to write a Separator line as the first line of the file
73		* sep=x.
74		*
75		* @var bool
76		*/
77		private $includeSeparatorLine = false;
78
79		/**
80		* Whether to write a fully Excel compatible CSV file.
81		*
82		* @var bool
83		*/
84		private $excelCompatibility = false;
85
86		/**
87		* Create a new CSV.
88		*
89		* @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet Spreadsheet object
90		*/
91	2	public function __construct(\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet)
92		{
93	2	$this->spreadsheet = $spreadsheet;
		0 ignored issues – show Documentation Bug introduced 2016-08-31 17:45 UTC by Report Bug Copy Issue Report It seems like `$spreadsheet` of type `object<PhpOffice\PhpSpreadsheet\Spreadsheet>` is incompatible with the declared type `object<PhpOffice\PhpSpre...\Writer\PhpSpreadsheet>` of property `$spreadsheet`. 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...
94	2	}
95
96		/**
97		* Save PhpSpreadsheet to file.
98		*
99		* @param string $pFilename
100		*
101		* @throws Exception
102		*/
103	2	public function save($pFilename)
104		{
105		// Fetch sheet
106	2	$sheet = $this->spreadsheet->getSheet($this->sheetIndex);
107
108	2	$saveDebugLog = \PhpOffice\PhpSpreadsheet\Calculation::getInstance($this->spreadsheet)->getDebugLog()->getWriteDebugLog();
109	2	\PhpOffice\PhpSpreadsheet\Calculation::getInstance($this->spreadsheet)->getDebugLog()->setWriteDebugLog(false);
110	2	$saveArrayReturnType = \PhpOffice\PhpSpreadsheet\Calculation::getArrayReturnType();
111	2	\PhpOffice\PhpSpreadsheet\Calculation::setArrayReturnType(\PhpOffice\PhpSpreadsheet\Calculation::RETURN_ARRAY_AS_VALUE);
112
113		// Open file
114	2	$fileHandle = fopen($pFilename, 'wb+');
115	2	if ($fileHandle === false) {
116		throw new Exception("Could not open file $pFilename for writing.");
117		}
118
119	2	if ($this->excelCompatibility) {
120		$this->setUseBOM(true); // Enforce UTF-8 BOM Header
121		$this->setIncludeSeparatorLine(true); // Set separator line
122		$this->setEnclosure('"'); // Set enclosure to "
123		$this->setDelimiter(';'); // Set delimiter to a semi-colon
124		$this->setLineEnding("\r\n");
125		}
126	2	if ($this->useBOM) {
127		// Write the UTF-8 BOM code if required
128	1	fwrite($fileHandle, "\xEF\xBB\xBF");
129		}
130	2	if ($this->includeSeparatorLine) {
131		// Write the separator line if required
132		fwrite($fileHandle, 'sep=' . $this->getDelimiter() . $this->lineEnding);
133		}
134
135		// Identify the range that we need to extract from the worksheet
136	2	$maxCol = $sheet->getHighestDataColumn();
137	2	$maxRow = $sheet->getHighestDataRow();
138
139		// Write rows to file
140	2	for ($row = 1; $row <= $maxRow; ++$row) {
141		// Convert the row to an array...
142	2	$cellsArray = $sheet->rangeToArray('A' . $row . ':' . $maxCol . $row, '', $this->preCalculateFormulas);
143		// ... and write to the file
144	2	$this->writeLine($fileHandle, $cellsArray[0]);
145		}
146
147		// Close file
148	2	fclose($fileHandle);
149
150	2	\PhpOffice\PhpSpreadsheet\Calculation::setArrayReturnType($saveArrayReturnType);
151	2	\PhpOffice\PhpSpreadsheet\Calculation::getInstance($this->spreadsheet)->getDebugLog()->setWriteDebugLog($saveDebugLog);
152	2	}
153
154		/**
155		* Get delimiter.
156		*
157		* @return string
158		*/
159		public function getDelimiter()
160		{
161		return $this->delimiter;
162		}
163
164		/**
165		* Set delimiter.
166		*
167		* @param string $pValue Delimiter, defaults to ','
168		*
169		* @return CSV
170		*/
171		public function setDelimiter($pValue)
172		{
173		$this->delimiter = $pValue;
174
175		return $this;
176		}
177
178		/**
179		* Get enclosure.
180		*
181		* @return string
182		*/
183		public function getEnclosure()
184		{
185		return $this->enclosure;
186		}
187
188		/**
189		* Set enclosure.
190		*
191		* @param string $pValue Enclosure, defaults to "
192		*
193		* @return CSV
194		*/
195		public function setEnclosure($pValue)
196		{
197		if ($pValue == '') {
198		$pValue = null;
199		}
200		$this->enclosure = $pValue;
201
202		return $this;
203		}
204
205		/**
206		* Get line ending.
207		*
208		* @return string
209		*/
210		public function getLineEnding()
211		{
212		return $this->lineEnding;
213		}
214
215		/**
216		* Set line ending.
217		*
218		* @param string $pValue Line ending, defaults to OS line ending (PHP_EOL)
219		*
220		* @return CSV
221		*/
222		public function setLineEnding($pValue)
223		{
224		$this->lineEnding = $pValue;
225
226		return $this;
227		}
228
229		/**
230		* Get whether BOM should be used.
231		*
232		* @return bool
233		*/
234		public function getUseBOM()
235		{
236		return $this->useBOM;
237		}
238
239		/**
240		* Set whether BOM should be used.
241		*
242		* @param bool $pValue Use UTF-8 byte-order mark? Defaults to false
243		*
244		* @return CSV
245		*/
246	1	public function setUseBOM($pValue)
247		{
248	1	$this->useBOM = $pValue;
249
250	1	return $this;
251		}
252
253		/**
254		* Get whether a separator line should be included.
255		*
256		* @return bool
257		*/
258		public function getIncludeSeparatorLine()
259		{
260		return $this->includeSeparatorLine;
261		}
262
263		/**
264		* Set whether a separator line should be included as the first line of the file.
265		*
266		* @param bool $pValue Use separator line? Defaults to false
267		*
268		* @return CSV
269		*/
270		public function setIncludeSeparatorLine($pValue)
271		{
272		$this->includeSeparatorLine = $pValue;
273
274		return $this;
275		}
276
277		/**
278		* Get whether the file should be saved with full Excel Compatibility.
279		*
280		* @return bool
281		*/
282		public function getExcelCompatibility()
283		{
284		return $this->excelCompatibility;
285		}
286
287		/**
288		* Set whether the file should be saved with full Excel Compatibility.
289		*
290		* @param bool $pValue Set the file to be written as a fully Excel compatible csv file
291		* Note that this overrides other settings such as useBOM, enclosure and delimiter
292		*
293		* @return CSV
294		*/
295		public function setExcelCompatibility($pValue)
296		{
297		$this->excelCompatibility = $pValue;
298
299		return $this;
300		}
301
302		/**
303		* Get sheet index.
304		*
305		* @return int
306		*/
307		public function getSheetIndex()
308		{
309		return $this->sheetIndex;
310		}
311
312		/**
313		* Set sheet index.
314		*
315		* @param int $pValue Sheet index
316		*
317		* @return CSV
318		*/
319		public function setSheetIndex($pValue)
320		{
321		$this->sheetIndex = $pValue;
322
323		return $this;
324		}
325
326		/**
327		* Write line to CSV file.
328		*
329		* @param resource $pFileHandle PHP filehandle
330		* @param array $pValues Array containing values in a row
331		*
332		* @throws Exception
333		*/
334	2	private function writeLine($pFileHandle, array $pValues)
335		{
336		// No leading delimiter
337	2	$writeDelimiter = false;
338
339		// Build the line
340	2	$line = '';
341
342	2	foreach ($pValues as $element) {
343		// Escape enclosures
344	2	$element = str_replace($this->enclosure, $this->enclosure . $this->enclosure, $element);
345
346		// Add delimiter
347	2	if ($writeDelimiter) {
348	1	$line .= $this->delimiter;
349		} else {
350	2	$writeDelimiter = true;
351		}
352
353		// Add enclosed string
354	2	$line .= $this->enclosure . $element . $this->enclosure;
355		}
356
357		// Add line ending
358	2	$line .= $this->lineEnding;
359
360		// Write to file
361	2	fwrite($pFileHandle, $line);
362	2	}
363		}
364

PHPOffice / PhpSpreadsheet

Push — develop ( 3ee9cc...870d86 )

Csv::getSheetIndex() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like