originphp/csv

OriginPHP CSV

2.1.0 2021-04-13 12:53 UTC

Requires

• php: >=7.3.0
• originphp/defer: ^3.0

Requires (Dev)

• phpstan/phpstan: ^0.12.64
• phpunit/phpunit: ^9.2

MIT

• Jamiel Sharief

• csv
• originPHP

README

The CSV utility makes it easy to work with CSV files.

Installation

To install this package

$ composer require originphp/csv

Create CSV from an Array

To use an array to create CSV data

use Origin\Csv\Csv;

$csv = Csv::fromArray([
    ['jim','[e-mail]'],
    ['tony','[e-mail]']
]);

Which will give you this

jim,[e-mail]
tony,[e-mail]

You can also use keys from the array as headers

use Origin\Csv\Csv;

$csv = Csv::fromArray([
        ['name'=>'jim','email'=>'[e-mail]'],
        ['name'=>'tony','email'=>'[e-mail]']
    ],['header'=>true]);

Which will return this

name,email
jim,[e-mail]
tony,[e-mail]

If you want to use custom headers

use Origin\Csv\Csv;

$csv = Csv::fromArray([
        ['name'=>'jim','email'=>'[e-mail]'],
        ['name'=>'tony','email'=>'[e-mail]']
    ],['header'=>['First Name','Email Address']]);

Which will gives you this

"First Name","Email Address"
jim,[e-mail]
tony,[e-mail]

Create an Array from CSV Data

Use the toArray method to create an array using CSV data.

use Origin\Csv\Csv;

$csv = file_get_contents('/path/file.csv');
$data = Csv::toArray($csv);

If the CSV file has a header row, then you can skip it by passing an options array with the key header set to true.

$data = Csv::toArray($csv,['header'=>true]);

If you want to use the headers as keys for each record in the array, this will use the first row as the keys for the array.

$data = Csv::toArray($csv,['header'=>true,'keys'=>true]);

If you want to set custom keys for each record in the array

$data = Csv::toArray($csv,['keys'=>['First Name','Email Address']]);

Processing Large Files

To process large CSV files in a memory efficient way use the process method, which takes the the same options as toArray. The difference here is that, it will reads the CSV file one line at a time, returns its for processing, then goes the next.

$rows = Csv::process('/path/to/file.csv',['keys'=>['First Name','Email Address']]);
foreach($rows as $row){
    ... do something
}