PHP Classes
elePHPant
Icontem

File: README.md

Recommend this page to a friend!
  Classes of nvb  >  CSV Component for PHP  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: CSV Component for PHP
Reader and writer for CSV files
Author: By
Last change: Add CONTRIBUTING guide to explain contribution
Date: 5 months ago
Size: 6,303 bytes
 

Contents

Class file image Download

CSV Handling Component for PHP

This project aims to deliver an easy to use and free as in freedom php compontent for dealing with csv files (read and write).

This component is heavily influenced by jwage/easy-csv. It was mainly created because of missing compatibility with php 5.6 and no official packagist support from jwage/easy-csv.

The build status of the current master branch is tracked by Travis CI: Build Status Latest stable

The scrutinizer status are: code quality

The versioneye status is: Dependency Status

Take a look on openhub.net.

The current change log can be found here.

Benefits

  • low and stable memory usage (give it a try by using benchmarkReader and benchmarkWriter)
  • works with PHP 5.6 and above
  • \_\_invoke() implemented to use it as function
  • unified reader and writer
  • adapter to easy up migration from EasyCsv - 0.0.1 to this component * writer * reader
  • usage of filters - control what comes in and what comes out
  • reader * implemented iterator * readOne(); * readMany(); * readAll();
  • writer * copy(); * delete(); * move(); * truncate(); * writeOne(); * writeMany(); * writeAll(); //truncates file and writes content

Install

By Hand

mkdir -p vendor/net_bazzline/php_component_csv
cd vendor/net_bazzline/php_component_csv
git clone https://github.com/bazzline/php_component_csv .

With Packagist

composer require net_bazzline/php_component_csv:dev-master

Usage

Reader

Read Content

$reader = new Reader('my/file.csv');
//I am using json_encode() since there is no official and best way how to
// output arrays on the command line.

//read one line
echo json_encode($reader->readOne()) . PHP_EOL;

//read 10 lines
foreach ($reader->readMany(10) as $line) {
    echo json_encode($line) . PHP_EOL;
}

//read all lines
foreach ($reader->readAll() as $line) {
    echo json_encode($line) . PHP_EOL;
}

By Iteration

$reader = new Reader('my/file.csv');
//I am using json_encode() since there is no official and best way how to
// output arrays on the command line.

if ($reader->hasHeadline()) {
    echo 'headlines: ' . json_encode($reader->readHeadline());
}

foreach ($reader as $line) {
    echo json_encode($line) . PHP_EOL;
}

By Using As A Function

$reader = new Reader('my/file.csv');
//I am using json_encode() since there is no official and best way how to
// output arrays on the command line.

while ($line = $reader()) {
    echo json_encode($line) . PHP_EOL;
}

Writer

Write Content

By Iteration

//$headlines contains a php array
//$lines contains a php array of arrays
$writer = new Writer('my/file.csv');

$writer->writeHeadline($headlines);

foreach ($lines as $line) {
    $writer->writeOne($line);
}

At Once

//$headlines contains a php array
//$lines contains a php array of arrays
$writer = new Writer('my/file.csv');

$writer->writeHeadline($headlines);
$writer->writeMany($lines);

By Using As A Function

//$line contains a php array
//$lines contains a php array of arrays
$writer = new Writer('my/file.csv');

$writer($line);

foreach ($lines as $line) {
    $writer($line);
}

Truncate

$writer = new Writer('my/file.csv');

$writer->truncate();

Copy

$writer = new Writer('my/file.csv');

$writer->copy('my/my_first_copy.csv');    //writer will still write into "file.csv"

$writer->copy('my/my_second_copy.csv', true);    //writer will write in "my_second_copy.csv"

Move

$writer = new Writer('my/file.csv');

$writer->move('my/new_name.csv');   //writer will write in "new_name.csv"

API

API is available at bazzline.net.

Other Great Components

Hall of Fame - The list of contributors

Contributing

Please see CONTRIBUTING for details.

Final Words

Star it if you like it :-). Add issues if you need it. Pull patches if you enjoy it. Write a blog entry if you use it. Donate something if you love it :-].