Csv::getUseBOM() - Code Metrics - Inspection of "CSV writer also use common code to open file" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5f413b...c72512 )

by Adrien

created 2020-05-17 09:59 UTC

Csv::getUseBOM() A

↳ Parent: Csv

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes

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

<?php

namespace PhpOffice\PhpSpreadsheet\Writer;

use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
use PhpOffice\PhpSpreadsheet\Spreadsheet;

class Csv extends BaseWriter
{
    /**
     * PhpSpreadsheet object.
     *
     * @var Spreadsheet
     */
    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 Spreadsheet $spreadsheet Spreadsheet object
     */
    public function __construct(Spreadsheet $spreadsheet)
    {
        $this->spreadsheet = $spreadsheet;
    }

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

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

        // Open file
        $this->openFileHandle($pFilename);

        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($this->fileHandle, "\xEF\xBB\xBF");
        }

        if ($this->includeSeparatorLine) {
            // Write the separator line if required
            fwrite($this->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($this->fileHandle, $cellsArray[0]);
        }

        $this->maybeCloseFileHandle();
        Calculation::setArrayReturnType($saveArrayReturnType);
        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 $this
     */
    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 $this
     */
    public function setEnclosure($pValue)
    {
        $this->enclosure = $pValue ? $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 $this
     */
    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 $this
     */
    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 $this
     */
    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 $this
     */
    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 $this
     */
    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
     */
    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		use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
6		use PhpOffice\PhpSpreadsheet\Spreadsheet;
7
8		class Csv extends BaseWriter
9		{
10		/**
11		* PhpSpreadsheet object.
12		*
13		* @var Spreadsheet
14		*/
15		private $spreadsheet;
16
17		/**
18		* Delimiter.
19		*
20		* @var string
21		*/
22		private $delimiter = ',';
23
24		/**
25		* Enclosure.
26		*
27		* @var string
28		*/
29		private $enclosure = '"';
30
31		/**
32		* Line ending.
33		*
34		* @var string
35		*/
36		private $lineEnding = PHP_EOL;
37
38		/**
39		* Sheet index to write.
40		*
41		* @var int
42		*/
43		private $sheetIndex = 0;
44
45		/**
46		* Whether to write a BOM (for UTF8).
47		*
48		* @var bool
49		*/
50		private $useBOM = false;
51
52		/**
53		* Whether to write a Separator line as the first line of the file
54		* sep=x.
55		*
56		* @var bool
57		*/
58		private $includeSeparatorLine = false;
59
60		/**
61		* Whether to write a fully Excel compatible CSV file.
62		*
63		* @var bool
64		*/
65		private $excelCompatibility = false;
66
67		/**
68		* Create a new CSV.
69		*
70		* @param Spreadsheet $spreadsheet Spreadsheet object
71		*/
72		public function __construct(Spreadsheet $spreadsheet)
73	8	{
74		$this->spreadsheet = $spreadsheet;
75	8	}
76	8
77		/**
78		* Save PhpSpreadsheet to file.
79		*
80		* @param resource\|string $pFilename
81		*/
82		public function save($pFilename)
83	6	{
84		// Fetch sheet
85		$sheet = $this->spreadsheet->getSheet($this->sheetIndex);
86	6
87		$saveDebugLog = Calculation::getInstance($this->spreadsheet)->getDebugLog()->getWriteDebugLog();
88	6	Calculation::getInstance($this->spreadsheet)->getDebugLog()->setWriteDebugLog(false);
89	6	$saveArrayReturnType = Calculation::getArrayReturnType();
90	6	Calculation::setArrayReturnType(Calculation::RETURN_ARRAY_AS_VALUE);
91	6
92		// Open file
93		$this->openFileHandle($pFilename);
94	6
95	1	if ($this->excelCompatibility) {
96	5	$this->setUseBOM(true); // Enforce UTF-8 BOM Header
97	1	$this->setIncludeSeparatorLine(true); // Set separator line
98		$this->setEnclosure('"'); // Set enclosure to "
99	4	$this->setDelimiter(';'); // Set delimiter to a semi-colon
100		$this->setLineEnding("\r\n");
101		}
102	6
103	1	if ($this->useBOM) {
104		// Write the UTF-8 BOM code if required
105		fwrite($this->fileHandle, "\xEF\xBB\xBF");
106	5	}
107	1
108	1	if ($this->includeSeparatorLine) {
109	1	// Write the separator line if required
110	1	fwrite($this->fileHandle, 'sep=' . $this->getDelimiter() . $this->lineEnding);
111	1	}
112
113	5	// Identify the range that we need to extract from the worksheet
114		$maxCol = $sheet->getHighestDataColumn();
115	2	$maxRow = $sheet->getHighestDataRow();
116
117	5	// Write rows to file
118		for ($row = 1; $row <= $maxRow; ++$row) {
119	1	// Convert the row to an array...
120		$cellsArray = $sheet->rangeToArray('A' . $row . ':' . $maxCol . $row, '', $this->preCalculateFormulas);
121		// ... and write to the file
122		$this->writeLine($this->fileHandle, $cellsArray[0]);
123	5	}
124	5
125		$this->maybeCloseFileHandle();
126		Calculation::setArrayReturnType($saveArrayReturnType);
127	5	Calculation::getInstance($this->spreadsheet)->getDebugLog()->setWriteDebugLog($saveDebugLog);
128		}
129	5
130		/**
131	5	* Get delimiter.
132		*
133		* @return string
134	5	*/
135	5	public function getDelimiter()
136	5	{
137		return $this->delimiter;
138		}
139
140		/**
141		* Set delimiter.
142		*
143	1	* @param string $pValue Delimiter, defaults to ','
144		*
145	1	* @return $this
146		*/
147		public function setDelimiter($pValue)
148		{
149		$this->delimiter = $pValue;
150
151		return $this;
152		}
153
154		/**
155	1	* Get enclosure.
156		*
157	1	* @return string
158		*/
159	1	public function getEnclosure()
160		{
161		return $this->enclosure;
162		}
163
164		/**
165		* Set enclosure.
166		*
167	1	* @param string $pValue Enclosure, defaults to "
168		*
169	1	* @return $this
170		*/
171		public function setEnclosure($pValue)
172		{
173		$this->enclosure = $pValue ? $pValue : '"';
174
175		return $this;
176		}
177
178		/**
179	2	* Get line ending.
180		*
181	2	* @return string
182		*/
183	2	public function getLineEnding()
184		{
185		return $this->lineEnding;
186		}
187
188		/**
189		* Set line ending.
190		*
191	1	* @param string $pValue Line ending, defaults to OS line ending (PHP_EOL)
192		*
193	1	* @return $this
194		*/
195		public function setLineEnding($pValue)
196		{
197		$this->lineEnding = $pValue;
198
199		return $this;
200		}
201
202		/**
203	1	* Get whether BOM should be used.
204		*
205	1	* @return bool
206		*/
207	1	public function getUseBOM()
208		{
209		return $this->useBOM;
210		}
211
212		/**
213		* Set whether BOM should be used.
214		*
215	1	* @param bool $pValue Use UTF-8 byte-order mark? Defaults to false
216		*
217	1	* @return $this
218		*/
219		public function setUseBOM($pValue)
220		{
221		$this->useBOM = $pValue;
222
223		return $this;
224		}
225
226		/**
227	2	* Get whether a separator line should be included.
228		*
229	2	* @return bool
230		*/
231	2	public function getIncludeSeparatorLine()
232		{
233		return $this->includeSeparatorLine;
234		}
235
236		/**
237		* Set whether a separator line should be included as the first line of the file.
238		*
239	1	* @param bool $pValue Use separator line? Defaults to false
240		*
241	1	* @return $this
242		*/
243		public function setIncludeSeparatorLine($pValue)
244		{
245		$this->includeSeparatorLine = $pValue;
246
247		return $this;
248		}
249
250		/**
251	1	* Get whether the file should be saved with full Excel Compatibility.
252		*
253	1	* @return bool
254		*/
255	1	public function getExcelCompatibility()
256		{
257		return $this->excelCompatibility;
258		}
259
260		/**
261		* Set whether the file should be saved with full Excel Compatibility.
262		*
263	1	* @param bool $pValue Set the file to be written as a fully Excel compatible csv file
264		* Note that this overrides other settings such as useBOM, enclosure and delimiter
265	1	*
266		* @return $this
267		*/
268		public function setExcelCompatibility($pValue)
269		{
270		$this->excelCompatibility = $pValue;
271
272		return $this;
273		}
274
275		/**
276	1	* Get sheet index.
277		*
278	1	* @return int
279		*/
280	1	public function getSheetIndex()
281		{
282		return $this->sheetIndex;
283		}
284
285		/**
286		* Set sheet index.
287		*
288	2	* @param int $pValue Sheet index
289		*
290	2	* @return $this
291		*/
292		public function setSheetIndex($pValue)
293		{
294		$this->sheetIndex = $pValue;
295
296		return $this;
297		}
298
299		/**
300	2	* Write line to CSV file.
301		*
302	2	* @param resource $pFileHandle PHP filehandle
303		* @param array $pValues Array containing values in a row
304	2	*/
305		private function writeLine($pFileHandle, array $pValues)
306		{
307		// No leading delimiter
308		$writeDelimiter = false;
309
310		// Build the line
311		$line = '';
312
313	5	foreach ($pValues as $element) {
314		// Escape enclosures
315		$element = str_replace($this->enclosure, $this->enclosure . $this->enclosure, $element);
316	5
317		// Add delimiter
318		if ($writeDelimiter) {
319	5	$line .= $this->delimiter;
320		} else {
321	5	$writeDelimiter = true;
322		}
323	5
324		// Add enclosed string
325		$line .= $this->enclosure . $element . $this->enclosure;
326	5	}
327	2
328		// Add line ending
329	5	$line .= $this->lineEnding;
330
331		// Write to file
332		fwrite($pFileHandle, $line);
333	5	}
334		}
335

PHPOffice / PhpSpreadsheet

Push — master ( 5f413b...c72512 )

Csv::getUseBOM() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like