The League of Extraordinary Packages

Our Packages:

Presented by The League of Extraordinary Packages

Getting Started

The API

Upgrading Guide

Instantiation

The library is composed of two main classes:

Both classes extend the League\Csv\AbstractCsv class and as such share methods for instantiation.

Csv and Macintosh

If your CSV document was created or is read on a Macintosh computer, add the following lines before using the library to help PHP detect line ending in Mac OS X.

<?php

if (!ini_get("auto_detect_line_endings")) {
    ini_set("auto_detect_line_endings", '1');
}

//the rest of the code continues here...

Instantiating a new CSV object

Because CSVs come in different forms we used named constructors to offer several ways to instantiate the library objects.

AbstractCsv::createFromPath

This named constructor will create a new object à la fopen.

<?php

public static AbstractCsv::createFromPath(
	mixed $path,
	string $open_mode = 'r+'
): AbstractCsv

Warning: The method throws an InvalidArgumentException if a SplTempFileObject is given as no path can be retrieve from such object.

The resulting string and $open_mode parameters are used to lazy load internally a SplFileObject object.

<?php

use League\Csv\Reader;
use League\Csv\Writer;

$reader = Reader::createFromPath('/path/to/your/csv/file.csv');
//the $reader object will use the 'r+' open mode as no `open_mode` parameter was supplied.
$writer = Writer::createFromPath(new SplFileObject('/path/to/your/csv/file.csv', 'a+'), 'w');
//the $writer object open mode will be 'w'!!

AbstractCsv::createFromFileObject

Instantiate a new Csv object from a SplFileObject.

<?php

public static AbstractCsv::createFromFileObject(SplFileObject $obj): AbstractCsv

This method accepts only one single parameter, a SplFileObject object.

<?php

use League\Csv\Reader;
use League\Csv\Writer;

$reader = Reader::createFromFileObject(new SplFileObject('/path/to/your/csv/file.csv'));
$writer = Writer::createFromFileObject(new SplTempFileObject());

AbstractCsv::createFromString

This named constructor will create a new object from a given string.

<?php

public static AbstractCsv::createFromString(mixed $str): AbstractCsv

This method accepts only one single parameter, an object implementing the __toString method or a string.

<?php

use League\Csv\Reader;
use League\Csv\Writer;

$reader = Reader::createFromString('john,doe,john.doe@example.com');
$writer = Writer::createFromString('john,doe,john.doe@example.com');

Switching from one class to the other

At any given time you can switch or create a new League\Csv\Writer or a new League\Csv\Reader from the current object. to do so you can use the following methods.

Both methods accept an optional $open_mode parameter.

<?php

public AbstractCsv::newReader(string $open_mode = 'r+'): Reader
public AbstractCsv::newWriter(string $open_mode = 'r+'): Writer
<?php

$reader = $writer->newReader('r+');
$newWriter = $reader->newWriter('a');
$anotherWriter = $newWriter->newWriter('r+');

Warning: be careful the $newWriter and $anotherWriter object are not the same as the $writer object!