mirror of
https://github.com/parsecsv/parsecsv-for-php.git
synced 2026-02-19 08:36:39 +00:00
148 lines
4.4 KiB
Markdown
148 lines
4.4 KiB
Markdown
# ParseCsvForPhp
|
|
|
|
This 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
|
|
[Wikipedia article][CSV] (and thus RFC 4180). It has many advanced features which help make your
|
|
life easier when dealing with CSV data.
|
|
|
|
You may not need a library at all: before using ParseCsvForPhp, please make sure if PHP's own `str_getcsv()`, ``fgetcvs()`` or `fputcsv()` meets your needs.
|
|
|
|
This library was originally created in early 2007 by [jimeh](https://github.com/jimeh) due to the lack of built-in
|
|
and third-party support for handling CSV data in PHP.
|
|
|
|
[csv]: http://en.wikipedia.org/wiki/Comma-separated_values
|
|
|
|
## Installation
|
|
Installation is easy using Composer. Include the following in your composer.json
|
|
```
|
|
"parsecsv/php-parsecsv": "1.0.0"
|
|
```
|
|
|
|
You may also manually include the ParseCsvForPhp.php file
|
|
```php
|
|
require_once 'ParseCsvForPhp.php';
|
|
```
|
|
|
|
## Features
|
|
|
|
* Supports enclosed values, enclosed commas, double quotes and new lines.
|
|
* Automatic delimiter character detection.
|
|
* Sort data by specific fields/columns.
|
|
* Easy data manipulation.
|
|
* Basic SQL-like _conditions_, _offset_ and _limit_ options for filtering
|
|
data.
|
|
* Error detection for incorrectly formatted input. It attempts to be
|
|
intelligent, but can not be trusted 100% due to the structure of CSV, and
|
|
how different programs like Excel for example outputs CSV data.
|
|
* Support for character encoding conversion using PHP's
|
|
`iconv()` and `mb_convert_encoding()` functions (requires PHP 5).
|
|
* Supports PHP 5.4 and higher.
|
|
It certainly works with PHP 7.2 and all versions in between.
|
|
|
|
|
|
## Example Usage
|
|
|
|
**General**
|
|
|
|
```php
|
|
$csv = new ParseCsvForPhp('data.csv');
|
|
print_r($csv->data);
|
|
```
|
|
|
|
**Tab delimited, and encoding conversion**
|
|
|
|
```php
|
|
$csv = new ParseCsvForPhp();
|
|
$csv->encoding('UTF-16', 'UTF-8');
|
|
$csv->delimiter = "\t";
|
|
$csv->parse('data.tsv');
|
|
print_r($csv->data);
|
|
```
|
|
|
|
**Auto-detect delimiter character**
|
|
|
|
```php
|
|
$csv = new ParseCsvForPhp();
|
|
$csv->auto('data.csv');
|
|
print_r($csv->data);
|
|
```
|
|
|
|
**Modify data in a CSV file**
|
|
|
|
```php
|
|
$csv = new ParseCsvForPhp();
|
|
$csv->sort_by = 'id';
|
|
$csv->parse('data.csv');
|
|
# "4" is the value of the "id" column of the CSV row
|
|
$csv->data[4] = array('firstname' => 'John', 'lastname' => 'Doe', 'email' => 'john@doe.com');
|
|
$csv->save();
|
|
```
|
|
|
|
**Replace field names or set ones if missing**
|
|
|
|
```php
|
|
$csv = new ParseCsvForPhp();
|
|
$csv->fields = ['id', 'name', 'category']
|
|
$csv->parse('data.csv');
|
|
```
|
|
|
|
**Add row/entry to end of CSV file**
|
|
|
|
_Only recommended when you know the exact structure of the file._
|
|
|
|
```php
|
|
$csv = new ParseCsvForPhp();
|
|
$csv->save('data.csv', array(array('1986', 'Home', 'Nowhere', '')), true);
|
|
```
|
|
|
|
**Convert 2D array to CSV data and send headers to browser to treat output as
|
|
a file and download it**
|
|
|
|
```php
|
|
$csv = new ParseCsvForPhp();
|
|
$csv->output('movies.csv', $array, array('field 1', 'field 2'), ',');
|
|
```
|
|
|
|
For more complex examples, see the ``tests`` and `examples` directories.
|
|
|
|
## Credits
|
|
|
|
* ParseCsvForPhp is based on the concept of [Ming Hong Ng][ming]'s [CsvFileParser][]
|
|
class.
|
|
|
|
[ming]: http://minghong.blogspot.com/
|
|
[CsvFileParser]: http://minghong.blogspot.com/2006/07/csv-parser-for-php.html
|
|
|
|
|
|
## Contributors
|
|
|
|
Please find a complete list on the project's [contributors][] page.
|
|
|
|
[contributors]: https://github.com/parsecsv/parsecsv-for-php/graphs/contributors
|
|
|
|
|
|
|
|
## License
|
|
|
|
(The MIT license)
|
|
|
|
Copyright (c) 2014 Jim Myhrberg.
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
SOFTWARE.
|