parsecsv/parsecsv-for-php
1
0
Fork 0
mirror of https://github.com/parsecsv/parsecsv-for-php.git synced 2026-02-19 00:36:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deprecate support for file paths in __construct() and parse()

Browse Source 
See https://github.com/parsecsv/parsecsv-for-php/issues/198
This commit is contained in:
Fonata
2021-04-02 20:12:00 +02:00
committed by Fonata
parent 9c5eee23f6
commit d1186fcafa
4 changed files with 69 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
ChangeLog.txt
View File

@@ -1,3 +1,19 @@
ParseCSV 1.3.0
-----------------------------------
Date: ?-Apr-2021
Breaking changes:
- Passing file paths to parse() or new Csv() is now deprecated
and will be removed in v2.0.0. Use ->parseFile() instead.
It will only call trigger_error() for now.
This change is to avoid security issues and to make this
library easier to learn (less magic).
New features: none
Bug fixes: none
-----------------------------------
ParseCSV 1.2.1
-----------------------------------
Date: 25-Apr-2020

14
README.md
View File

@@ -66,7 +66,7 @@ print_r($csv->data);
$csv = new \ParseCsv\Csv();
$csv->encoding('UTF-16', 'UTF-8');
$csv->delimiter = "\t";
$csv->parse('data.tsv');
$csv->parseFile('data.tsv');
print_r($csv->data);
```
@@ -83,7 +83,7 @@ print_r($csv->data);
```php
$csv = new \ParseCsv\Csv();
$csv->offset = 2;
$csv->parse('data.csv');
$csv->parseFile('data.csv');
print_r($csv->data);
```
@@ -91,7 +91,7 @@ print_r($csv->data);
```php
$csv = new \ParseCsv\Csv();
$csv->limit = 5;
$csv->parse('data.csv');
$csv->parseFile('data.csv');
print_r($csv->data);
```
@@ -99,7 +99,7 @@ print_r($csv->data);
* Excluding heading line if present (see $csv->header property)
```php
$csv = new \ParseCsv\Csv();
$csv->load_data('data.csv');
$csv->loadFile('data.csv');
$count = $csv->getTotalDataRowCount();
print_r($count);
```
@@ -118,7 +118,7 @@ Change data values:
```php
$csv = new \ParseCsv\Csv();
$csv->sort_by = 'id';
$csv->parse('data.csv');
$csv->parseFile('data.csv');
# "4" is the value of the "id" column of the CSV row
$csv->data[4] = array('firstname' => 'John', 'lastname' => 'Doe', 'email' => 'john@doe.com');
$csv->save();
@@ -127,7 +127,7 @@ $csv->save();
Enclose each data value by quotes:
```php
$csv = new \ParseCsv\Csv();
$csv->parse('data.csv');
$csv->parseFile('data.csv');
$csv->enclose_all = true;
$csv->save();
```
@@ -137,7 +137,7 @@ $csv->save();
```php
$csv = new \ParseCsv\Csv();
$csv->fields = ['id', 'name', 'category'];
$csv->parse('data.csv');
$csv->parseFile('data.csv');
```
**Add row/entry to end of CSV file**

54
src/Csv.php
View File

