ChangeLog: Added release date

Added test for the case of objects as cells

.editorconfig

@@ -13,3 +13,6 @@ insert_final_newline = true
 
 [composer.json]
 indent_size = 4
+
+[.travis.yml]
+indent_size = 2

.travis.yml

@@ -1,19 +1,27 @@
+dist: trusty
 language: php
+dist: trusty
 
 php:
-  - 7.2
+  - '7.4'
-  - 7.1
+  - '7.3'
-  - 7.0
+  - '7.2'
-  - 5.6
+  - '7.1'
-  - 5.5
+  - '7.0'
-  - 5.4
+  - '5.6'
+  - '5.5'
+
+before_install:
+  - composer update
 
 script:
-  - phpunit --version
+  - composer validate
-  - phpunit --configuration tests/phpunit.xml
+  - vendor/bin/phpunit --version
+  - vendor/bin/phpunit --configuration tests/phpunit.xml
 
 notifications:
   email:
-    - will.knauss@gmail.com
+    recipients:
-  on_success: never
+      - will.knauss@gmail.com
-  on_failure: always
+    on_success: never
+    on_failure: always

ChangeLog.txt

@@ -1,272 +1,348 @@
-ParseCSV 1.0.0
+ParseCSV 1.2.0
------------------------------------
+-----------------------------------
-Date: 3-March-2018
+Date: 07-Jan-2020
-
+
-- Renamed class from parseCSV to Csv and added name-
+Breaking changes: none
-  space "ParseCsv" for PSR compliance.
+
-
+New features:
-- Added support for MS Excel's "sep=" to detect the
+- Compatible with PHP 7.4. Thanks to @andreybolonin
-  delimiter (Issue #60).
+  @morrislaptop @martijnengler and @fjf2002.
-
+- unparse() now also understands $use_mb_convert_encoding.
-- Added data type detection - function getDatatypes()
+- Verbal condition operators are now allowed to contain
-  guesses the type of each column.
+  upper case letters, for example:
-
+  $csv->conditions = 'rating IS GREATER THAN 4';
-- MIME: output() sends correct MIME type to browser
+
-  if the separator is a tab tab (Issue #79).
+Bug fixes:
-
+-  All filter condition operators containing "is" or "equals"
-- Added support for mb_convert_encoding() instead of
+   were broken.
-  iconv() - see issue #109.
+
-
+Code quality:
-- A number of minor bug fixes - see GitHub issues.
+- Improved test coverage.
-
+-----------------------------------
-- Added many more unit tests.
+
-
+
------------------------------------
+ParseCSV 1.1.1
-
+-----------------------------------
-
+Date: 2-Feb-2019
-parseCSV 0.4.3 beta
+
------------------------------------
+Breaking changes: none
-Date: 1-July-2008
+
-
+New features: none
-- Issue #4. Added an option for setting sorting
+
-  type behavior when sorting data.
+Bug fixes:
-  Simply set $csv->sort_type to "regular", "numeric",
+- Function load_data: check length of input, prevents E_NOTICE
-  or "string".
+  if too long.
-
+- Fixed bugs in unparse().
-- Issue #6. Raw loaded file data is now cleared from
+
-  file_data property when it has been successfully
+Code quality:
-  parsed to keep parseCSV's memory footprint to a
+- Improved test coverage.
-  minimum. Specifically handy when using multiple
+-----------------------------------
-  instances of parseCSV to process large files.
+
-
+
------------------------------------
+ParseCSV 1.1.0
-
+-----------------------------------
-
+Date: 9-Aug-2018
-parseCSV 0.4.2 beta
+
------------------------------------
+Breaking changes:
-Date: 31-May-2008
+- Ignore entirely empty lines at the end of files
-
+  See https://github.com/parsecsv/parsecsv-for-php/pull/142
-- IMPORTANT! If you're using the output(),
+- Dropped support for PHP 5.4. Now, you need at leas PHP 5.5.
-  method please note that the first parameter
+- Fixed parse()'s return value: return true only if $data is useful.
-  has been completely removed as it was
+
-  technically just useless. Instead, the second
+New features:
-  parameter (filename) doubles as its replacement.
+- Added support for Laravel-style collections via the
-  Simply put, if filename is not set or null, the
+  new getCollection() function - see
-  output() method will not output a downloadable
+  https://github.com/parsecsv/parsecsv-for-php/pull/134
-  file. Please update your existing code
+- New function getTotalDataRowCount() - useful if
-  when using 0.4.2 and later :)
+  $limit is set - see pull request #122.
-
+- Added requires to keep Composer-free environments working.
-- Small fix to the headers sent by the output()
+
-  method.
+Bug fixes:
-
+- Better support for streams.
-- Added a download example using the output()
+  See https://github.com/parsecsv/parsecsv-for-php/pull/147
-  method to the examples folder.
+- Fixed output() with custom header.
-
+  See https://github.com/parsecsv/parsecsv-for-php/issues/132
------------------------------------
+- Fixed bug on _validate_fields_for_unparse() if titles property
-
+  is used instead of fields parameter for changing the titles for
-
+  unparsing.
-parseCSV 0.4.1 beta
+- Fixed bug in unparse() that caused incorrect column order
------------------------------------
+  (Issue #41).
-Date: 29-May-2008
+
-
+
-- Fixed a small bug in how the output() method
+Code quality:
-  handles input data.
+- Improved test coverage.
-
+-----------------------------------
------------------------------------
+
-
+
-
+ParseCSV 1.0.0
-parseCSV 0.4 beta
+-----------------------------------
------------------------------------
+Date: 3-March-2018
-Date: 11-Apr-2008
+
-
+- Renamed class from parseCSV to Csv and added name-
-- Error reporting for files/data which is corrupt
+  space "ParseCsv" for PSR compliance.
-  or has formatting errors like using double
+
-  quotes in a field without enclosing quotes. Or
+- Added support for MS Excel's "sep=" to detect the
-  not escaping double quotes with a second one.
+  delimiter (Issue #60).
-
+
-- parse() method does not require input anymore
+- Added data type detection - function getDatatypes()
-  if the "$object->file" property has been set.
+  guesses the type of each column.
-
+
-I'm calling this a beta release due to the heavy
+- MIME: output() sends correct MIME type to browser
-modifications to the core parsing logic required
+  if the separator is a tab char (Issue #79).
-for error reporting to work. I have tested the
+
-new code quite extensively, I'm fairly confident
+- Added support for mb_convert_encoding() instead of
-that it still parses exactly as it always has.
+  iconv() - see issue #109.
-
+
-The second reason I'm calling it a beta release
+- A number of minor bug fixes - see GitHub issues.
-is cause I'm sure the error reporting code will
+
-need more refinements and tweaks to detect more
+- Added many more unit tests.
-types of errors, as it's only picking two types
+
-or syntax errors right now. However, it seems
+-----------------------------------
-these two are the most common errors that you
+
-would be likely to come across.
+
-
+parseCSV 0.4.3 beta
------------------------------------
+-----------------------------------
-
+Date: 1-July-2008
-
+
-parseCSV 0.3.2
+- Issue #4. Added an option for setting sorting
------------------------------------
+  type behavior when sorting data.
-Date: 1-Apr-2008
+  Simply set $csv->sort_type to "regular", "numeric",
-
+  or "string".
-This is primarily a bug-fix release for a critical
+
-bug which was brought to my attention.
+- Issue #6. Raw loaded file data is now cleared from
-
+  file_data property when it has been successfully
-- Fixed a critical bug in conditions parsing which
+  parsed to keep parseCSV's memory footprint to a
-  would generate corrupt matching patterns causing
+  minimum. Specifically handy when using multiple
-  the condition(s) to not work at all in some
+  instances of parseCSV to process large files.
-  situations.
+
-
+-----------------------------------
-- Fixed a small code error which would cause PHP to
+
-  generate a invalid offset notice when zero length
+
-  values were fed into the unparse() method to
+parseCSV 0.4.2 beta
-  generate CSV data from an array.
+-----------------------------------
-
+Date: 31-May-2008
-Notice: If you have been using the "parsecsv-stable"
+
-branch as an external in any of your projects,
+- IMPORTANT! If you're using the output(),
-please use the "stable/parsecsv" branch from this
+  method please note that the first parameter
-point on as I will eventually remove the former due
+  has been completely removed as it was
-to it's stupid naming.
+  technically just useless. Instead, the second
-
+  parameter (filename) doubles as its replacement.
------------------------------------
+  Simply put, if filename is not set or null, the
-
+  output() method will not output a downloadable
-
+  file. Please update your existing code
-parseCSV 0.3.1
+  when using 0.4.2 and later :)
------------------------------------
+
-Date: 1-Sep-2007
+- Small fix to the headers sent by the output()
-
+  method.
-- Small change to default output settings to
+
-  conform with RFC 4180 (http://rfc.net/rfc4180.html).
+- Added a download example using the output()
-  Only the LF (line feed) character was used
+  method to the examples folder.
-  by default to separate rows, rather than
+
-  CRLF (carriage return & line feed).
+-----------------------------------
-
+
------------------------------------
+
-
+parseCSV 0.4.1 beta
-
+-----------------------------------
-parseCSV 0.3.0
+Date: 29-May-2008
------------------------------------
+
-Date: 9-Aug-2007
+- Fixed a small bug in how the output() method
-
+  handles input data.
-- Changed to the MIT license.
+
-
+-----------------------------------
-- Added offset and limit options.
+
-
+
-- Added SQL-like conditions for quickly
+parseCSV 0.4 beta
-  filtering out entries. Documentation on the
+-----------------------------------
-  condition syntax is forthcoming.
+Date: 11-Apr-2008
-
+
-- Small parsing modification to comply
+- Error reporting for files/data which is corrupt
-  with some recent changes to the specifications
+  or has formatting errors like using double
-  outlined on Wikipedia's Comma-separated values
+  quotes in a field without enclosing quotes. Or
-  article.
+  not escaping double quotes with a second one.
-
+
-- Minor changes and optimizations, and a few
+- parse() method does not require input anymore
-  spelling corrections. Oops :)
+  if the "$object->file" property has been set.
-
+
-- Included more complex code examples in the
+I'm calling this a beta release due to the heavy
-  parseCSV download.
+modifications to the core parsing logic required
-
+for error reporting to work. I have tested the
------------------------------------
+new code quite extensively, I'm fairly confident
-
+that it still parses exactly as it always has.
-
+
-parseCSV 0.2.1
+The second reason I'm calling it a beta release
------------------------------------
+is cause I'm sure the error reporting code will
-Date: 8-Aug-2007
+need more refinements and tweaks to detect more
-
+types of errors, as it's only picking two types
-- Fixed stupid code which caused auto function
+or syntax errors right now. However, it seems
-  to not work in some situations.
+these two are the most common errors that you
-
+would be likely to come across.
------------------------------------
+
-
+-----------------------------------
-
+
-parseCSV 0.2.0 beta
+
------------------------------------
+parseCSV 0.3.2
-Date: 2-Jan-2007
+-----------------------------------
-
+Date: 1-Apr-2008
-- Added auto() function to automatically detect
+
-  delimiter character.
+This is primarily a bug-fix release for a critical
-  Useful for user upload in case delimiter is
+bug which was brought to my attention.
-  comma (,), tab, or semi-colon (;). Some
+
-  versions of MS Excel for Windows use
+- Fixed a critical bug in conditions parsing which
-  semi-colons instead of commas when saving to
+  would generate corrupt matching patterns causing
-  CSV files.
+  the condition(s) to not work at all in some
-  It uses a process of elimination to eliminate
+  situations.
-  characters that can not be the delimiter,
+
-  so it should work on all CSV-structured files
+- Fixed a small code error which would cause PHP to
-  almost no matter what the delimiter is.
+  generate a invalid offset notice when zero length
-
+  values were fed into the unparse() method to
-- Generally updated some of the core workings
+  generate CSV data from an array.
-  to increase performance, and offer better
+
-  support for large (1MB and up) files.
+Notice: If you have been using the "parsecsv-stable"
-
+branch as an external in any of your projects,
-- Added code examples to header comment.
+please use the "stable/parsecsv" branch from this
-
+point on as I will eventually remove the former due
------------------------------------
+to it's stupid naming.
-
+
-
+-----------------------------------
-parseCSV 0.1.6 beta
+
------------------------------------
+
-Date: 22-Dec-2006
+parseCSV 0.3.1
-
+-----------------------------------
-- Updated output() function.
+Date: 1-Sep-2007
-
+
------------------------------------
+- Small change to default output settings to
-
+  conform with RFC 4180 (http://rfc.net/rfc4180.html).
-
+  Only the LF (line feed) character was used
-parseCSV 0.1.5 beta
+  by default to separate rows, rather than
------------------------------------
+  CRLF (carriage return & line feed).
-Date: 22-Dec-2006
+
-
+-----------------------------------
-- Added output() function for easy output to
+
-  browser, for downloading features for example.
+
-
+parseCSV 0.3.0
------------------------------------
+-----------------------------------
-
+Date: 9-Aug-2007
-
+
-parseCSV 0.1.4 beta
+- Changed to the MIT license.
------------------------------------
+
-Date: 17-Dec-2006
+- Added offset and limit options.
-
+
-- Minor changes and fixes
+- Added SQL-like conditions for quickly
-
+  filtering out entries. Documentation on the
------------------------------------
+  condition syntax is forthcoming.
-
+
-
+- Small parsing modification to comply
-parseCSV 0.1.3 beta
+  with some recent changes to the specifications
------------------------------------
+  outlined on Wikipedia's Comma-separated values
-Date: 17-Dec-2006
+  article.
-
+
-- Added GPL v2.0 license.
+- Minor changes and optimizations, and a few
-
+  spelling corrections. Oops :)
------------------------------------
+
-
+- Included more complex code examples in the
-
+  parseCSV download.
-parseCSV 0.1.2 beta
+
------------------------------------
+-----------------------------------
-Date: 17-Dec-2006
+
-
+
-- Added encoding() function for easier character
+parseCSV 0.2.1
-  encoding configuration.
+-----------------------------------
-
+Date: 8-Aug-2007
------------------------------------
+
-
+- Fixed stupid code which caused auto function
-
+  to not work in some situations.
-parseCSV 0.1.1 beta
+
------------------------------------
+-----------------------------------
-Date: 24-Nov-2006
+
-
+
-- Added support for a PHP die command on first
+parseCSV 0.2.0 beta
-  line of csv files if they have a .php extension
+-----------------------------------
-  to protect secure data from being displayed
+Date: 2-Jan-2007
-  directly to the browser.
+
-
+- Added auto() function to automatically detect
------------------------------------
+  delimiter character.
-
+  Useful for user upload in case delimiter is
-
+  comma (,), tab, or semi-colon (;). Some
-parseCSV 0.1 beta
+  versions of MS Excel for Windows use
------------------------------------
+  semi-colons instead of commas when saving to
-Date: 23-Nov-2006
+  CSV files.
-
+  It uses a process of elimination to eliminate
-- Initial release
+  characters that can not be the delimiter,
-
+  so it should work on all CSV-structured files
------------------------------------
+  almost no matter what the delimiter is.
+
+- Generally updated some of the core workings
+  to increase performance, and offer better
+  support for large (1MB and up) files.
+
+- Added code examples to header comment.
+
+-----------------------------------
+
+
+parseCSV 0.1.6 beta
+-----------------------------------
+Date: 22-Dec-2006
+
+- Updated output() function.
+
+-----------------------------------
+
+
+parseCSV 0.1.5 beta
+-----------------------------------
+Date: 22-Dec-2006
+
+- Added output() function for easy output to
+  browser, for downloading features for example.
+
+-----------------------------------
+
+
+parseCSV 0.1.4 beta
+-----------------------------------
+Date: 17-Dec-2006
+
+- Minor changes and fixes
+
+-----------------------------------
+
+
+parseCSV 0.1.3 beta
+-----------------------------------
+Date: 17-Dec-2006
+
+- Added GPL v2.0 license.
+
+-----------------------------------
+
+
+parseCSV 0.1.2 beta
+-----------------------------------
+Date: 17-Dec-2006
+
+- Added encoding() function for easier character
+  encoding configuration.
+
+-----------------------------------
+
+
+parseCSV 0.1.1 beta
+-----------------------------------
+Date: 24-Nov-2006
+
+- Added support for a PHP die command on first
+  line of csv files if they have a .php extension
+  to protect secure data from being displayed
+  directly to the browser.
+
+-----------------------------------
+
+
+parseCSV 0.1 beta
+-----------------------------------
+Date: 23-Nov-2006
+
+- Initial release
+
+-----------------------------------

README.md

@@ -1,4 +1,5 @@
 # ParseCsv
+[![Financial Contributors on Open Collective](https://opencollective.com/parsecsv/all/badge.svg?label=financial+contributors)](https://opencollective.com/parsecsv) 
 
 ParseCsv is an easy-to-use PHP class that reads and writes CSV data properly. It
 fully conforms to the specifications outlined on the on the
@@ -26,7 +27,7 @@ and third-party support for handling CSV data in PHP.
   how different programs like Excel for example outputs CSV data.
 * Support for character encoding conversion using PHP's
   `iconv()` and `mb_convert_encoding()` functions.
-* Supports PHP 5.4 and higher.
+* Supports PHP 5.5 and higher.
   It certainly works with PHP 7.2 and all versions in between.
 
 ## Installation
@@ -77,8 +78,43 @@ $csv->auto('data.csv');
 print_r($csv->data);
 ```
 
+**Parse data with offset**
+* ignoring the first X (e.g. two) rows
+```php
+$csv = new ParseCsv\Csv();
+$csv->offset = 2;
+$csv->parse('data.csv');
+print_r($csv->data);
+```
+
+**Limit the number of returned data rows**
+```php
+$csv = new ParseCsv\Csv();
+$csv->limit = 5;
+$csv->parse('data.csv');
+print_r($csv->data);
+```
+
+**Get total number of data rows without parsing whole data**
+* Excluding heading line if present (see $csv->header property)
+```php
+$csv = new ParseCsv\Csv();
+$csv->load_data('data.csv');
+$count = $csv->getTotalDataRowCount();
+print_r($count);
+```
+
+**Get most common data type for each column (Requires PHP >= 5.5)**
+
+```php
+$csv = new ParseCsv\Csv('data.csv');
+$csv->getDatatypes()
+print_r($csv->data_types);
+```
+
 **Modify data in a CSV file**
 
+Change data values:
 ```php
 $csv = new ParseCsv\Csv();
 $csv->sort_by = 'id';
@@ -88,6 +124,14 @@ $csv->data[4] = array('firstname' => 'John', 'lastname' => 'Doe', 'email' => 'jo
 $csv->save();
 ```
 
+Enclose each data value by quotes:
+```php
+$csv = new ParseCsv\Csv();
+$csv->parse('data.csv');
+$csv->enclose_all = true;
+$csv->save();
+```
+
 **Replace field names or set ones if missing**
 
 ```php
@@ -132,6 +176,36 @@ Please find a complete list on the project's [contributors][] page.
 
 
 
+## Contributors
+
+### Code Contributors
+
+This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
+<a href="https://github.com/parsecsv/parsecsv-for-php/graphs/contributors"><img src="https://opencollective.com/parsecsv/contributors.svg?width=890&button=false" /></a>
+
+### Financial Contributors
+
+Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/parsecsv/contribute)]
+
+#### Individuals
+
+<a href="https://opencollective.com/parsecsv"><img src="https://opencollective.com/parsecsv/individuals.svg?width=890"></a>
+
+#### Organizations
+
+Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/parsecsv/contribute)]
+
+<a href="https://opencollective.com/parsecsv/organization/0/website"><img src="https://opencollective.com/parsecsv/organization/0/avatar.svg"></a>
+<a href="https://opencollective.com/parsecsv/organization/1/website"><img src="https://opencollective.com/parsecsv/organization/1/avatar.svg"></a>
+<a href="https://opencollective.com/parsecsv/organization/2/website"><img src="https://opencollective.com/parsecsv/organization/2/avatar.svg"></a>
+<a href="https://opencollective.com/parsecsv/organization/3/website"><img src="https://opencollective.com/parsecsv/organization/3/avatar.svg"></a>
+<a href="https://opencollective.com/parsecsv/organization/4/website"><img src="https://opencollective.com/parsecsv/organization/4/avatar.svg"></a>
+<a href="https://opencollective.com/parsecsv/organization/5/website"><img src="https://opencollective.com/parsecsv/organization/5/avatar.svg"></a>
+<a href="https://opencollective.com/parsecsv/organization/6/website"><img src="https://opencollective.com/parsecsv/organization/6/avatar.svg"></a>
+<a href="https://opencollective.com/parsecsv/organization/7/website"><img src="https://opencollective.com/parsecsv/organization/7/avatar.svg"></a>
+<a href="https://opencollective.com/parsecsv/organization/8/website"><img src="https://opencollective.com/parsecsv/organization/8/avatar.svg"></a>
+<a href="https://opencollective.com/parsecsv/organization/9/website"><img src="https://opencollective.com/parsecsv/organization/9/avatar.svg"></a>
+
 ## License
 
 (The MIT license)

composer.json

@@ -10,21 +10,42 @@
         {
             "name": "William Knauss",
             "email": "will.knauss@gmail.com"
+        },
+        {
+            "name": "Susann Sgorzaly",
+            "homepage": "https://github.com/susgo"
+        },
+        {
+            "name": "Christian Bläul",
+            "homepage": "https://github.com/Fonata"
         }
     ],
-    "autoload":{
+    "autoload": {
-        "psr-4":{
+        "psr-4": {
-            "ParseCsv\\": "src",
+            "ParseCsv\\": "src"
-            "ParseCsv\\extensions\\": "src\\extensions",
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
             "ParseCsv\\tests\\": "tests"
         }
     },
-    "autoload-dev":{
+    "require": {
-        "psr-4":{
+        "php": ">=5.5"
-            "ParseCsv\\tests\\": "tests"
-        }
     },
     "require-dev": {
         "phpunit/phpunit": "4.1.*"
+    },
+    "suggest": {
+        "illuminate/support": "Fluent array interface for map functions"
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.0.x-dev"
+        }
+    },
+    "support": {
+        "issues": "https://github.com/parsecsv/parsecsv-for-php/issues",
+        "source": "https://github.com/parsecsv/parsecsv-for-php"
     }
 }

examples/basic.php

@@ -3,6 +3,7 @@
 
 # include parseCSV class.
 require __DIR__ . '/../vendor/autoload.php';
+
 use ParseCsv\Csv;
 
 
@@ -40,7 +41,7 @@ $csv->auto('_books.csv');
         background-color: #FFF;
     }
 </style>
-<table border="0" cellspacing="1" cellpadding="3">
+<table>
     <tr>
         <?php foreach ($csv->titles as $value): ?>
             <th><?php echo $value; ?></th>

examples/conditions.php

@@ -4,6 +4,7 @@
 
 # include parseCSV class.
 require __DIR__ . '/../vendor/autoload.php';
+
 use ParseCsv\Csv;
 
 
@@ -16,6 +17,7 @@ $csv = new Csv();
 $csv->conditions = 'author does not contain dan brown';
 // $csv->conditions = 'rating < 4 OR author is John Twelve Hawks';
 // $csv->conditions = 'rating > 4 AND author is Dan Brown';
+// $csv->conditions = 'rating is greater than 4';
 
 
 # Parse '_books.csv' using automatic delimiter detection.
@@ -41,7 +43,7 @@ $csv->auto('_books.csv');
         background-color: #FFF;
     }
 </style>
