README

phpcsv is a small PHP package to assist in dealing with CSV data.

It is not meant to be full-featured or very high-performance. I regularly need to manipulate one-off CSV data and so I built this to assist in the common things I keep re-writing like formatting a date or merging 2 CSVs together.

A few examples:

Selectively join data from one CSV into another.

This would look at the 'id' column in file.csv and match it with 'fid' column in other_file.csv then take the 'username' column from other_file.csv and fill it into the 'user' column of file.csv. then dump changes to stdout.

It is similar to an SQL join, for example: select file.*, other_file.username from file left join other_file on file.id = other_file.fid

use SeanKndy\CSV\CSV;

$csv = new CSV('file.csv');
$csv->join(
    new CSV('other_file.csv'),
    function ($r1, $r2) {
        return ($r1->get('id') == $r2->get('fid'));
    },
    ['user'],
    ['username']
));
$csv->getRecords()->dump();

Format a date column, dump output:

use SeanKndy\CSV\CSV;
use SeanKndy\CSV\Formatters;

$csv = new CSV('file.csv');
$csv->setFormatter('date_of_birth', function($data) {
    return Formatters::date($data, 'm/d/Y');
});
$csv->getRecords()->dump();

Loop through file without loading into memory:

use SeanKndy\CSV\CSV;

foreach (new CSV('file.csv', ['preload' => false])->getRecords() as $record) {
    print_r($record->getAll());
}

Selectively print columns in arbitrary order:

use SeanKndy\CSV\CSV;

$csv = new CSV('file.csv');
$csv->getRecords()->pickyDump(['age','dob','name','sex']);

Merge 2 columns together, separate by space. print changes to stdout

use SeanKndy\CSV\CSV;

$csv = new CSV('file.csv');
$csv->combineColumns(['first_name','last_name'], 'name');
$csv->getRecords()->dump();

Manually get or set data from a record. Note that this only works if you're NOT using mutators! If mutators are in use, then get() will return a clone/copy of that data post-mutated.

use SeanKndy\CSV\CSV;

$csv = new CSV('file.csv');
foreach ($csv->getRecords() as $record) {
    $age = $record->get('age');
    if ($age >= 18) {
        $record->set('is_adult', 'yes');
    }
}

Filter records (in this case, any record where 'sex' column is not 'male' would be removed):

use SeanKndy\CSV\CSV;

$csv = new CSV('file.csv');
$csv->getRecords()->filter(['sex' => 'male'])->dump();

Example of adding a custom Mutator to manipulate some data in records. In this case, we make sure the comma-separate Rate Group(s) column is paired with the same number of Billing Frequency items:

use SeanKndy\CSV\CSV;
use SeanKndy\CSV\Record;
use SeanKndy\CSV\Mutators\Mutator;

$csv = new CSV('customers.csv');
$csv->addMutator(new class extends Mutator {
    public function mutate(Record $record) {
        $rateGroups = preg_split('/,\s*/', $record->get('Rate Group(s)'));
        $billingFrequency = preg_split('/,\s*/', $record->get('Billing Frequency');

        if (count($rateGroups) > count($billingFrequency)) {
            // ex: if Rate Group(s) is '500,501,502' and Billing Frequency is '12'
            // then this would update Billing Frequency to be '12,12,12' to pair
            // with each of the Rate Group(s)
            for ($i = count($billingFrequency); $i < count($rateGroups); $i++) {
                $billingFrequency[] = $billingFrequency[0];
            }
            $record->set('Billing Frequency', implode(',', $billingFrequency));
        } else if (count($rateGroups) < count($billingFrequency)) {
            $billingFrequency = array_splice($billingFrequency, count($rateGroups));
            $record->set('Billing Frequency', implode(',', $billingFrequency));
        }

        return $record;
    }
});

seankndy / phpcsv

Maintainers

Details

README