Csv::inferSeparator() - Code Metrics - Inspection of "In Xml reader throw exception in case of invalid X..." - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( febbe8...0477e6 )

by Adrien

created 2017-09-20 05:20 UTC

Csv::inferSeparator() F

↳ Parent: Csv

Complexity

Conditions	17
Paths	1041

Size

Total Lines	76
Code Lines	45

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	45
CRAP Score	17.0029

Importance

Changes

Metric	Value
cc	17
eloc	45
nc	1041
nop	0
dl	0
loc	76
ccs	45
cts	46
cp	0.9783
crap	17.0029
rs	2.2706
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

namespace PhpOffice\PhpSpreadsheet\Reader;

use PhpOffice\PhpSpreadsheet\Cell;
use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
use PhpOffice\PhpSpreadsheet\Spreadsheet;

/**
 * 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 BaseReader implements IReader
{
    /**
     * Input encoding.
     *
     * @var string
     */
    private $inputEncoding = 'UTF-8';

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

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

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

    /**
     * Load rows contiguously.
     *
     * @var bool
     */
    private $contiguous = false;

    /**
     * Row counter for loading rows contiguously.
     *
     * @var int
     */
    private $contiguousRow = -1;

    /**
     * Create a new CSV Reader instance.
     */
    public function __construct()
    {
        $this->readFilter = new DefaultReadFilter();
    }

    /**
     * Set input encoding.
     *
     * @param string $pValue Input encoding, eg: 'UTF-8'
     */
    public function setInputEncoding($pValue)
    {
        $this->inputEncoding = $pValue;

        return $this;
    }

    /**
     * Get input encoding.
     *
     * @return string
     */
    public function getInputEncoding()
    {
        return $this->inputEncoding;
    }

    /**
     * Move filepointer past any BOM marker.
     */
    protected function skipBOM()
    {
        rewind($this->fileHandle);

        switch ($this->inputEncoding) {
            case 'UTF-8':

                fgets($this->fileHandle, 4) == "\xEF\xBB\xBF" ?
                    fseek($this->fileHandle, 3) : fseek($this->fileHandle, 0);
                break;
            case 'UTF-16LE':

                fgets($this->fileHandle, 3) == "\xFF\xFE" ?
                    fseek($this->fileHandle, 2) : fseek($this->fileHandle, 0);
                break;
            case 'UTF-16BE':

                fgets($this->fileHandle, 3) == "\xFE\xFF" ?
                    fseek($this->fileHandle, 2) : fseek($this->fileHandle, 0);
                break;
            case 'UTF-32LE':

                fgets($this->fileHandle, 5) == "\xFF\xFE\x00\x00" ?
                    fseek($this->fileHandle, 4) : fseek($this->fileHandle, 0);
                break;
            case 'UTF-32BE':

                fgets($this->fileHandle, 5) == "\x00\x00\xFE\xFF" ?
                    fseek($this->fileHandle, 4) : fseek($this->fileHandle, 0);
                break;
            default:
                break;
        }
    }

    /**
     * Identify any separator that is explicitly set in the file.
     */
    protected function checkSeparator()
    {
        $line = fgets($this->fileHandle);
        if ($line === false) {
            return;
        }

        if ((strlen(trim($line, "\r\n")) == 5) && (stripos($line, 'sep=') === 0)) {
            $this->delimiter = substr($line, 4, 1);

            return;
        }

        return $this->skipBOM();
    }

    /**
     * Infer the separator if it isn't explicitly set in the file or specified by the user.
     */
    protected function inferSeparator()
    {
        if ($this->delimiter !== null) {
            return;
        }

        $potentialDelimiters = [',', ';', "\t", '|', ':', ' '];
        $counts = [];
        foreach ($potentialDelimiters as $delimiter) {
            $counts[$delimiter] = [];
        }

        // Count how many times each of the potential delimiters appears in each line
        $numberLines = 0;
        while (($line = fgets($this->fileHandle)) !== false && (++$numberLines < 1000)) {
            $countLine = [];
            for ($i = strlen($line) - 1; $i >= 0; --$i) {
                $char = $line[$i];
                if (isset($counts[$char])) {
                    if (!isset($countLine[$char])) {
                        $countLine[$char] = 0;
                    }
                    ++$countLine[$char];
                }
            }
            foreach ($potentialDelimiters as $delimiter) {
                $counts[$delimiter][] = isset($countLine[$delimiter])
                    ? $countLine[$delimiter]
                    : 0;
            }
        }

        // Calculate the mean square deviations for each delimiter (ignoring delimiters that haven't been found consistently)
        $meanSquareDeviations = [];
        $middleIdx = floor(($numberLines - 1) / 2);

        foreach ($potentialDelimiters as $delimiter) {
            $series = $counts[$delimiter];
            sort($series);

            $median = ($numberLines % 2)
                ? $series[$middleIdx]
                : ($series[$middleIdx] + $series[$middleIdx + 1]) / 2;

            if ($median === 0) {
                continue;
            }

            $meanSquareDeviations[$delimiter] = array_reduce(
                $series,
                function ($sum, $value) use ($median) {
                    return $sum + pow($value - $median, 2);
                }
            ) / count($series);
        }

        // ... and pick the delimiter with the smallest mean square deviation (in case of ties, the order in potentialDelimiters is respected)
        $min = INF;
        foreach ($potentialDelimiters as $delimiter) {
            if (!isset($meanSquareDeviations[$delimiter])) {
                continue;
            }

            if ($meanSquareDeviations[$delimiter] < $min) {
                $min = $meanSquareDeviations[$delimiter];
                $this->delimiter = $delimiter;
            }
        }

        // If no delimiter could be detected, fall back to the default
        if ($this->delimiter === null) {
            $this->delimiter = reset($potentialDelimiters);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        }

        return $this->skipBOM();
    }

    /**
     * Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns).
     *
     * @param string $pFilename
     *
     * @throws Exception
     */
    public function listWorksheetInfo($pFilename)
    {
        // Open file
        if (!$this->canRead($pFilename)) {
            throw new Exception($pFilename . ' is an Invalid Spreadsheet file.');
        }
        $this->openFile($pFilename);
        $fileHandle = $this->fileHandle;

        // Skip BOM, if any
        $this->skipBOM();
        $this->checkSeparator();
        $this->inferSeparator();

        $worksheetInfo = [];
        $worksheetInfo[0]['worksheetName'] = 'Worksheet';
        $worksheetInfo[0]['lastColumnLetter'] = 'A';
        $worksheetInfo[0]['lastColumnIndex'] = 0;
        $worksheetInfo[0]['totalRows'] = 0;
        $worksheetInfo[0]['totalColumns'] = 0;

        // Loop through each line of the file in turn
        while (($rowData = fgetcsv($fileHandle, 0, $this->delimiter, $this->enclosure)) !== false) {
            ++$worksheetInfo[0]['totalRows'];
            $worksheetInfo[0]['lastColumnIndex'] = max($worksheetInfo[0]['lastColumnIndex'], count($rowData) - 1);
        }

        $worksheetInfo[0]['lastColumnLetter'] = Cell::stringFromColumnIndex($worksheetInfo[0]['lastColumnIndex']);
        $worksheetInfo[0]['totalColumns'] = $worksheetInfo[0]['lastColumnIndex'] + 1;

        // Close file
        fclose($fileHandle);

        return $worksheetInfo;
    }

    /**
     * Loads Spreadsheet from file.
     *
     * @param string $pFilename
     *
     * @throws Exception
     *
     * @return Spreadsheet
     */
    public function load($pFilename)
    {
        // Create new Spreadsheet
        $spreadsheet = new Spreadsheet();

        // Load into this instance
        return $this->loadIntoExisting($pFilename, $spreadsheet);
    }

    /**
     * Loads PhpSpreadsheet from file into PhpSpreadsheet instance.
     *
     * @param string $pFilename
     * @param Spreadsheet $spreadsheet
     *
     * @throws Exception
     *
     * @return Spreadsheet
     */
    public function loadIntoExisting($pFilename, Spreadsheet $spreadsheet)
    {
        $lineEnding = ini_get('auto_detect_line_endings');
        ini_set('auto_detect_line_endings', true);

        // Open file
        if (!$this->canRead($pFilename)) {
            throw new Exception($pFilename . ' is an Invalid Spreadsheet file.');
        }
        $this->openFile($pFilename);
        $fileHandle = $this->fileHandle;

        // Skip BOM, if any
        $this->skipBOM();
        $this->checkSeparator();
        $this->inferSeparator();

        // Create new PhpSpreadsheet object
        while ($spreadsheet->getSheetCount() <= $this->sheetIndex) {
            $spreadsheet->createSheet();
        }
        $sheet = $spreadsheet->setActiveSheetIndex($this->sheetIndex);

        // Set our starting row based on whether we're in contiguous mode or not
        $currentRow = 1;
        if ($this->contiguous) {
            $currentRow = ($this->contiguousRow == -1) ? $sheet->getHighestRow() : $this->contiguousRow;
        }

        // Loop through each line of the file in turn
        while (($rowData = fgetcsv($fileHandle, 0, $this->delimiter, $this->enclosure)) !== false) {
            $columnLetter = 'A';
            foreach ($rowData as $rowDatum) {
                if ($rowDatum != '' && $this->readFilter->readCell($columnLetter, $currentRow)) {
                    // Convert encoding if necessary
                    if ($this->inputEncoding !== 'UTF-8') {
                        $rowDatum = StringHelper::convertEncoding($rowDatum, 'UTF-8', $this->inputEncoding);
                    }

                    // Set cell value
                    $sheet->getCell($columnLetter . $currentRow)->setValue($rowDatum);
                }
                ++$columnLetter;
            }
            ++$currentRow;
        }

        // Close file
        fclose($fileHandle);

        if ($this->contiguous) {
            $this->contiguousRow = $currentRow;
        }

        ini_set('auto_detect_line_endings', $lineEnding);

        // Return
        return $spreadsheet;
    }

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

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

        return $this;
    }

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

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

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

    /**
     * Set Contiguous.
     *
     * @param bool $contiguous
     */
    public function setContiguous($contiguous)
    {
        $this->contiguous = (bool) $contiguous;
        if (!$contiguous) {
            $this->contiguousRow = -1;
        }

        return $this;
    }

    /**
     * Get Contiguous.
     *
     * @return bool
     */
    public function getContiguous()
    {
        return $this->contiguous;
    }

    /**
     * Can the current IReader read the file?
     *
     * @param string $pFilename
     *
     * @throws Exception
     *
     * @return bool
     */
    public function canRead($pFilename)
    {
        // Check if file exists
        try {
            $this->openFile($pFilename);
        } catch (Exception $e) {
            return false;
        }

        fclose($this->fileHandle);

        return true;
    }
}