-<table border="0" cellspacing="1" cellpadding="3">
+<table>
     <tr>
         <?php foreach ($csv->titles as $value): ?>
             <th><?php echo $value; ?></th>

examples/download.php

@@ -3,6 +3,7 @@
 
 # include parseCSV class.
 require __DIR__ . '/../vendor/autoload.php';
+
 use ParseCsv\Csv;
 
 
@@ -31,5 +32,3 @@ $csv->output('books.csv');
 # data to download the output as a CSV file. if it's not set
 # or is set to null, output will only return the generated CSV
 # output data, and will not output to the browser itself.
-
-?>

examples/limit.php

@@ -4,6 +4,7 @@
 
 # include parseCSV class.
 require __DIR__ . '/../vendor/autoload.php';
+
 use ParseCsv\Csv;
 
 
@@ -54,7 +55,7 @@ $csv->auto('_books.csv');
         background-color: #FFF;
     }
 </style>
-<table border="0" cellspacing="1" cellpadding="3">
+<table>
     <tr>
         <?php foreach ($csv->titles as $value): ?>
             <th><?php echo $value; ?></th>

examples/save_to_file_without_header_row.php

@@ -0,0 +1,27 @@
+<?php
+
+
+# include parseCSV class.
+require __DIR__ . '/../vendor/autoload.php';
+
+use ParseCsv\Csv;
+
+
+# Create new parseCSV object.
+$csv = new Csv();
+
+# When saving, don't write the header row:
+$csv->heading = false;
+
+# Specify which columns to write, and in which order.
+# We won't output the 'Awesome' column this time.
+$csv->titles = ['Age', 'Name'];
+
+# Data to write:
+$csv->data = [
+    0 => ['Name' => 'Anne', 'Age' => 45, 'Awesome' => true],
+    1 => ['Name' => 'John', 'Age' => 44, 'Awesome' => false],
+];
+
+# Then we save the file to the file system:
+$csv->save('people.csv');

