An open API service indexing awesome lists of open source software.

https://github.com/jamesgordo/php-csv-parser

Turn your CSV files into readable and accessable Data Objects.
https://github.com/jamesgordo/php-csv-parser

csv csv-parser php

Last synced: 2 months ago
JSON representation

Turn your CSV files into readable and accessable Data Objects.

Awesome Lists containing this project

README

          

# PHP CSV Parser

[![Build Status](https://travis-ci.org/jamesgordo/php-csv-parser.svg?branch=master)](https://travis-ci.org/jamesgordo/php-csv-parser) [![codecov](https://codecov.io/gh/jamesgordo/php-csv-parser/branch/master/graph/badge.svg)](https://codecov.io/gh/jamesgordo/php-csv-parser) [![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)](https://github.com/jamesgordo/php-csv-parser)

Turn your CSV files into readable and accessable Data Objects easily. This Library wraps the PHP's built-in
`fgetcsv` function to provide you a hassle free CSV File parsing.

Each row on your CSV file is dynamically transformed into Data Objects with keys set directly from the first
row of your CSV file.

## PHP Version Support

The library has been tested to work on PHP Versions >=5.3.

## How to Use

Run the following command in your terminal

```
composer require jamesgordo/php-csv-parser
```

Or simply add this to your `composer.json`

```json
{
"require": {
"jamesgordo/php-csv-parser": "1.0.0"
}
}
```

Then run

```
composer update
```

Create a Sample CSV File `users.csv`

```csv
id,first_name,last_name
1,John,Doe
2,Eric,Smith
3,Mark,Cooper
```

Example Implementation

```php
all() as $user) {
echo "User Details: {$user->id} | {$user->first_name} {$user->last_name}";
}

echo "Total Parsed: " . $users->count() . " Users";

```

## Options

You can set the second as delimiter. The default delimiter is ",".

```php
setCsv('/path/to/file.csv'); // Sets the File to be Parsed
$users->getCsv(); // Returns the File to be Parsed
$users->checkFile('/path/to/file.csv'); // Validates if File is a valid CSV File
$users->parse(); // Triggers the Parsing of CSV file
$users->all(); // Returns array of Data Objects parsed from the CSV file
$users->count(); // Returns the total rows parsed from the CSV file
```

## Version

1.0.6

## License

MIT License

Copyright (c) 2024 James Gordo

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.