1			<?php
2
3			namespace PhpOffice\PhpSpreadsheet\Reader;
4
5			use PhpOffice\PhpSpreadsheet\Cell;
6			use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
7			use PhpOffice\PhpSpreadsheet\Spreadsheet;
8
9			/**
10			* Copyright (c) 2006 - 2016 PhpSpreadsheet.
11			*
12			* This library is free software; you can redistribute it and/or
13			* modify it under the terms of the GNU Lesser General Public
14			* License as published by the Free Software Foundation; either
15			* version 2.1 of the License, or (at your option) any later version.
16			*
17			* This library is distributed in the hope that it will be useful,
18			* but WITHOUT ANY WARRANTY; without even the implied warranty of
19			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20			* Lesser General Public License for more details.
21			*
22			* You should have received a copy of the GNU Lesser General Public
23			* License along with this library; if not, write to the Free Software
24			* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25			*
26			* @category PhpSpreadsheet
27			*
28			* @copyright Copyright (c) 2006 - 2016 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)
29			* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
30			*/
31			class Csv extends BaseReader implements IReader
32			{
33			/**
34			* Input encoding.
35			*
36			* @var string
37			*/
38			private $inputEncoding = 'UTF-8';
39
40			/**
41			* Delimiter.
42			*
43			* @var string
44			*/
45			private $delimiter = null;
46
47			/**
48			* Enclosure.
49			*
50			* @var string
51			*/
52			private $enclosure = '"';
53
54			/**
55			* Sheet index to read.
56			*
57			* @var int
58			*/
59			private $sheetIndex = 0;
60
61			/**
62			* Load rows contiguously.
63			*
64			* @var bool
65			*/
66			private $contiguous = false;
67
68			/**
69			* Row counter for loading rows contiguously.
70			*
71			* @var int
72			*/
73			private $contiguousRow = -1;
74
75			/**
76			* Create a new CSV Reader instance.
77			*/
78	3		public function __construct()
79			{
80	3		$this->readFilter = new DefaultReadFilter();
81	3		}
82
83			/**
84			* Set input encoding.
85			*
86			* @param string $pValue Input encoding, eg: 'UTF-8'
87			*/
88			public function setInputEncoding($pValue)
89			{
90			$this->inputEncoding = $pValue;
91
92			return $this;
93			}
94
95			/**
96			* Get input encoding.
97			*
98			* @return string
99			*/
100			public function getInputEncoding()
101			{
102			return $this->inputEncoding;
103			}
104
105			/**
106			* Move filepointer past any BOM marker.
107			*/
108	3		protected function skipBOM()
109			{
110	3		rewind($this->fileHandle);
111
112	3		switch ($this->inputEncoding) {
113	3	View Code Duplication	case 'UTF-8':
			0 ignored issues – show Duplication introduced 2016-08-14 05:24 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
114	3		fgets($this->fileHandle, 4) == "\xEF\xBB\xBF" ?
115	3		fseek($this->fileHandle, 3) : fseek($this->fileHandle, 0);
116	3		break;
117		View Code Duplication	case 'UTF-16LE':
			0 ignored issues – show Duplication introduced 2017-01-22 09:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
118			fgets($this->fileHandle, 3) == "\xFF\xFE" ?
119			fseek($this->fileHandle, 2) : fseek($this->fileHandle, 0);
120			break;
121		View Code Duplication	case 'UTF-16BE':
			0 ignored issues – show Duplication introduced 2017-01-22 09:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
122			fgets($this->fileHandle, 3) == "\xFE\xFF" ?
123			fseek($this->fileHandle, 2) : fseek($this->fileHandle, 0);
124			break;
125		View Code Duplication	case 'UTF-32LE':
			0 ignored issues – show Duplication introduced 2017-01-22 09:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
126			fgets($this->fileHandle, 5) == "\xFF\xFE\x00\x00" ?
127			fseek($this->fileHandle, 4) : fseek($this->fileHandle, 0);
128			break;
129		View Code Duplication	case 'UTF-32BE':
			0 ignored issues – show Duplication introduced 2017-01-22 09:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
130			fgets($this->fileHandle, 5) == "\x00\x00\xFE\xFF" ?
131			fseek($this->fileHandle, 4) : fseek($this->fileHandle, 0);
132			break;
133			default:
134			break;
135			}
136	3		}
137
138			/**
139			* Identify any separator that is explicitly set in the file.
140			*/
141	3		protected function checkSeparator()
142			{
143	3		$line = fgets($this->fileHandle);
144	3		if ($line === false) {
145			return;
146			}
147
148	3		if ((strlen(trim($line, "\r\n")) == 5) && (stripos($line, 'sep=') === 0)) {
149			$this->delimiter = substr($line, 4, 1);
150
151			return;
152			}
153
154	3		return $this->skipBOM();
155			}
156
157			/**
158			* Infer the separator if it isn't explicitly set in the file or specified by the user.
159			*/
160	3		protected function inferSeparator()
161			{
162	3		if ($this->delimiter !== null) {
163	1		return;
164			}
165
166	2		$potentialDelimiters = [',', ';', "\t", '\|', ':', ' '];
167	2		$counts = [];
168	2		foreach ($potentialDelimiters as $delimiter) {
169	2		$counts[$delimiter] = [];
170			}
171
172			// Count how many times each of the potential delimiters appears in each line
173	2		$numberLines = 0;
174	2		while (($line = fgets($this->fileHandle)) !== false && (++$numberLines < 1000)) {
175	2		$countLine = [];
176	2		for ($i = strlen($line) - 1; $i >= 0; --$i) {
177	2		$char = $line[$i];
178	2		if (isset($counts[$char])) {
179	2		if (!isset($countLine[$char])) {
180	2		$countLine[$char] = 0;
181			}
182	2		++$countLine[$char];
183			}
184			}
185	2		foreach ($potentialDelimiters as $delimiter) {
186	2		$counts[$delimiter][] = isset($countLine[$delimiter])
187	2		? $countLine[$delimiter]
188	2		: 0;
189			}
190			}
191
192			// Calculate the mean square deviations for each delimiter (ignoring delimiters that haven't been found consistently)
193	2		$meanSquareDeviations = [];
194	2		$middleIdx = floor(($numberLines - 1) / 2);
195
196	2		foreach ($potentialDelimiters as $delimiter) {
197	2		$series = $counts[$delimiter];
198	2		sort($series);
199
200	2		$median = ($numberLines % 2)
201	2		? $series[$middleIdx]
202	2		: ($series[$middleIdx] + $series[$middleIdx + 1]) / 2;
203
204	2		if ($median === 0) {
205	2		continue;
206			}
207
208	2		$meanSquareDeviations[$delimiter] = array_reduce(
209	2		$series,
210	2		function ($sum, $value) use ($median) {
211	2		return $sum + pow($value - $median, 2);
212	2		}
213	2		) / count($series);
214			}
215
216			// ... and pick the delimiter with the smallest mean square deviation (in case of ties, the order in potentialDelimiters is respected)
217	2		$min = INF;
218	2		foreach ($potentialDelimiters as $delimiter) {
219	2		if (!isset($meanSquareDeviations[$delimiter])) {
220	2		continue;
221			}
222
223	2		if ($meanSquareDeviations[$delimiter] < $min) {
224	2		$min = $meanSquareDeviations[$delimiter];
225	2		$this->delimiter = $delimiter;
226			}
227			}
228
229			// If no delimiter could be detected, fall back to the default
230	2		if ($this->delimiter === null) {
231			$this->delimiter = reset($potentialDelimiters);
			0 ignored issues – show Documentation Bug introduced 2017-04-19 06:56 UTC by Report Bug Copy Issue Report It seems like `reset($potentialDelimiters)` can also be of type `false`. However, the property `$delimiter` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
232			}
233
234	2		return $this->skipBOM();
235			}
236
237			/**
238			* Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns).
239			*
240			* @param string $pFilename
241			*
242			* @throws Exception
243			*/
244			public function listWorksheetInfo($pFilename)
245			{
246			// Open file
247			if (!$this->canRead($pFilename)) {
248			throw new Exception($pFilename . ' is an Invalid Spreadsheet file.');
249			}
250			$this->openFile($pFilename);
251			$fileHandle = $this->fileHandle;
252
253			// Skip BOM, if any
254			$this->skipBOM();
255			$this->checkSeparator();
256			$this->inferSeparator();
257
258			$worksheetInfo = [];
259			$worksheetInfo[0]['worksheetName'] = 'Worksheet';
260			$worksheetInfo[0]['lastColumnLetter'] = 'A';
261			$worksheetInfo[0]['lastColumnIndex'] = 0;
262			$worksheetInfo[0]['totalRows'] = 0;
263			$worksheetInfo[0]['totalColumns'] = 0;
264
265			// Loop through each line of the file in turn
266			while (($rowData = fgetcsv($fileHandle, 0, $this->delimiter, $this->enclosure)) !== false) {
267			++$worksheetInfo[0]['totalRows'];
268			$worksheetInfo[0]['lastColumnIndex'] = max($worksheetInfo[0]['lastColumnIndex'], count($rowData) - 1);
269			}
270
271			$worksheetInfo[0]['lastColumnLetter'] = Cell::stringFromColumnIndex($worksheetInfo[0]['lastColumnIndex']);
272			$worksheetInfo[0]['totalColumns'] = $worksheetInfo[0]['lastColumnIndex'] + 1;
273
274			// Close file
275			fclose($fileHandle);
276
277			return $worksheetInfo;
278			}
279
280			/**
281			* Loads Spreadsheet from file.
282			*
283			* @param string $pFilename
284			*
285			* @throws Exception
286			*
287			* @return Spreadsheet
288			*/
289	3		public function load($pFilename)
290			{
291			// Create new Spreadsheet
292	3		$spreadsheet = new Spreadsheet();
293
294			// Load into this instance
295	3		return $this->loadIntoExisting($pFilename, $spreadsheet);
296			}
297
298			/**
299			* Loads PhpSpreadsheet from file into PhpSpreadsheet instance.
300			*
301			* @param string $pFilename
302			* @param Spreadsheet $spreadsheet
303			*
304			* @throws Exception
305			*
306			* @return Spreadsheet
307			*/
308	3		public function loadIntoExisting($pFilename, Spreadsheet $spreadsheet)
309			{
310	3		$lineEnding = ini_get('auto_detect_line_endings');
311	3		ini_set('auto_detect_line_endings', true);
312
313			// Open file
314	3		if (!$this->canRead($pFilename)) {
315			throw new Exception($pFilename . ' is an Invalid Spreadsheet file.');
316			}
317	3		$this->openFile($pFilename);
318	3		$fileHandle = $this->fileHandle;
319
320			// Skip BOM, if any
321	3		$this->skipBOM();
322	3		$this->checkSeparator();
323	3		$this->inferSeparator();
324
325			// Create new PhpSpreadsheet object
326	3		while ($spreadsheet->getSheetCount() <= $this->sheetIndex) {
327			$spreadsheet->createSheet();
328			}
329	3		$sheet = $spreadsheet->setActiveSheetIndex($this->sheetIndex);
330
331			// Set our starting row based on whether we're in contiguous mode or not
332	3		$currentRow = 1;
333	3		if ($this->contiguous) {
334			$currentRow = ($this->contiguousRow == -1) ? $sheet->getHighestRow() : $this->contiguousRow;
335			}
336
337			// Loop through each line of the file in turn
338	3		while (($rowData = fgetcsv($fileHandle, 0, $this->delimiter, $this->enclosure)) !== false) {
339	3		$columnLetter = 'A';
340	3		foreach ($rowData as $rowDatum) {
341	3		if ($rowDatum != '' && $this->readFilter->readCell($columnLetter, $currentRow)) {
342			// Convert encoding if necessary
343	3		if ($this->inputEncoding !== 'UTF-8') {
344			$rowDatum = StringHelper::convertEncoding($rowDatum, 'UTF-8', $this->inputEncoding);
345			}
346
347			// Set cell value
348	3		$sheet->getCell($columnLetter . $currentRow)->setValue($rowDatum);
349			}
350	3		++$columnLetter;
351			}
352	3		++$currentRow;
353			}
354
355			// Close file
356	3		fclose($fileHandle);
357
358	3		if ($this->contiguous) {
359			$this->contiguousRow = $currentRow;
360			}
361
362	3		ini_set('auto_detect_line_endings', $lineEnding);
363
364			// Return
365	3		return $spreadsheet;
366			}
367
368			/**
369			* Get delimiter.
370			*
371			* @return string
372			*/
373	1		public function getDelimiter()
374			{
375	1		return $this->delimiter;
376			}
377
378			/**
379			* Set delimiter.
380			*
381			* @param string $delimiter Delimiter, eg: ','
382			*
383			* @return CSV
384			*/
385	1		public function setDelimiter($delimiter)
386			{
387	1		$this->delimiter = $delimiter;
388
389	1		return $this;
390			}
391
392			/**
393			* Get enclosure.
394			*
395			* @return string
396			*/
397			public function getEnclosure()
398			{
399			return $this->enclosure;
400			}
401
402			/**
403			* Set enclosure.
404			*
405			* @param string $enclosure Enclosure, defaults to "
406			*
407			* @return CSV
408			*/
409	1		public function setEnclosure($enclosure)
410			{
411	1		if ($enclosure == '') {
412			$enclosure = '"';
413			}
414	1		$this->enclosure = $enclosure;
415
416	1		return $this;
417			}
418
419			/**
420			* Get sheet index.
421			*
422			* @return int
423			*/
424			public function getSheetIndex()
425			{
426			return $this->sheetIndex;
427			}
428
429			/**
430			* Set sheet index.
431			*
432			* @param int $pValue Sheet index
433			*
434			* @return CSV
435			*/
436	1		public function setSheetIndex($pValue)
437			{
438	1		$this->sheetIndex = $pValue;
439
440	1		return $this;
441			}
442
443			/**
444			* Set Contiguous.
445			*
446			* @param bool $contiguous
447			*/
448			public function setContiguous($contiguous)
449			{
450			$this->contiguous = (bool) $contiguous;
451			if (!$contiguous) {
452			$this->contiguousRow = -1;
453			}
454
455			return $this;
456			}
457
458			/**
459			* Get Contiguous.
460			*
461			* @return bool
462			*/
463			public function getContiguous()
464			{
465			return $this->contiguous;
466			}
467
468			/**
469			* Can the current IReader read the file?
470			*
471			* @param string $pFilename
472			*
473			* @throws Exception
474			*
475			* @return bool
476			*/
477	3		public function canRead($pFilename)
478			{
479			// Check if file exists
480			try {
481	3		$this->openFile($pFilename);
482			} catch (Exception $e) {
483			return false;
484			}
485
486	3		fclose($this->fileHandle);
487
488	3		return true;
489			}
490			}
491

PHPOffice / PhpSpreadsheet

Push — develop ( febbe8...0477e6 )

Csv::inferSeparator() F

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like