parsecsv.lib.php

@@ -6,6 +6,10 @@
 
 // Check if people used Composer to include this project in theirs
 if (!file_exists(__DIR__ . '/vendor/autoload.php')) {
+    require __DIR__ . '/src/enums/AbstractEnum.php';
+    require __DIR__ . '/src/enums/DatatypeEnum.php';
+    require __DIR__ . '/src/enums/FileProcessingModeEnum.php';
+    require __DIR__ . '/src/enums/SortEnum.php';
     require __DIR__ . '/src/extensions/DatatypeTrait.php';
     require __DIR__ . '/src/Csv.php';
 } else {

src/Csv.php

@@ -2,12 +2,14 @@
 
 namespace ParseCsv;
 
+use Illuminate\Support\Collection;
+use ParseCsv\enums\FileProcessingModeEnum;
+use ParseCsv\enums\SortEnum;
 use ParseCsv\extensions\DatatypeTrait;
 
 class Csv {
 
     /*
-    Class: ParseCSV 1.0.0
     https://github.com/parsecsv/parsecsv-for-php
 
     Fully conforms to the specifications lined out on Wikipedia:
@@ -16,7 +18,6 @@ class Csv {
     Based on the concept of Ming Hong Ng's CsvFileParser class:
     - http://minghong.blogspot.com/2006/07/csv-parser-for-php.html
 
-
     (The MIT license)
 
     Copyright (c) 2014 Jim Myhrberg.
@@ -89,7 +90,7 @@ class Csv {
      *
      * @var string|null
      */
-    public $sort_type = null;
+    public $sort_type = SortEnum::SORT_TYPE_REGULAR;
 
     /**
      * Delimiter
@@ -125,7 +126,9 @@ class Csv {
 
     /**
      * Offset
-     * Number of rows to ignore from beginning of data
+     * Number of rows to ignore from beginning of data. If present, the heading
+     * row is also counted (if $this->heading == true). In other words,
+     * $offset == 1 and $offset == 0 have the same meaning in that situation.
      *
      * @var int|null
      */
@@ -148,7 +151,7 @@ class Csv {
     public $auto_depth = 15;
 
     /**
-     * Auto Non Charts
+     * Auto Non Chars
      * Characters that should be ignored when attempting to auto-detect delimiter
      *
      * @var string
@@ -166,7 +169,7 @@ class Csv {
 
     /**
      * Convert Encoding
-     * Should we convert the csv encoding?
+     * Should we convert the CSV character encoding?
      *
      * @var bool
      */
@@ -275,8 +278,20 @@ class Csv {
     public $error_info = array();
 
     /**
-     * Titles
+     * $titles has 4 distinct tasks:
-     * CSV titles if they exists
+     * 1. After reading in CSV data, $titles will contain the column headers
+     *    present in the data.
+     *
+     * 2. It defines which fields from the $data array to write e.g. when
+     *    calling unparse(), and in which order. This lets you skip columns you
+     *    don't want in your output, but are present in $data.
+     *    See examples/save_to_file_without_header_row.php.
+     *
+     * 3. It lets you rename columns. See StreamTest::testWriteStream for an
+     *    example.
+     *
+     * 4. When writing data and $header is true, then $titles is also used for
+     *    the first row.
      *
      * @var array
      */
@@ -284,7 +299,7 @@ class Csv {
 
     /**
      * Data
-     * Two dimensional array of CSV data
+     * Two-dimensional array of CSV data
      *
      * @var array
      */
@@ -296,13 +311,37 @@ class Csv {
      * Constructor
      * Class constructor
      *
-     * @param  string|null  $input          The CSV string or a direct filepath
+     * @param string|null  $input           The CSV string or a direct file path
-     * @param  integer|null $offset         Number of rows to ignore from the beginning of  the data
+     * @param integer|null $offset          Number of rows to ignore from the
-     * @param  integer|null $limit          Limits the number of returned rows to specified amount
+     *                                      beginning of  the data
-     * @param  string|null  $conditions     Basic SQL-like conditions for row matching
+     * @param integer|null $limit           Limits the number of returned rows
-     * @param  null|true    $keep_file_data Keep raw file data in memory after successful parsing (useful for debugging)
+     *                                      to specified amount
+     * @param string|null  $conditions      Basic SQL-like conditions for row
+     *                                      matching
+     * @param null|true    $keep_file_data  Keep raw file data in memory after
+     *                                      successful parsing
+     *                                      (useful for debugging)
      */
     public function __construct($input = null, $offset = null, $limit = null, $conditions = null, $keep_file_data = null) {
+        $this->init($offset, $limit, $conditions, $keep_file_data);
+
+        if (!empty($input)) {
+            $this->parse($input);
+        }
+    }
+
+    /**
+     * @param integer|null $offset          Number of rows to ignore from the
+     *                                      beginning of  the data
+     * @param integer|null $limit           Limits the number of returned rows
+     *                                      to specified amount
+     * @param string|null  $conditions      Basic SQL-like conditions for row
+     *                                      matching
+     * @param null|true    $keep_file_data  Keep raw file data in memory after
+     *                                      successful parsing
+     *                                      (useful for debugging)
+     */
+    public function init($offset = null, $limit = null, $conditions = null, $keep_file_data = null) {
         if (!is_null($offset)) {
             $this->offset = $offset;
         }
@@ -318,10 +357,6 @@ class Csv {
         if (!is_null($keep_file_data)) {
             $this->keep_file_data = $keep_file_data;
         }
-
-        if (!empty($input)) {
-            $this->parse($input);
-        }
     }
 
     // ==============================================
@@ -332,10 +367,13 @@ class Csv {
      * Parse
      * Parse a CSV file or string
      *
-     * @param  string|null $input      The CSV string or a direct filepath
+     * @param string|null $input       The CSV string or a direct file path
-     * @param  integer     $offset     Number of rows to ignore from the beginning of  the data
+     * @param integer     $offset      Number of rows to ignore from the
-     * @param  integer     $limit      Limits the number of returned rows to specified amount
+     *                                 beginning of  the data
-     * @param  string      $conditions Basic SQL-like conditions for row matching
+     * @param integer     $limit       Limits the number of returned rows to
+     *                                 specified amount
+     * @param string      $conditions  Basic SQL-like conditions for row
+     *                                 matching
      *
      * @return bool True on success
      */
@@ -344,51 +382,44 @@ class Csv {
             $input = $this->file;
         }
 
-        if (!empty($input)) {
+        if (empty($input)) {
-            if (!is_null($offset)) {
+            return false;
-                $this->offset = $offset;
-            }
-
-            if (!is_null($limit)) {
-                $this->limit = $limit;
-            }
-
-            if (!is_null($conditions)) {
-                $this->conditions = $conditions;
-            }
-
-            if (strlen($input) <= PHP_MAXPATHLEN && is_readable($input)) {
-                $this->data = $this->parse_file($input);
-            } else {
-                $this->file_data = &$input;
-                $this->data = $this->parse_string();
-            }
-
-            if ($this->data === false) {
-                return false;
-            }
         }
 
-        return true;
+        $this->init($offset, $limit, $conditions);
+
+        if (strlen($input) <= PHP_MAXPATHLEN && is_readable($input)) {
+            $this->file = $input;
+            $this->data = $this->_parse_file();
+        } else {
+            $this->file = null;
+            $this->file_data = &$input;
+            $this->data = $this->_parse_string();
+        }
+
+        return $this->data !== false;
     }
 
     /**
      * Save
      * Save changes, or write a new file and/or data
      *
-     * @param  string $file   File location to save to
+     * @param string $file    File location to save to
-     * @param  array  $data   2D array of data
+     * @param array  $data    2D array of data
-     * @param  bool   $append Append current data to end of target CSV, if file exists
+     * @param bool   $append  Append current data to end of target CSV, if file
-     * @param  array  $fields Field names
+     *                        exists
+     * @param array  $fields  Field names. Sets the header. If it is not set
+     *                        $this->titles would be used instead.
      *
      * @return bool
+     *   True on success
      */
-    public function save($file = '', $data = array(), $append = false, $fields = array()) {
+    public function save($file = '', $data = array(), $append = FileProcessingModeEnum::MODE_FILE_OVERWRITE, $fields = array()) {
         if (empty($file)) {
             $file = &$this->file;
         }
 
-        $mode = $append ? 'ab' : 'wb';
+        $mode = FileProcessingModeEnum::getAppendMode($append);
         $is_php = preg_match('/\.php$/i', $file) ? true : false;
 
         return $this->_wfile($file, $this->unparse($data, $fields, $append, $is_php), $mode);
@@ -398,13 +429,16 @@ class Csv {
      * Output
      * Generate a CSV based string for output.
      *
-     * @param  string|null $filename   If a filename is specified here or in the
+     * @param string|null $filename    If a filename is specified here or in the
      *                                 object, headers and data will be output
      *                                 directly to browser as a downloadable
-     *                                 file.
+     *                                 file. This file doesn't have to exist on
-     * @param  array[]     $data       2D array with data
+     *                                 the server; the parameter only affects
-     * @param  array       $fields     Field names
+     *                                 how the download is called to the
-     * @param  string|null $delimiter  character used to separate data
+     *                                 browser.
+     * @param array[]     $data        2D array with data
+     * @param array       $fields      Field names
+     * @param string|null $delimiter   character used to separate data
      *
      * @return string  The resulting CSV string
      */
@@ -440,8 +474,8 @@ class Csv {
      * Encoding
      * Convert character encoding
      *
-     * @param  string $input  Input character encoding, uses default if left blank
+     * @param string $input  Input character encoding, uses default if left blank
-     * @param  string $output Output character encoding, uses default if left blank
+     * @param string $output Output character encoding, uses default if left blank
      */
     public function encoding($input = null, $output = null) {
         $this->convert_encoding = true;
@@ -459,11 +493,11 @@ class Csv {
      * Auto-Detect Delimiter: Find delimiter by analyzing a specific number of
      * rows to determine most probable delimiter character
      *
-     * @param  string|null $file         Local CSV file
+     * @param string|null $file         Local CSV file
-     * @param  bool        $parse        True/false parse file directly
+     * @param bool        $parse        True/false parse file directly
-     * @param  int         $search_depth Number of rows to analyze
+     * @param int         $search_depth Number of rows to analyze
-     * @param  string      $preferred    Preferred delimiter characters
+     * @param string      $preferred    Preferred delimiter characters
-     * @param  string|null $enclosure    Enclosure character, default is double quote (").
+     * @param string|null $enclosure    Enclosure character, default is double quote (").
      *
      * @return string The detected field delimiter
      */
@@ -502,25 +536,63 @@ class Csv {
 
         // parse data
         if ($parse) {
-            $this->data = $this->parse_string();
+            $this->data = $this->_parse_string();
         }
 
         return $this->delimiter;
     }
 
+    /**
+     * Get total number of data rows (exclusive heading line if present) in CSV
+     * without parsing the whole data string.
+     *
+     * @return bool|int
+     */
+    public function getTotalDataRowCount() {
+        if (empty($this->file_data)) {
+            return false;
+        }
+
+        $data = $this->file_data;
+
+        $this->_detect_and_remove_sep_row_from_data($data);
+
+        $pattern = sprintf('/%1$s[^%1$s]*%1$s/i', $this->enclosure);
+        preg_match_all($pattern, $data, $matches);
+
+        /** @var array[] $matches */
+        foreach ($matches[0] as $match) {
+            if (empty($match) || (strpos($match, $this->enclosure) === false)) {
+                continue;
+            }
+
+            $replace = str_replace(["\r", "\n"], '', $match);
+            $data = str_replace($match, $replace, $data);
+        }
+
+        $headingRow = $this->heading ? 1 : 0;
+
+        $count = substr_count($data, "\r")
+            + substr_count($data, "\n")
+            - substr_count($data, "\r\n")
+            - $headingRow;
+
+        return $count;
+    }
+
     // ==============================================
     // ----- [ Core Functions ] ---------------------
     // ==============================================
 
     /**
      * Parse File
-     * Read file to string and call parse_string()
+     * Read file to string and call _parse_string()
      *
-     * @param  string|null $file Local CSV file
+     * @param string|null $file Local CSV file
      *
      * @return array|bool
      */
-    public function parse_file($file = null) {
+    protected function _parse_file($file = null) {
         if (is_null($file)) {
             $file = $this->file;
         }
@@ -529,13 +601,15 @@ class Csv {
             $this->load_data($file);
         }
 
-        return !empty($this->file_data) ? $this->parse_string() : false;
+        return !empty($this->file_data) ? $this->_parse_string() : false;
     }
 
     /**
-     * Parse CSV strings to arrays. If you need BOM detection or character
+     * Internal function to parse CSV strings to arrays.
-     * encoding conversion, please call load_data() first, followed by a call to
+     *
-     * parse_string() with no parameters.
+     * If you need BOM detection or character encoding conversion, please call
+     * $csv->load_data($your_data_string) first, followed by a call to
+     * $csv->parse($csv->file_data).
      *
      * To detect field separators, please use auto() instead.
      *
@@ -543,7 +617,7 @@ class Csv {
      *
      * @return array|false - 2D array with CSV data, or false on failure
      */
-    public function parse_string($data = null) {
+    protected function _parse_string($data = null) {
         if (empty($data)) {
             if ($this->_check_data()) {
                 $data = &$this->file_data;
@@ -566,7 +640,7 @@ class Csv {
 
         // force the parser to process end of data as a character (false) when
         // data does not end with a line feed or carriage return character.
-        $lch = $data{$strlen - 1};
+        $lch = $data[$strlen - 1];
         if ($lch != "\n" && $lch != "\r") {
             $data .= "\n";
             $strlen++;
@@ -574,8 +648,8 @@ class Csv {
 
         // walk through each character
         for ($i = 0; $i < $strlen; $i++) {
-            $ch = isset($data{$i}) ? $data{$i} : false;
+            $ch = isset($data[$i]) ? $data[$i] : false;
-            $nch = isset($data{$i + 1}) ? $data{$i + 1} : false;
+            $nch = isset($data[$i + 1]) ? $data[$i + 1] : false;
 
             // open/close quotes, and inline quotes
             if ($ch == $this->enclosure) {
@@ -605,10 +679,10 @@ class Csv {
                     $i++;
                 } elseif ($nch != $this->delimiter && $nch != "\r" && $nch != "\n") {
                     $x = $i + 1;
-                    while (isset($data{$x}) && ltrim($data{$x}, $white_spaces) == '') {
+                    while (isset($data[$x]) && ltrim($data[$x], $white_spaces) == '') {
                         $x++;
                     }
-                    if ($data{$x} == $this->delimiter) {
+                    if ($data[$x] == $this->delimiter) {
                         $enclosed = false;
                         $i = $x;
                     } else {
@@ -648,7 +722,7 @@ class Csv {
                 $col++;
 
                 // end of row
-                if ($ch == "\n" || $ch == "\r" || $ch === false) {
+                if (in_array($ch, ["\n", "\r", false], true)) {
                     if ($this->_validate_offset($row_count) && $this->_validate_row_conditions($row, $this->conditions)) {
                         if ($this->heading && empty($head)) {
                             $head = $row;
@@ -694,13 +768,7 @@ class Csv {
 
         $this->titles = $head;
         if (!empty($this->sort_by)) {
-            $sort_type = SORT_REGULAR;
+            $sort_type = SortEnum::getSorting($this->sort_type);
-            if ($this->sort_type == 'numeric') {
-                $sort_type = SORT_NUMERIC;
-            } elseif ($this->sort_type == 'string') {
-                $sort_type = SORT_STRING;
-            }
-
             $this->sort_reverse ? krsort($rows, $sort_type) : ksort($rows, $sort_type);
 
             if ($this->offset !== null || $this->limit !== null) {
@@ -728,9 +796,12 @@ class Csv {
      *
      * @return string CSV data
      */
-    public function unparse($data = array(), $fields = array(), $append = false, $is_php = false, $delimiter = null) {
+    public function unparse($data = array(), $fields = array(), $append = FileProcessingModeEnum::MODE_FILE_OVERWRITE, $is_php = false, $delimiter = null) {
         if (!is_array($data) || empty($data)) {
             $data = &$this->data;
+        } else {
+            /** @noinspection ReferenceMismatchInspection */
+            $this->data = $data;
         }
 
         if (!is_array($fields) || empty($fields)) {
@@ -745,8 +816,16 @@ class Csv {
         $entry = array();
 
         // create heading
+        /** @noinspection ReferenceMismatchInspection */
+        $fieldOrder = $this->_validate_fields_for_unparse($fields);
+        if (!$fieldOrder && !empty($data)) {
+            $column_count = count($data[0]);
+            $columns = range(0, $column_count - 1, 1);
+            $fieldOrder = array_combine($columns, $columns);
+        }
+
         if ($this->heading && !$append && !empty($fields)) {
-            foreach ($fields as $key => $column_name) {
+            foreach ($fieldOrder as $column_name) {
                 $entry[] = $this->_enclose_value($column_name, $delimiter);
             }
 
@@ -756,7 +835,8 @@ class Csv {
 
         // create data
         foreach ($data as $key => $row) {
-            foreach ($row as $cell_value) {
+            foreach (array_keys($fieldOrder) as $index) {
+                $cell_value = $row[$index];
                 $entry[] = $this->_enclose_value($cell_value, $delimiter);
             }
 
@@ -765,18 +845,73 @@ class Csv {
         }
 
         if ($this->convert_encoding) {
-            $string = iconv($this->input_encoding, $this->output_encoding, $string);
+            /** @noinspection PhpComposerExtensionStubsInspection
+             *
+             * If you receive an error at the following 3 lines, you must enable
+             * the following PHP extension:
+             *
+             *  - if $use_mb_convert_encoding is true: mbstring
+             *  - if $use_mb_convert_encoding is false: iconv
+             */
+            $string = $this->use_mb_convert_encoding ?
+                mb_convert_encoding($string, $this->output_encoding, $this->input_encoding) :
+                iconv($this->input_encoding, $this->output_encoding, $string);
         }
 
         return $string;
     }
 
+    private function _validate_fields_for_unparse($fields) {
+        if (empty($fields)) {
+            $fields = $this->titles;
+        }
+
+        if (empty($fields)) {
+            return array();
+        }
+
+        // this is needed because sometime titles property is overwritten instead of using fields parameter!
+        $titlesOnParse = !empty($this->data) ? array_keys(reset($this->data)) : array();
+
+        // both are identical, also in ordering OR we have no data (only titles)
+        if (empty($titlesOnParse) || array_values($fields) === array_values($titlesOnParse)) {
+            return array_combine($fields, $fields);
+        }
+
+        // if renaming given by: $oldName => $newName (maybe with reorder and / or subset):
+        // todo: this will only work if titles are unique
+        $fieldOrder = array_intersect(array_flip($fields), $titlesOnParse);
+        if (!empty($fieldOrder)) {
+            return array_flip($fieldOrder);
+        }
+
+        $fieldOrder = array_intersect($fields, $titlesOnParse);
+        if (!empty($fieldOrder)) {
+            return array_combine($fieldOrder, $fieldOrder);
+        }
+
+        // original titles are not given in fields. that is okay if count is okay.
+        if (count($fields) != count($titlesOnParse)) {
+            throw new \UnexpectedValueException(
+                "The specified fields do not match any titles and do not match column count.\n" .
+                "\$fields was " . print_r($fields, true) .
+                "\$titlesOnParse was " . print_r($titlesOnParse, true));
+        }
+
+        return array_combine($titlesOnParse, $fields);
+    }
+
     /**
-     * Load local file or string
+     * Load local file or string.
      *
-     * @param string|null $input local CSV file
+     * Only use this function if auto() and parse() don't handle your data well.
      *
-     * @return  true or false
+     * 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
+     *
+     * @return bool  True on success
      */
     public function load_data($input = null) {
         $data = null;
@@ -784,9 +919,10 @@ class Csv {
 
         if (is_null($input)) {
             $file = $this->file;
-        } elseif (file_exists($input)) {
+        } elseif (\strlen($input) <= PHP_MAXPATHLEN && file_exists($input)) {
             $file = $input;
         } else {
+            // It is CSV data as a string.
             $data = $input;
         }
 
@@ -814,6 +950,14 @@ class Csv {
             }
 
             if ($this->convert_encoding && $this->input_encoding !== $this->output_encoding) {
+                /** @noinspection PhpComposerExtensionStubsInspection
+                 *
+                 * If you receive an error at the following 3 lines, you must enable
+                 * the following PHP extension:
+                 *
+                 *  - if $use_mb_convert_encoding is true: mbstring
+                 *  - if $use_mb_convert_encoding is false: iconv
+                 */
                 $data = $this->use_mb_convert_encoding ?
                     mb_convert_encoding($data, $this->output_encoding, $this->input_encoding) :
                     iconv($this->input_encoding, $this->output_encoding, $data);
@@ -883,12 +1027,19 @@ class Csv {
      */
     protected function _validate_row_condition($row, $condition) {
         $operators = array(
-            '=', 'equals', 'is',
+            '=',
-            '!=', 'is not',
+            'equals',
-            '<', 'is less than',
+            'is',
-            '>', 'is greater than',
+            '!=',
-            '<=', 'is less than or equals',
+            'is not',
-            '>=', 'is greater than or equals',
+            '<',
+            'is less than',
+            '>',
+            'is greater than',
+            '<=',
+            'is less than or equals',
+            '>=',
+            'is greater than or equals',
             'contains',
             'does not contain',
         );
@@ -903,23 +1054,34 @@ class Csv {
 
         if (preg_match('/^(.+) (' . $operators_regex . ') (.+)$/i', trim($condition), $capture)) {
             $field = $capture[1];
-            $op = $capture[2];
+            $op = strtolower($capture[2]);
             $value = $capture[3];
+            if ($op == 'equals' && preg_match('/^(.+) is (less|greater) than or$/i', $field, $m)) {
+                $field = $m[1];
+                $op = strtolower($m[2]) == 'less' ? '<=' : '>=';
+            }
+            if ($op == 'is' && preg_match('/^(less|greater) than (.+)$/i', $value, $m)) {
+                $value = $m[2];
+                $op = strtolower($m[1]) == 'less' ? '<' : '>';
+            }
+            if ($op == 'is' && preg_match('/^not (.+)$/i', $value, $m)) {
+                $value = $m[1];
+                $op = '!=';
+            }
 
-            if (preg_match('/^([\'\"]{1})(.*)([\'\"]{1})$/', $value, $capture)) {
+            if (preg_match('/^([\'"])(.*)([\'"])$/', $value, $capture) && $capture[1] == $capture[3]) {
-                if ($capture[1] == $capture[3]) {
+                $value = strtr($capture[2], array(
-                    $value = strtr($capture[2], array(
+                    "\\n" => "\n",
-                        "\\n" => "\n",
+                    "\\r" => "\r",
-                        "\\r" => "\r",
+                    "\\t" => "\t",
-                        "\\t" => "\t",
+                ));
-                    ));
 
-                    $value = stripslashes($value);
+                $value = stripslashes($value);
-                }
             }
 
             if (array_key_exists($field, $row)) {
-                if (($op == '=' || $op == 'equals' || $op == 'is') && $row[$field] == $value) {
+                $op_equals = in_array($op, ['=', 'equals', 'is'], true);
+                if ($op_equals && $row[$field] == $value) {
                     return '1';
                 } elseif (($op == '!=' || $op == 'is not') && $row[$field] != $value) {
                     return '1';
@@ -963,19 +1125,19 @@ class Csv {
      * Enclose values if needed
      *  - only used by unparse()
      *
-     * @param string $value     Cell value to process
+     * @param string|null $value     Cell value to process
-     * @param string $delimiter Character to put between cells on the same row
+     * @param string      $delimiter Character to put between cells on the same row
      *
      * @return string Processed value
      */
-    protected function _enclose_value($value = null, $delimiter) {
+    protected function _enclose_value($value, $delimiter) {
         if ($value !== null && $value != '') {
             $delimiter_quoted = $delimiter ?
                 preg_quote($delimiter, '/') . "|"
                 : '';
             $enclosure_quoted = preg_quote($this->enclosure, '/');
             $pattern = "/" . $delimiter_quoted . $enclosure_quoted . "|\n|\r/i";
-            if ($this->enclose_all || preg_match($pattern, $value) || ($value{0} == ' ' || substr($value, -1) == ' ')) {
+            if ($this->enclose_all || preg_match($pattern, $value) || strpos($value, ' ') === 0 || substr($value, -1) == ' ') {
                 $value = str_replace($this->enclosure, $this->enclosure . $this->enclosure, $value);
                 $value = $this->enclosure . $value . $this->enclosure;
             }
@@ -987,7 +1149,7 @@ class Csv {
     /**
      * Check file data
      *
-     * @param  string|null $file local filename
+     * @param string|null $file local filename
      *
      * @return bool
      */
@@ -1007,10 +1169,10 @@ class Csv {
      * Check if passed info might be delimiter
      * Only used by find_delimiter
      *
-     * @param  string $char      Potential field separating character
+     * @param string $char      Potential field separating character
-     * @param  array  $array     Frequency
+     * @param array  $array     Frequency
-     * @param  int    $depth     Number of analyzed rows
+     * @param int    $depth     Number of analyzed rows
-     * @param  string $preferred Preferred delimiter characters
+     * @param string $preferred Preferred delimiter characters
      *
      * @return string|false      special string used for delimiter selection, or false
      */
@@ -1046,21 +1208,19 @@ class Csv {
     }
 
     /**
-     * Read local file
+     * Read local file.
      *
-     * @param string|null $file local filename
+     * @param string $file local filename
      *
      * @return string|false Data from file, or false on failure
      */
-    protected function _rfile($file = null) {
+    protected function _rfile($file) {
         if (is_readable($file)) {
-            if (!($fh = fopen($file, 'r'))) {
+            $data = file_get_contents($file);
+            if ($data === false) {
                 return false;
             }
-
+            return rtrim($data, "\r\n");
-            $data = fread($fh, filesize($file));
-            fclose($fh);
-            return $data;
         }
 
         return false;
@@ -1069,12 +1229,14 @@ class Csv {
     /**
      * Write to local file
      *
-     * @param   string $file    local filename
+     * @param string $file    local filename
-     * @param   string $content data to write to file
+     * @param string $content data to write to file
-     * @param   string $mode    fopen() mode
+     * @param string $mode    fopen() mode
-     * @param   int    $lock    flock() mode
+     * @param int    $lock    flock() mode
+     *
+     * @return bool
+     *   True on success
      *
-     * @return  true or false
      */
     protected function _wfile($file, $content = '', $mode = 'wb', $lock = LOCK_EX) {
         if ($fp = fopen($file, $mode)) {
@@ -1095,7 +1257,7 @@ class Csv {
      * first line containing only "sep=;", where the last character is the
      * separator. Microsoft Excel is able to open such files.
      *
-     * @param string $data    file data
+     * @param string $data file data
      *
      * @return string|false detected delimiter, or false if none found
      */
@@ -1113,7 +1275,7 @@ class Csv {
     /**
      * Support for Excel-compatible sep=? row.
      *
-     * @param string $data_string    file data to be updated
+     * @param string $data_string file data to be updated
      *
      * @return bool TRUE if sep= line was found at the very beginning of the file
      */
@@ -1162,9 +1324,9 @@ class Csv {
 
         // walk specific depth finding possible delimiter characters
         for ($i = 0; $i < $strlen; $i++) {
-            $ch = $data{$i};
+            $ch = $data[$i];
-            $nch = isset($data{$i + 1}) ? $data{$i + 1} : false;
+            $nch = isset($data[$i + 1]) ? $data[$i + 1] : false;
-            $pch = isset($data{$i - 1}) ? $data{$i - 1} : false;
+            $pch = isset($data[$i - 1]) ? $data[$i - 1] : false;
 
             // open and closing quotes
             $is_newline = ($ch == "\n" && $pch != "\r") || $ch == "\r";
@@ -1209,4 +1371,29 @@ class Csv {
         ksort($filtered);
         $this->delimiter = reset($filtered);
     }
+
+    /**
+     * getCollection
+     * Returns a Illuminate/Collection object
+     * This may prove to be helpful to people who want to
+     * create macros, and or use map functions
+     *
+     * @access public
+     * @link   https://laravel.com/docs/5.6/collections
+     *
+     * @throws \ErrorException - If the Illuminate\Support\Collection class is not found
+     *
+     * @return Collection
+     */
+    public function getCollection() {
+        //does the Illuminate\Support\Collection class exists?
+        //this uses the autoloader to try to determine
+        //@see http://php.net/manual/en/function.class-exists.php
+        if (class_exists('Illuminate\Support\Collection', true) == false) {
+            throw new \ErrorException('It would appear you have not installed the illuminate/support package!');
+        }
+
+        //return the collection
+        return new Collection($this->data);
+    }
 }

src/enums/AbstractEnum.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace ParseCsv\enums;
+
+abstract class AbstractEnum {
+
+    /**
+     * Creates a new value of some type
+     *
+     * @param mixed $value
+     *
+     * @throws \UnexpectedValueException if incompatible type is given.
+     */
+    public function __construct($value) {
+        if (!$this->isValid($value)) {
+            throw new \UnexpectedValueException("Value '$value' is not part of the enum " . get_called_class());
+        }
+        $this->value = $value;
+    }
+
+    public static function getConstants() {
+        $class = get_called_class();
+        $reflection = new \ReflectionClass($class);
+
+        return $reflection->getConstants();
+    }
+
+    /**
+     * Check if enum value is valid
+     *
+     * @param $value
+     *
+     * @return bool
+     */
+    public static function isValid($value) {
+        return in_array($value, static::getConstants(), true);
+    }
+}

src/enums/DatatypeEnum.php

@@ -9,7 +9,7 @@ namespace ParseCsv\enums;
  *
  * todo: needs a basic parent enum class for error handling.
  */
-class DatatypeEnum {
+class DatatypeEnum extends AbstractEnum {
 
     const __DEFAULT = self::TYPE_STRING;
 

src/enums/FileProcessingModeEnum.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace ParseCsv\enums;
+
+
+/**
+ * Class FileProcessingEnum
+ *
+ * @package ParseCsv\enums
+ *
+ * todo extends a basic enum class after merging #121
+ */
+class FileProcessingModeEnum {
+
+    const __default = self::MODE_FILE_OVERWRITE;
+
+    const MODE_FILE_APPEND = true;
+
+    const MODE_FILE_OVERWRITE = false;
+
+    public static function getAppendMode($mode) {
+        if ($mode == self::MODE_FILE_APPEND) {
+            return 'ab';
+        }
+
+        return 'wb';
+    }
+}

src/enums/SortEnum.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace ParseCsv\enums;
+
+
+class SortEnum extends AbstractEnum {
+
+    const __DEFAULT = self::SORT_TYPE_REGULAR;
+
+    const SORT_TYPE_REGULAR = 'regular';
+
+    const SORT_TYPE_NUMERIC = 'numeric';
+
+    const SORT_TYPE_STRING = 'string';
+
+    private static $sorting = array(
+        self::SORT_TYPE_REGULAR => SORT_REGULAR,
+        self::SORT_TYPE_STRING => SORT_STRING,
+        self::SORT_TYPE_NUMERIC => SORT_NUMERIC,
+    );
+
+    public static function getSorting($type) {
+        if (array_key_exists($type, self::$sorting)) {
+            return self::$sorting[$type];
+        }
+
+        return self::$sorting[self::__DEFAULT];
+    }
+
+}

src/extensions/DatatypeTrait.php

@@ -2,13 +2,15 @@
 
 namespace ParseCsv\extensions;
 
+use ParseCsv\enums\DatatypeEnum;
+
 trait DatatypeTrait {
 
     /**
-     * Datatypes
+     * Data Types
-     * Datatypes of CSV data-columns
+     * Data types of CSV data-columns, keyed by the column name. Possible values
+     * are string, float, integer, boolean, date. See DatatypeEnum.
      *
-     * @access public
      * @var array
      */
     public $data_types = [];
@@ -17,8 +19,6 @@ trait DatatypeTrait {
      * Check data type for one column.
      * Check for most commonly data type for one column.
      *
-     * @access private
-     *
      * @param  array $datatypes
      *
      * @return string|false
@@ -45,15 +45,13 @@ trait DatatypeTrait {
      *
      * Requires PHP >= 5.5
      *
-     * @access public
+     * @uses   DatatypeEnum::getValidTypeFromSample
-     *
-     * @uses   getDatatypeFromString
      *
      * @return array|bool
      */
     public function getDatatypes() {
         if (empty($this->data)) {
-            $this->data = $this->parse_string();
+            $this->data = $this->_parse_string();
         }
         if (!is_array($this->data)) {
             throw new \UnexpectedValueException('No data set yet.');
@@ -62,7 +60,7 @@ trait DatatypeTrait {
         $result = [];
         foreach ($this->titles as $cName) {
             $column = array_column($this->data, $cName);
-            $cDatatypes = array_map('ParseCsv\enums\DatatypeEnum::getValidTypeFromSample', $column);
+            $cDatatypes = array_map(DatatypeEnum::class . '::getValidTypeFromSample', $column);
 
             $result[$cName] = $this->getMostFrequentDatatypeForColumn($cDatatypes);
         }
@@ -71,4 +69,35 @@ trait DatatypeTrait {
 
         return !empty($this->data_types) ? $this->data_types : [];
     }
+
+    /**
+     * Check data type of titles / first row for auto detecting if this could be
+     * a heading line.
+     *
+     * Requires PHP >= 5.5
+     *
+     * @uses   DatatypeEnum::getValidTypeFromSample
+     *
+     * @return bool
+     */
+    public function autoDetectFileHasHeading() {
+        if (empty($this->data)) {
+            throw new \UnexpectedValueException('No data set yet.');
+        }
+
+        if ($this->heading) {
+            $firstRow = $this->titles;
+        } else {
+            $firstRow = $this->data[0];
+        }
+
+        $firstRow = array_filter($firstRow);
+        if (empty($firstRow)) {
+            return false;
+        }
+
+        $firstRowDatatype = array_map(DatatypeEnum::class . '::getValidTypeFromSample', $firstRow);
+
+        return $this->getMostFrequentDatatypeForColumn($firstRowDatatype) === DatatypeEnum::TYPE_STRING;
+    }
 }

tests/example_files/multiple_empty_lines.csv

@@ -0,0 +1,22 @@
+ID,dID,createdAt,else1,else2,else3,else4,else5,user,else6,else7,else8,else9,else10,else11,else12,else13,else14,else15,else16,else17,else18,else19,else20,else21,else22,else23,else24,else25,else26,else27,else28,else29,else30,else31,else32,else33,else34,else35,else36,else37,else38
+418,0,2017-05-16,,,2018-01-22,22.01.2018 10:00:09,,admin,Ja,,10001,Abweichung,,10001,v1,1,ddd,100,1000,,HH,,v1,0,401,1,2,H1,,-1,10,1,111,Ja,2017-01-01,,12,0,11109,HH-100,default
+419,0,2017-05-16,,,2017-05-16,14.07.2017 09:58:09,,admin,Ja,,,Abweichung,,10002,v2,1,ddd,200,500,DD,DD,,v2,1,402,2,4,H2,,-2,100,1,1111,Ja,2017-01-01,1,13,1,11109,DD-200,default 
+438,0,2017-05-16,,,2017-05-16,14.07.2017 09:58:29,,admin,Ja,,10021,Abweichung,,10021,v3,4,ddd,300,400,DD,DD,,v3,0,421,1,,H3,,-1,106,1,111,Ja,2017-05-08,,2,1,11109,DD-300,default
+440,0,2017-05-16,,,,14.07.2017 09:58:53,,admin,Ja,,,Alt,,10023,v4,3,,400,500,BE,DD,,v4,1,423,3,,H4,,-3,143,1,1111,Ja,2017-01-01,1,33,1,11108,BE-400,default
+441,0,2017-05-16,,,,14.07.2017 09:59:19,,admin,Ja,,,Fehlt,,10024,v5,3,,500,,BE,,,v5,2,424,4,,H5,,0,1435,0,111,Ja,2017-01-01,,12,1,0,BE-500,default
+442,0,2017-05-16,,,,14.07.2017 10:00:46,,admin,Ja,,,Neu,,10025,v6,3,,100,,DD,,,v6,435,425,1,,H6,,0,10,0,1111,Ja,2017-01-01,,102,1,0,DD-100,default
+443,0,2017-05-16,,,2017-07-04,14.07.2017 10:01:12,,admin,Ja,,,OK,,10026,v7,3,,200,200,DD,DD,,v7,32,426,2,2,H7,,0,100,0,111,Ja,2017-01-01,,77,1,0,DD-200,default
+444,0,2017-05-16,,,,14.07.2017 10:02:13,,admin,Ja,,,Fehlt,,10027,v8,3,,300,,BE,,,v8,45,427,3,,H8,,0,200,0,1111,Ja,2017-01-01,,44,3,0,BE-300,default
+445,0,2017-05-16,,,,14.07.2017 10:02:38,,admin,Ja,,,Fehlt,,10028,v9,3,,100,,BE,,,v9,45,428,4,,H9,,0,400,0,111,Ja,2017-01-01,,44,1,0,BE-100,default
+446,0,2017-05-16,,,,14.07.2017 10:03:01,,admin,Ja,,,Fehlt,,10029,v10,3,,,400,,DD,,v10,45,429,,,H10,,0,1124,0,1111,Ja,2017-01-01,,89,1,0,,default
+
+
+
+
+
+
+
+
+
+
+

tests/example_files/waiver_field_separator.csv

@@ -0,0 +1,6 @@
+keyword
+liability waiver
+release of liability form
+release of liability
+sample waiver
+sample waiver form

tests/methods/ConstructTest.php

@@ -58,8 +58,11 @@ class ConstructTest extends TestCase {
             ob_start();
             /** @noinspection PhpIncludeInspection */
             require $script_file;
-            if ($script_file != 'download.php') {
+            $ob_get_clean = ob_get_clean();
-                $this->assertContains('<td>', ob_get_clean());
+            $verb = strtok($script_file, '_.');
+
+            if (!in_array($verb, ['download', 'save'], true)) {
+                $this->assertContains('<td>', $ob_get_clean);
             }
         }
         chdir('..');

tests/methods/DataRowCountTest.php

@@ -0,0 +1,82 @@
+<?php
+
+namespace ParseCsv\tests\methods;
+
+use ParseCsv\Csv;
+use PHPUnit\Framework\TestCase;
+
+
+class DataRowCountTest extends TestCase {
+
+    /**
+     * CSV
+     * The CSV object
+     *
+     * @access protected
+     * @var Csv
+     */
+    protected $csv;
+
+    /**
+     * Setup
+     * Setup our test environment objects
+     *
+     * @access public
+     */
+    public function setUp() {
+        $this->csv = new Csv();
+    }
+
+    public function countRowsProvider() {
+        return [
+            'auto-double-enclosure' => [
+                'auto-double-enclosure.csv',
+                2,
+            ],
+            'auto-single-enclosure' => [
+                'auto-single-enclosure.csv',
+                2,
+            ],
+            'UTF-8_sep_row' => [
+                'datatype.csv',
+                3,
+            ],
+        ];
+    }
+
+    /**
+     * @dataProvider countRowsProvider
+     *
+     * @param string $file
+     * @param int    $expectedRows
+     */
+    public function testGetTotalRowCountFromFile($file, $expectedRows) {
+        $this->csv->heading = true;
+        $this->csv->load_data(__DIR__ . '/fixtures/' . $file);
+        $this->assertEquals($expectedRows, $this->csv->getTotalDataRowCount());
+    }
+
+    public function testGetTotalRowCountMissingEndingLineBreak() {
+        $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());
+    }
+
+    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->assertEquals(3, $this->csv->getTotalDataRowCount());
+    }
+
+    public function testGetTotalRowCountSingleRow() {
+        $this->csv->heading = false;
+        $this->csv->enclosure = "'";
+        $sInput = "86545235689";
+        $this->csv->load_data($sInput);
+        $this->assertEquals(1, $this->csv->getTotalDataRowCount());
+    }
+}

tests/methods/DatatypeTest.php

@@ -8,12 +8,12 @@
 
 namespace ParseCsv\tests\methods;
 
-use PHPUnit\Framework\TestCase;
 use ParseCsv\enums\DatatypeEnum;
+use PHPUnit\Framework\TestCase;
 
-class DatatypeTest extends TestCase
+class DatatypeTest extends TestCase {
-{
+
-    public function testSampleIsValidInteger(){
+    public function testSampleIsValidInteger() {
         $this->assertEquals(DatatypeEnum::TYPE_INT, DatatypeEnum::getValidTypeFromSample('1'));
         $this->assertEquals(DatatypeEnum::TYPE_INT, DatatypeEnum::getValidTypeFromSample('+1'));
         $this->assertEquals(DatatypeEnum::TYPE_INT, DatatypeEnum::getValidTypeFromSample('-1'));
@@ -27,7 +27,7 @@ class DatatypeTest extends TestCase
         $this->assertNotEquals(DatatypeEnum::TYPE_INT, DatatypeEnum::getValidTypeFromSample('2018-02-19'));
     }
 
-    public function testSampleIsValidBool(){
+    public function testSampleIsValidBool() {
         $this->assertEquals(DatatypeEnum::TYPE_BOOL, DatatypeEnum::getValidTypeFromSample('true'));
         $this->assertEquals(DatatypeEnum::TYPE_BOOL, DatatypeEnum::getValidTypeFromSample('TRUE'));
         $this->assertEquals(DatatypeEnum::TYPE_BOOL, DatatypeEnum::getValidTypeFromSample('false'));
@@ -39,7 +39,7 @@ class DatatypeTest extends TestCase
         $this->assertNotEquals(DatatypeEnum::TYPE_BOOL, DatatypeEnum::getValidTypeFromSample('0.1'));
     }
 
-    public function testSampleIsValidFloat(){
+    public function testSampleIsValidFloat() {
         $this->assertEquals(DatatypeEnum::TYPE_FLOAT, DatatypeEnum::getValidTypeFromSample('1.0'));
         $this->assertEquals(DatatypeEnum::TYPE_FLOAT, DatatypeEnum::getValidTypeFromSample('-1.1'));
         $this->assertEquals(DatatypeEnum::TYPE_FLOAT, DatatypeEnum::getValidTypeFromSample('+1,1'));
@@ -54,7 +54,7 @@ class DatatypeTest extends TestCase
         $this->assertNotEquals(DatatypeEnum::TYPE_FLOAT, DatatypeEnum::getValidTypeFromSample('2018-02-19'));
     }
 
-    public function testSampleIsValidDate(){
+    public function testSampleIsValidDate() {
         $this->assertEquals(DatatypeEnum::TYPE_DATE, DatatypeEnum::getValidTypeFromSample('2018-02-19'));
         $this->assertEquals(DatatypeEnum::TYPE_DATE, DatatypeEnum::getValidTypeFromSample('18-2-19'));
         $this->assertEquals(DatatypeEnum::TYPE_DATE, DatatypeEnum::getValidTypeFromSample('01.02.2018'));

tests/methods/ExampleStream.php

@@ -0,0 +1,101 @@
+<?php
+
+namespace ParseCsv\tests\methods;
+
+/**
+ * This is a very simple implementation of a stream wrapper. All URLs are mapped
+ * to just one buffer. It exists to prove that ParseCsv can read and write
+ * streams.
+ *
+ * @see https://www.php.net/manual/en/class.streamwrapper.php
+ */
+class ExampleStream {
+
+    private static $position = 0;
+
+    private static $stream_content;
+
+    public function stream_open($uri, $mode) {
+        if (strpos($mode, 'a') === false) {
+            self::$position = 0;
+        }
+        if (strpos($mode, 'w') !== false) {
+            self::$stream_content = '';
+        }
+        return true;
+    }
+
+    public function stream_read($count) {
+        $ret = substr(self::$stream_content, self::$position, $count);
+        self::$position += strlen($ret);
+        return $ret;
+    }
+
+    public function stream_write($data) {
+        $left = substr(self::$stream_content, 0, self::$position);
+        $right = substr(self::$stream_content, self::$position + strlen($data));
+        self::$stream_content = $left . $data . $right;
+        self::$position += strlen($data);
+        return strlen($data);
+    }
+
+    public function stream_stat() {
+        return ['size' => strlen(self::$stream_content)];
+    }
+
+
+    public function stream_tell() {
+        return self::$position;
+    }
+
+    public function stream_eof() {
+        return self::$position >= strlen(self::$stream_content);
+    }
+
+    public function url_stat() {
+        return ['size' => strlen(self::$stream_content)];
+    }
+
+    public function stream_seek($offset, $whence) {
+        switch ($whence) {
+            case SEEK_SET:
+                if ($offset < strlen(self::$stream_content) && $offset >= 0) {
+                    self::$position = $offset;
+                    return true;
+                } else {
+                    return false;
+                }
+                break;
+
+            case SEEK_CUR:
+                if ($offset >= 0) {
+                    self::$position += $offset;
+                    return true;
+                } else {
+                    return false;
+                }
+                break;
+
+            case SEEK_END:
+                if (strlen(self::$stream_content) + $offset >= 0) {
+                    self::$position = strlen(self::$stream_content) + $offset;
+                    return true;
+                } else {
+                    return false;
+                }
+                break;
+
+            default:
+                return false;
+        }
+    }
+
+    public function stream_lock($operation) {
+        return true;
+    }
+
+    public function stream_metadata() {
+        return false;
+    }
+}
+

tests/methods/ObjectThatHasToStringMethod.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace ParseCsv\tests\methods;
+
+/**
+ * Class HasToString is just a helper to test if cells can be objects.
+ */
+class ObjectThatHasToStringMethod {
+
+    public function __toString() {
+        return 'some value';
+    }
+}

tests/methods/OldRequireTest.php

@@ -4,6 +4,11 @@ namespace ParseCsv\tests\methods;
 
 use PHPUnit\Framework\TestCase;
 
+/**
+ * This test checks for backwards compatibility: Does it work to
+ *   - require the old "parsecsv.lib.php" instead of composer autoloading?
+ *   - use the old class name "parseCSV"?
+ */
 class OldRequireTest extends TestCase {
 
     protected function setUp() {
@@ -15,7 +20,7 @@ class OldRequireTest extends TestCase {
     }
 
     /**
-     * @runInSeparateProcess because download.php uses header()
+     * @runInSeparateProcess so that disabled autoloading has an effect
      */
     public function testOldLibWithoutComposer() {
 
@@ -25,4 +30,16 @@ class OldRequireTest extends TestCase {
         $this->assertEquals($output, []);
         $this->assertEquals(0, $return_var);
     }
+
+    /**
+     * @runInSeparateProcess so that disabled autoloading has an effect
+     */
+    public function testOldLibWithOldClassName() {
+
+        file_put_contents('__eval.php', '<?php require "parsecsv.lib.php"; new parseCSV;');
+        exec("php __eval.php", $output, $return_var);
+        unlink('__eval.php');
+        $this->assertEquals($output, []);
+        $this->assertEquals(0, $return_var);
+    }
 }

tests/methods/OutputTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace ParseCsv\tests\methods;
+
+use ParseCsv\Csv;
+use PHPUnit\Framework\TestCase;
+
+class OutputTest extends TestCase {
+
+    /**
+     * @runInSeparateProcess because download.php uses header()
+     */
+    public function testOutputWithFourParameters() {
+        $csv = new Csv();
+        $data = [0 => ['a', 'b', 'c'], 1 => ['d', 'e', 'f']];
+        $fields = ['col1', 'col2', 'col3'];
+        $output = $csv->output('test.csv', $data, $fields, ',');
+        $expected = "col1,col2,col3\ra,b,c\rd,e,f\r";
+        self::assertEquals($expected, $output);
+    }
+}

tests/methods/ParseTest.php

@@ -22,13 +22,13 @@ class ParseTest extends TestCase {
         $this->csv = new Csv();
     }
 
-    public function test_parse() {
+    public function testParse() {
         // can we trick 'is_readable' into whining? See #67.
-        $this->parse_repetitive_string('c:/looks/like/a/path');
+        $this->parseRepetitiveString('c:/looks/like/a/path');
-        $this->parse_repetitive_string('http://looks/like/an/url');
+        $this->parseRepetitiveString('http://looks/like/an/url');
     }
 
-    private function parse_repetitive_string($content) {
+    private function parseRepetitiveString($content) {
         $this->csv->delimiter = ';';
         $this->csv->heading = false;
         $success = $this->csv->parse(str_repeat($content . ';', 500));
@@ -41,9 +41,11 @@ class ParseTest extends TestCase {
     }
 
     /**
-     * @depends      test_parse
+     * @depends      testParse
      *
      * @dataProvider autoDetectionProvider
+     *
+     * @param string $file
      */
     public function testSepRowAutoDetection($file) {
         // This file (parse_test.php) is encoded in UTF-8, hence comparison will
@@ -85,7 +87,8 @@ class ParseTest extends TestCase {
         $this->csv->enclosure = '"';
         $sInput = "86545235689,a\r\n34365587654,b\r\n13469874576,\"c\r\nd\"";
         $expected_data = [86545235689, 34365587654, 13469874576];
-        $actual_data = $this->csv->parse_string($sInput);
+
+        $actual_data = $this->invokeMethod($this->csv, '_parse_string', array($sInput));
         $actual_column = array_map('reset', $actual_data);
         $this->assertEquals($expected_data, $actual_column);
         $this->assertEquals([
@@ -95,7 +98,7 @@ class ParseTest extends TestCase {
         ], array_map('next', $actual_data));
     }
 
-    public function test_single_column() {
+    public function testSingleColumn() {
         $this->csv->auto(__DIR__ . '/../example_files/single_column.csv');
         $expected = [
             ['SMS' => '0444'],
@@ -106,11 +109,8 @@ class ParseTest extends TestCase {
         $this->assertEquals($expected, $this->csv->data);
     }
 
-    public function test_Piwik_data() {
+    public function testMatomoData() {
-        if (!function_exists('array_column')) {
+        // Matomo (Piwik) export cannot be read with
-            // function only available in PHP >= 5.5
-            return;
-        }
         $this->csv->use_mb_convert_encoding = true;
         $this->csv->output_encoding = 'UTF-8';
         $this->csv->auto(__DIR__ . '/../example_files/Piwik_API_download.csv');
@@ -129,16 +129,61 @@ class ParseTest extends TestCase {
         ], $aCity);
     }
 
+    /**
+     * Tests if we can handle BOMs in string data, in contrast to loading files.
+     */
+    public function testStringWithLeadingBOM() {
+        $string_with_bom = strtr(
+            file_get_contents(__DIR__ . '/../example_files/UTF-8_with_BOM_and_sep_row.csv'),
+            ["sep=;\n" => '']);
+
+        // Is the BOM still there?
+        self::assertSame(0xEF, ord($string_with_bom));
+
+        $this->csv->output_encoding = 'UTF-8';
+        $this->csv->delimiter = ';';
+        self::assertTrue($this->csv->load_data($string_with_bom));
+        self::assertTrue($this->csv->parse($this->csv->file_data));
+
+        // This also tests if ::load_data removed the BOM from the data;
+        // otherwise the 'title' column would have 3 extra bytes.
+        $this->assertEquals([
+            'title',
+            'isbn',
+            'publishedAt',
+        ], array_keys(reset($this->csv->data)));
+
+        $titles = array_column($this->csv->data, 'title');
+        $this->assertEquals([
+            'Красивая кулинария',
+            'The Wine Connoisseurs',
+            'Weißwein',
+        ], $titles);
+    }
+
+    public function testWithMultipleNewlines() {
+        $this->csv->auto(__DIR__ . '/../example_files/multiple_empty_lines.csv');
+        $aElse9 = array_column($this->csv->data, 'else9');
+
+        /** @noinspection SpellCheckingInspection */
+        $this->assertEquals([
+            'Abweichung',
+            'Abweichung',
+            'Abweichung',
+            'Alt',
+            'Fehlt',
+            'Neu',
+            'OK',
+            'Fehlt',
+            'Fehlt',
+            'Fehlt',
+        ], $aElse9);
+    }
+
     /**
      * @depends testSepRowAutoDetection
      */
     public function testGetColumnDatatypes() {
-        if (!function_exists('array_column')) {
-            // getDatatypes requires array_column, but that
-            // function is only available in PHP >= 5.5
-            return;
-        }
-
         $this->csv->auto(__DIR__ . '/fixtures/datatype.csv');
         $this->csv->getDatatypes();
         $expected = [
@@ -153,29 +198,31 @@ class ParseTest extends TestCase {
         $this->assertEquals($expected, $this->csv->data_types);
     }
 
-
+    /**
-    public function testDataArrayKeysWhenSettingOffsetWithHeading() {
+     * @depends testSepRowAutoDetection
-        $this->csv->offset = 2;
+     */
+    public function testAutoDetectFileHasHeading() {
         $this->csv->auto(__DIR__ . '/fixtures/datatype.csv');
-        $expected = [
+        $this->assertTrue($this->csv->autoDetectFileHasHeading());
-            'title',
-            'isbn',
-            'publishedAt',
-            'published',
-            'count',
-            'price'
-        ];
 
-        $this->assertEquals($expected, array_keys($this->csv->data[0]));
+        $this->csv->heading = false;
+        $this->csv->auto(__DIR__ . '/fixtures/datatype.csv');
+        $this->assertTrue($this->csv->autoDetectFileHasHeading());
+
+        $this->csv->heading = false;
+        $sInput = "86545235689\r\n34365587654\r\n13469874576";
+        $this->csv->auto($sInput);
+        $this->assertFalse($this->csv->autoDetectFileHasHeading());
+
+        $this->csv->heading = true;
+        $sInput = "86545235689\r\n34365587654\r\n13469874576";
+        $this->csv->auto($sInput);
+        $this->assertFalse($this->csv->autoDetectFileHasHeading());
     }
 
-    public function testDataArrayKeysWhenSettingOffsetWithoutHeading() {
+    public function testVeryLongNonExistingFile() {
-        $this->csv->heading = false;
+        $this->csv->parse(str_repeat('long_string', PHP_MAXPATHLEN));
-        $this->csv->offset = 2;
+        $this->csv->auto(str_repeat('long_string', PHP_MAXPATHLEN));
-        $this->csv->auto(__DIR__ . '/fixtures/datatype.csv');
-        $expected = range(0, 5, 1);
-
-        $this->assertEquals($expected, array_keys($this->csv->data[0]));
     }
 
     protected function _get_magazines_data() {
@@ -219,4 +266,34 @@ class ParseTest extends TestCase {
         $this->assertArrayHasKey('column1', $csv->data[0], 'Data parsed incorrectly with enclosure ' . $enclosure);
         $this->assertEquals('value1', $csv->data[0]['column1'], 'Data parsed incorrectly with enclosure ' . $enclosure);
     }
+
+    /**
+     * Call protected/private method of a class.
+     *
+     * @param object &$object     Instantiated object that we will run method on.
+     * @param string  $methodName Method name to call
+     * @param array   $parameters Array of parameters to pass into method.
+     *
+     * @return mixed Method return.
+     */
+    private function invokeMethod(&$object, $methodName, array $parameters = array()) {
+        $reflection = new \ReflectionClass(get_class($object));
+        $method = $reflection->getMethod($methodName);
+        $method->setAccessible(true);
+
+        return $method->invokeArgs($object, $parameters);
+    }
+
+    public function testWaiverFieldSeparator() {
+        $this->assertSame(false, $this->csv->auto(__DIR__ . '/../example_files/waiver_field_separator.csv'));
+        $expected = [
+            'liability waiver',
+            'release of liability form',
+            'release of liability',
+            'sample waiver',
+            'sample waiver form',
+        ];
+        $actual = array_column($this->csv->data, 'keyword');
+        $this->assertSame($expected, $actual);
+    }
 }

tests/methods/SaveTest.php

@@ -1,11 +1,11 @@
 <?php
+
 namespace ParseCsv\tests\methods;
 
 use ParseCsv\Csv;
 use PHPUnit\Framework\TestCase;
 
-class SaveTest extends TestCase
+class SaveTest extends TestCase {
-{
 
     /** @var Csv */
     private $csv;
@@ -49,6 +49,13 @@ class SaveTest extends TestCase
         $this->saveAndCompare($expected);
     }
 
+    public function testSaveWithNewHeader() {
+        $this->csv->linefeed = "\n";
+        $this->csv->titles = array("NewTitle");
+        $expected = "NewTitle\n0444\n5555\n";
+        $this->saveAndCompare($expected);
+    }
+
     public function testSaveWithoutHeader() {
         $this->csv->linefeed = "\n";
         $this->csv->heading = false;

tests/methods/StreamTest.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace ParseCsv\tests\methods;
+
+use ParseCsv\Csv;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Writes roughly 1 MB of data. This is useful because of a limit of 8 KB
+ * encountered with stream operations in certain PHP versions.
+ */
+class StreamTest extends TestCase {
+
+    public function setUp() {
+        static $done;
+        if ($done) {
+            // Make sure we register the stream just once - or PHP will scream.
+            return;
+        }
+
+        stream_wrapper_register("example", ExampleStream::class)
+        or die("Failed to register protocol");
+        $done = 1;
+    }
+
+    public function testReadStream() {
+        $csv = new Csv();
+
+        // Write data to our stream:
+        $filename = 'example://tmp';
+        copy(__DIR__ . '/fixtures/datatype.csv', $filename);
+        $many_dots = str_repeat('.', 1000 * 1000) . ";;;;;\n";
+        file_put_contents($filename, $many_dots, FILE_APPEND);
+
+        self::assertSame(';', $csv->auto(file_get_contents($filename)));
+        self::assertCount(4, $csv->data);
+        self::assertCount(6, reset($csv->data));
+    }
+
+    public function testWriteStream() {
+        $csv = new Csv();
+        $csv->linefeed = "\n";
+        $many_dots = str_repeat('.', 1000 * 1000);
+        $csv->data = [
+            [
+                'Name' => 'Rudolf',
+                'Question' => 'Which color is his nose?',
+            ],
+            [
+                'Name' => 'Sponge Bob',
+                'Question' => 'Which shape are his pants?',
+            ],
+            [
+                'Name' => $many_dots,
+                'Question' => 'Can you count one million dots?',
+            ],
+        ];
+
+        // Just export the first column, but with a new name
+        $csv->titles = ['Name' => 'Character'];
+
+        // Write data to our stream:
+        $filename = 'example://data';
+        copy(__DIR__ . '/fixtures/datatype.csv', $filename);
+
+        self::assertSame(true, $csv->save($filename));
+        $expected = "Character\nRudolf\nSponge Bob\n";
+        $expected .= $many_dots . "\n";
+        self::assertSame($expected, file_get_contents($filename));
+    }
+}

tests/methods/UnparseTest.php

@@ -0,0 +1,108 @@
+<?php
+
+namespace ParseCsv\tests\methods;
+
+use ParseCsv\Csv;
+use PHPUnit\Framework\TestCase;
+
+
+class UnparseTest extends Testcase {
+
+    /** @var Csv */
+    private $csv;
+
+    /**
+     * Setup our test environment objects; will be called before each test.
+     */
+    public function setUp() {
+        $this->csv = new Csv();
+        $this->csv->auto(__DIR__ . '/fixtures/auto-double-enclosure.csv');
+    }
+
+    public function testUnparseWithParameters() {
+        $fields = array('a' => 'AA', 'b' => 'BB');
+        $data = [['a' => 'value1', 'b' => 'value2']];
+        $csv_object = new Csv();
+        $csv_string = $csv_object->unparse($data, $fields);
+        $this->assertEquals("AA,BB\rvalue1,value2\r", $csv_string);
+
+        $csv_object = new Csv();
+        $csv_object->linefeed = "\n";
+        $csv_string = $csv_object->unparse([[55, 66]]);
+        $this->assertEquals("55,66\n", $csv_string);
+
+        $csv_object = new Csv();
+        $data2 = [['a' => "multi\rline", 'b' => 'value2']];
+        $csv_object->enclosure = "'";
+        $csv_string = $csv_object->unparse($data2, $fields);
+        $this->assertEquals("AA,BB\r'multi\rline',value2\r", $csv_string);
+    }
+
+    public function testUnparseDefault() {
+        $expected = "column1,column2\rvalue1,value2\rvalue3,value4\r";
+        $this->unparseAndCompare($expected);
+    }
+
+    public function testUnparseDefaultWithoutHeading() {
+        $this->csv->heading = false;
+        $this->csv->auto(__DIR__ . '/fixtures/auto-double-enclosure.csv');
+        $expected = "column1,column2\rvalue1,value2\rvalue3,value4\r";
+        $this->unparseAndCompare($expected);
+
+    }
+
+    public function testUnparseRenameFields() {
+        $expected = "C1,C2\rvalue1,value2\rvalue3,value4\r";
+        $this->unparseAndCompare($expected, array("C1", "C2"));
+    }
+
+    public function testReorderFields() {
+        $expected = "column2,column1\rvalue2,value1\rvalue4,value3\r";
+        $this->unparseAndCompare($expected, array("column2", "column1"));
+    }
+
+    public function testSubsetFields() {
+        $expected = "column1\rvalue1\rvalue3\r";
+        $this->unparseAndCompare($expected, array("column1"));
+    }
+
+    public function testReorderAndRenameFields() {
+        $fields = array(
+            'column2' => 'C2',
+            'column1' => 'C1',
+        );
+        $expected = "C2,C1\rvalue2,value1\rvalue4,value3\r";
+        $this->unparseAndCompare($expected, $fields);
+    }
+
+    public function testUnparseDefaultFirstRowMissing() {
+        unset($this->csv->data[0]);
+        $expected = "column1,column2\rvalue3,value4\r";
+        $this->unparseAndCompare($expected);
+    }
+
+    public function testUnparseDefaultWithoutData() {
+        unset($this->csv->data[0]);
+        unset($this->csv->data[1]);
+        $expected = "column1,column2\r";
+        $this->unparseAndCompare($expected);
+    }
+
+    public function testObjectCells() {
+        $this->csv->data = [
+            [
+                'column1' => new ObjectThatHasToStringMethod(),
+                'column2' => 'boring',
+            ],
+        ];
+        $this->csv->linefeed = "\n";
+        $expected = "column1,column2\nsome value,boring\n";
+        $this->unparseAndCompare($expected);
+    }
+
+    private function unparseAndCompare($expected, $fields = array()) {
+        $str = $this->csv->unparse($this->csv->data, $fields);
+        $this->assertEquals($expected, $str);
+    }
+
+}

tests/properties/BaseClass.php

@@ -11,7 +11,6 @@ class BaseClass extends TestCase {
      * CSV
      * The parseCSV object
      *
-     * @access protected
      * @var Csv
      */
     protected $csv;
@@ -19,10 +18,8 @@ class BaseClass extends TestCase {
     /**
      * Setup
      * Setup our test environment objects
-     *
-     * @access public
      */
-    public function setUp() {
+    protected function setUp() {
         $this->csv = new Csv();
     }
 

tests/properties/ConditionsTest.php

@@ -21,21 +21,93 @@ class ConditionsTest extends BaseClass {
         ]);
     }
 
-    public function testRating() {
+    public function testRatingEquals() {
-        $this->csv->conditions = 'rating < 3';
+        $rating_of_3 = [
-        $this->_compareWithExpected([
+            'The Last Templar',
+            'The Broker (Paperback)',
+            'Without Blood (Paperback)',
+        ];
+        $this->csv->conditions = 'rating = 3';
+        $this->_compareWithExpected($rating_of_3);
+        $this->csv->conditions = 'rating is 3';
+        $this->_compareWithExpected($rating_of_3);
+        $this->csv->conditions = 'rating equals 3';
+        $this->_compareWithExpected($rating_of_3);
+    }
+
+    public function testRatingNotEquals() {
+        $rating_not_4 = [
             'The Killing Kind',
             'The Third Secret',
-        ]);
+            'The Last Templar',
+            'The Traveller',
+            'Prey',
+            'The Broker (Paperback)',
+            'Without Blood (Paperback)',
+            'State of Fear (Paperback)',
+            'Digital Fortress : A Thriller (Mass Market Paperback)',
+            'Angels & Demons (Mass Market Paperback)',
+        ];
+//        $this->csv->conditions = 'rating != 4';
+//        $this->_compareWithExpected($rating_not_4);
+        $this->csv->conditions = 'rating is not 4';
+        $this->_compareWithExpected($rating_not_4);
+//        $this->csv->conditions = 'rating does not contain 4';
+//        $this->_compareWithExpected($rating_not_4);
+    }
 
-        $this->csv->conditions = 'rating >= 5';
+    public function testRatingLessThan() {
-        $this->_compareWithExpected([
+        $less_than_1 = [
+            'The Killing Kind',
+            'The Third Secret',
+        ];
+        $this->csv->conditions = 'rating < 1';
+        $this->_compareWithExpected($less_than_1);
+        $this->csv->conditions = 'rating is less than 1';
+        $this->_compareWithExpected($less_than_1);
+    }
+
+    public function testRatingLessOrEquals() {
+        $less_or_equals_1 = [
+            'The Killing Kind',
+            'The Third Secret',
+        ];
+        $this->csv->conditions = 'rating <= 1';
+        $this->_compareWithExpected($less_or_equals_1);
+        $this->csv->conditions = 'rating is less than or equals 1';
+        $this->_compareWithExpected($less_or_equals_1);
+    }
+
+    public function testRatingGreaterThan() {
+        $greater_4 = [
             'The Traveller',
             'Prey',
             'State of Fear (Paperback)',
             'Digital Fortress : A Thriller (Mass Market Paperback)',
             'Angels & Demons (Mass Market Paperback)',
-        ]);
+        ];
+        $this->csv->conditions = 'rating > 4';
+        $this->_compareWithExpected($greater_4);
+        $this->csv->conditions = 'rating is greater than 4';
+        $this->_compareWithExpected($greater_4);
+    }
+
+    public function testRatingGreaterOrEquals() {
+        $greater_or_equal_4 = [
+            'The Traveller',
+            'Crisis Four',
+            'Prey',
+            'State of Fear (Paperback)',
+            'The Rule of Four (Paperback)',
+            'Deception Point (Paperback)',
+            'Digital Fortress : A Thriller (Mass Market Paperback)',
+            'Angels & Demons (Mass Market Paperback)',
+            'The Da Vinci Code (Hardcover)',
+        ];
+        $this->csv->conditions = 'rating >= 4';
+        $this->_compareWithExpected($greater_or_equal_4);
+        $this->csv->conditions = 'rating is greater than or equals 4';
+        $this->_compareWithExpected($greater_or_equal_4);
     }
 
     public function testTitleContainsSecretOrCode() {

tests/properties/DefaultValuesPropertiesTest.php

@@ -57,7 +57,7 @@ class DefaultValuesPropertiesTest extends TestCase {
     }
 
     public function test_sort_type_default() {
-        $this->assertNull($this->csv->sort_type);
+        $this->assertEquals('regular', $this->csv->sort_type);
     }
 
     public function test_delimiter_default() {

tests/properties/OffsetTest.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace ParseCsv\tests\properties;
+
+/**
+ * Tests related to the $offset property
+ */
+class OffsetTest extends BaseClass {
+
+    public function testOffsetOfOne() {
+        $this->csv->offset = 1;
+        $this->csv->auto(__DIR__ . '/../methods/fixtures/datatype.csv');
+        $this->assertCount(3, $this->csv->data);
+
+        if (!function_exists('array_column')) {
+            // function only available in PHP >= 5.5
+            return;
+        }
+        $expected = [
+            'Красивая кулинария',
+            'The Wine Connoisseurs',
+            'Weißwein',
+        ];
+        $actual = array_column($this->csv->data, 'title');
+        $this->assertEquals($expected, $actual);
+    }
+
+    public function numberRangeZeroToFourProvider() {
+        return array_map(function ($number) {
+            return [$number];
+        }, range(0, 4));
+    }
+
+    /**
+     * @dataProvider numberRangeZeroToFourProvider
+     *
+     * @param integer $offset
+     */
+    public function testOffsetOfOneNoHeader($offset) {
+        $this->csv->offset = $offset;
+        $this->csv->heading = false;
+        $this->csv->auto(__DIR__ . '/../methods/fixtures/datatype.csv');
+        $this->assertCount(4 - $offset, $this->csv->data);
+    }
+
+    public function testDataArrayKeysWhenSettingOffsetWithHeading() {
+        $this->csv->offset = 2;
+        $this->csv->auto(__DIR__ . '/../methods/fixtures/datatype.csv');
+        $expected = [
+            [
+                'title' => 'The Wine Connoisseurs',
+                'isbn' => '2547-8548-2541',
+                'publishedAt' => '12.12.2011',
+                'published' => 'TRUE',
+                'count' => '',
+                'price' => 20.33,
+            ],
+            [
+                'title' => 'Weißwein',
+                'isbn' => '1313-4545-8875',
+                'publishedAt' => '23.02.2012',
+                'published' => 'false',
+                'count' => 10,
+                'price' => 10,
+            ],
+        ];
+
+        $this->assertEquals($expected, $this->csv->data);
+    }
+
+    public function testDataArrayKeysWhenSettingOffsetWithoutHeading() {
+        $this->csv->heading = false;
+        $this->csv->offset = 2;
+        $this->csv->auto(__DIR__ . '/../methods/fixtures/datatype.csv');
+        $expected = range(0, 5, 1);
+
+        $this->assertEquals($expected, array_keys($this->csv->data[0]));
+    }
+}

tests/properties/PublicPropertiesTest.php

@@ -3,6 +3,7 @@
 namespace ParseCsv\tests\properties;
 
 use ParseCsv\Csv;
+use ParseCsv\enums\SortEnum;
 use PHPUnit\Framework\TestCase;
 
 class PublicPropertiesTest extends TestCase {
@@ -145,4 +146,26 @@ class PublicPropertiesTest extends TestCase {
 
         $this->assertCount($counter, $this->properties);
     }
+
+    public function testDefaultSortTypeIsRegular() {
+        $this->assertEquals(SortEnum::SORT_TYPE_REGULAR, $this->csv->sort_type);
+    }
+
+    public function testSetSortType() {
+        $this->csv->sort_type = 'numeric';
+        $this->assertEquals(SortEnum::SORT_TYPE_NUMERIC, $this->csv->sort_type);
+
+        $this->csv->sort_type = 'string';
+        $this->assertEquals(SortEnum::SORT_TYPE_STRING, $this->csv->sort_type);
+    }
+
+    public function testGetSorting() {
+        $this->csv->sort_type = 'numeric';
+        $sorting = SortEnum::getSorting($this->csv->sort_type);
+        $this->assertEquals(SORT_NUMERIC, $sorting);
+
+        $this->csv->sort_type = 'string';
+        $sorting = SortEnum::getSorting($this->csv->sort_type);
+        $this->assertEquals(SORT_STRING, $sorting);
+    }
 }