LeagueCSV

Versions

Getting Started

The API

This is the documentation for version 8.0 which will be supported until 2018-02-18. Please consider upgrading your code to the latest stable version

Upgrading from 7.x to 8.x

Installation

If you are using composer then you should update the require section of your composer.json file.

composer require league/csv:^8.0

This will edit (or create) your composer.json file.

Added features

Reader::fetchPairs and Reader::fetchPairsWithoutDuplicates

To complements the Reader extract methods the following methods are added:

Please refer to the documentation for more information.

Backward Incompatible Changes

PHP required version

Csv 8.0.0 is the first major version to remove support for PHP 5.4.

Remove optional argument to createFromString

In version 8.0 the optional second argument from createFromString is removed. If your code relied on it you can use the following snippet:

Old code:

use League\Csv\Writer;

$writer = Writer::createFromString($str, "\r\n");
$writer->insertOne(["foo", null, "bar"]);

New code:

use League\Csv\Writer;

$writer = Writer::createFromString($str);
$writer->setNewline("\r\n")
$writer->insertOne(["foo", null, "bar"]);

Remove SplFileObject flags usage

In version 8.0 you can no longer set SplFileObject flags the following methods are remove:

The SplFileObject flags are normalized to have a normalized CSV filtering independent of the underlying PHP engine use (HHVM or Zend).

Old code:

use League\Csv\Reader;

$csv = Reader::createFromPath('/path/to/file.csv', 'r');
$csv->setFlags(SplFileObject::READ_AHEAD | SplFileObject::SKIP_EMPTY);
$csv->fetchAssoc(); //empty lines where removed

New code:

use League\Csv\Reader;

$csv = Reader::createFromPath('/path/to/file.csv', 'r');
$csv->fetchAssoc(); //empty lines are automatically removed

fetchAssoc and fetchColumn return Iterator

Reader::fetchAssoc and Reader::fetchColumn no longer return an array but instead an Iterator.

Old code:

use League\Csv\Reader;

$csv = Reader::createFromPath('/path/to/file.csv', 'r');
$res = $csv->fetchAssoc(['lastname', 'firstname']);

echo $res[0]['lastname']; //would return the first row 'lastname' index

New code:

use League\Csv\Reader;

$csv = Reader::createFromPath('/path/to/file.csv', 'r');
$res = $csv->fetchAssoc(['lastname', 'firstname']);

echo iterator_to_array($res, false)[0]['lastname'];

fetchAssoc callable argument

The optional callable argument from Reader::fetchAssoc now expects its first argument to be an array indexed by the submitted array keys. In all previous versions, the indexation was made after the callable had manipulated the CSV row.

Old code:

use League\Csv\Reader;

$func = function (array $row) {
    $row[1] = strtoupper($row[1]);
    $row[2] = strtolower($row[2]);

    return $row;
};

$csv = Reader::createFromPath('/path/to/file.csv', 'r');
$res = $csv->fetchAssoc(['lastname', 'firstname'], $func);

New code:

use League\Csv\Reader;

$func = function (array $row) {
    $row['lastname'] = strtoupper($row['lastname']);
    $row['firstname'] = strtolower($row['firstname']);

    return $row;
};

$csv = Reader::createFromPath('/path/to/file.csv', 'r');
$res = $csv->fetchAssoc(['lastname', 'firstname'], $func);

fetchColumn callable argument

The optional callable argument from Reader::fetchColumn now expects its first argument to be the selected column value. In all previous versions, the callable first argument was an array.

Old code:

use League\Csv\Reader;

$func = function (array $row) {
    $row[2] = strtoupper($row[2]);

    return $row;
};

$csv = Reader::createFromPath('/path/to/file.csv', 'r');
$res = $csv->fetchColumn(2, $func);

New code:

use League\Csv\Reader;

$func = function ($value) {
    return strtoupper($value);
};

$csv = Reader::createFromPath('/path/to/file.csv', 'r');
$res = $csv->fetchColum(2, $func);

Deprecated methods in 7.0 series, removed in 8.0

Removed methods in 8.0.0