g105b / phpcsv
Wraps SplFileObject's CSV capabilities with a more human approach
Installs: 17 801
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Requires (Dev)
- phpunit/phpunit: 4.5.*
This package is auto-updated.
Last update: 2024-11-19 11:08:48 UTC
README
Wraps SplFileObject's CSV capabilities with a more human approach
Features at a glance
- Enhances PHP's SplFileObject, a memory-efficient file stream.
- Simple filtering of rows by field value (
getAllBy("fieldName", "fieldValue")
). - Results are associative arrays, the indices are the CSV header names.
- Iterate over CSV files by row.
- Reference CSV rows by row number.
- Reference CSV rows by ID value.
Screenshot in action
Usage
Here are a few use cases to best show the functionality of the library. For a complete guide, visit the documentation.
Add rows
$csv = new Csv("/path/to/file.csv"); $csv->add([ "firstName" => "Alan", "lastName" => "Statham", "Job Title" => "Consultant Radiologist", ]); $csv->add([ "firstName" => "Caroline", "lastName" => "Todd", "Job Title" => "Surgical Registrar", ]);
Get rows
$csv = new Csv("/path/to/file.csv"); $resultRows = $csv->getAllBy("gender", "F"); // array of all matching rows. $firstRow = $csv->getBy("gender", "F"); // single row, first matching.
Iterate over rows
$csv = new Csv("/path/to/file.csv"); foreach ($csv as $rowNumber => $row) { // $row is an associative array with CSV headers as each key. // $rowNumber starts from 1 (ignoring header row). }
Update row
$csv = new Csv("/path/to/file.csv"); $row = $csv->getBy("email", "barack@whitehouse.gov"); // Update the matching row with provided fields, keeping any // existing field data on the existing row. $csv->update($row, [ "dateOfBirth" => "1961-08-04", ]);
Delete row
$csv = new Csv("/path/to/file.csv"); // Delete a row by its index. $csv->deleteRow(22);
Future feature ideas
- Requesting only certain fields in result (v2)
- Type handling (v3)
- Sorting (v4)
- Faster retrieval of indexed rows (v4)