@@ -311,7 +311,9 @@ class Csv {
* Constructor
* Class constructor
*
* @param string|null $input The CSV string or a direct file path
* @param string|null $input The CSV string or a direct file path.
* Supplying file paths here is
* deprecated. Use parseFile() instead.
* @param int|null $offset Number of rows to ignore from the
* beginning of the data
* @param int|null $limit Limits the number of returned rows
@@ -368,6 +370,8 @@ class Csv {
* Parse a CSV file or string
*
* @param string|null $input The CSV string or a direct file path
* Supplying file paths here is
* deprecated.
* @param int|null $offset Number of rows to ignore from the
* beginning of the data
* @param int|null $limit Limits the number of returned rows to
@@ -379,7 +383,8 @@ class Csv {
*/
public function parse($input = null, $offset = null, $limit = null, $conditions = null) {
if (is_null($input)) {
$input = $this->file;
$this->data = $this->parseFile();
return $this->data !== false;
}
if (empty($input)) {
@@ -390,7 +395,13 @@ class Csv {
if (strlen($input) <= PHP_MAXPATHLEN && is_readable($input)) {
$this->file = $input;
$this->data = $this->_parse_file();
$this->data = $this->parseFile();
trigger_error(
'Supplying file paths to parse() will no longer ' .
'be supported in a future version of ParseCsv. ' .
'Use ->parseFile() instead.',
E_USER_DEPRECATED
);
} else {
$this->file = null;
$this->file_data = &$input;
@@ -588,11 +599,14 @@ class Csv {
* Parse File
* Read file to string and call _parse_string()
*
* @param string|null $file Local CSV file
* @param string|null $file Path to a CSV file.
* If configured in files such as php.ini,
* the path may also contain a protocol:
* https://example.org/some/file.csv
*
* @return array|bool
*/
protected function _parse_file($file = null) {
public function parseFile($file = null) {
if (is_null($file)) {
$file = $this->file;
}
@@ -914,7 +928,11 @@ class Csv {
* This function load_data() is able to handle BOMs and encodings. The data
* is stored within the $this->file_data class field.
*
* @param string|null $input local CSV file or CSV data as a string
* @param string|null $input CSV file path or CSV data as a string
*
* Supplying CSV data (file content) here is deprecated.
* For CSV data, please use parse().
* Support for CSV data will be removed in v2.0.0.
*
* @return bool True on success
*/
@@ -924,18 +942,30 @@ class Csv {
if (is_null($input)) {
$file = $this->file;
$data = $this->_rfile($file);
} elseif (\strlen($input) <= PHP_MAXPATHLEN && file_exists($input)) {
$file = $input;
} else {
// It is CSV data as a string.
$data = $input;
}
if (!empty($data) || $data = $this->_rfile($file)) {
$data = $this->_rfile($file);
if ($this->file != $file) {
$this->file = $file;
}
} else {
// It is CSV data as a string.
$data = $input;
trigger_error(
'Supplying CSV data to load_data() will no longer ' .
'be supported in a future version of ParseCsv. ' .
'This function will return false for invalid paths from v2.0.0 onwards. ' .
'Use ->loadDataString() instead.',
E_USER_DEPRECATED
);
}
return $this->loadDataString($data);
}
public function loadDataString($data) {
if (!empty($data)) {
if (strpos($data, "\xef\xbb\xbf") === 0) {
// strip off BOM (UTF-8)
$data = substr($data, 3);

8
tests/methods/DataRowCountTest.php
View File

@@ -60,15 +60,15 @@ class DataRowCountTest extends TestCase {
$this->csv->heading = false;
$this->csv->enclosure = '"';
$sInput = "86545235689,a\r\n34365587654,b\r\n13469874576,\"c\r\nd\"";
$this->csv->load_data($sInput);
$this->assertEquals(3, $this->csv->getTotalDataRowCount());
$this->csv->loadDataString($sInput);
self::assertEquals(3, $this->csv->getTotalDataRowCount());
}
public function testGetTotalRowCountSingleEnclosure() {
$this->csv->heading = false;
$this->csv->enclosure = "'";
$sInput = "86545235689,a\r\n34365587654,b\r\n13469874576,\'c\r\nd\'";
$this->csv->load_data($sInput);
$this->csv->loadDataString($sInput);
$this->assertEquals(3, $this->csv->getTotalDataRowCount());
}
@@ -76,7 +76,7 @@ class DataRowCountTest extends TestCase {
$this->csv->heading = false;
$this->csv->enclosure = "'";
$sInput = "86545235689";
$this->csv->load_data($sInput);
$this->csv->loadDataString($sInput);
$this->assertEquals(1, $this->csv->getTotalDataRowCount());
}
}