The League of Extraordinary Packages

Our Packages:

Presented by The League of Extraordinary Packages

Getting Started

The API

Upgrading Guide

Inserting Data

To create or update a CSV use the following League\Csv\Writer methods.

When creating a file using the library, first insert all the data that need to be inserted before starting manipulating the CSV. If you manipulate your data before insertion, you may change the file cursor position and get unexpected results.

Adding new data

The Writer class performs a number of actions while inserting your data into the CSV. When submitting data for insertion the class will proceed as describe below for each row.

The Writer class will:

To add new data to your CSV the Writer class uses the following methods

Writer::insertOne

insertOne inserts a single row.

<?php

public Writer::insertOne(mixed $row): Writer

This method takes a single argument $row which can be

Example

<?php

use League\Csv\Writer;

class ToStringEnabledClass
{
    private $str;

    public function __construct($str)
    {
        $this->str = $str;
    }

    public function __toString()
    {
        return $this->str;
    }
}

$writer = Writer::createFromFileObject(new SplTempFileObject());
$writer->insertOne(['john', 'doe', 'john.doe@example.com']);
$writer->insertOne("'john','doe','john.doe@example.com'");
$writer->insertOne(new ToStringEnabledClass("john,doe,john.doe@example.com"))

Writer::insertAll

insertAll inserts multiple rows.

<?php

public Writer::insertAll(mixed $rows): Writer

This method takes a single argument $row which can be

to add several rows to the CSV data.

Example

<?php

use League\Csv\Writer;

$rows = [
    [1, 2, 3],
    ['foo', 'bar', 'baz'],
    "'john','doe','john.doe@example.com'",
    new ToStringEnabledClass("john,doe,john.doe@example.com")
];

$writer = Writer::createFromFileObject(new SplTempFileObject());
$writer->insertAll($rows); //using an array
$writer->insertAll(new ArrayIterator($rows)); //using a Traversable object

Row formatting

CSV Formatter

A formatter is a callable which accepts an array on input and returns the same array formatted according to its inner rules.

<?php

function(array $row): array

You can attach as many formatters as you want to the Writer class to manipulate your data prior to its insertion. The formatters follow the First In First Out rule when inserted, deleted and/or applied.

Formatter API

The formatter API comes with the following public API:

<?php

public Writer::addFormatter(callable $callable): Writer
public Writer::removeFormatter(callable $callable): Writer
public Writer::hasFormatter(callable $callable): bool
public Writer::clearFormatters(void): Writer
<?php

use League\Csv\Writer;

$formatter = function ($row) {
    return array_map('strtoupper', $row);
};
$writer = Writer::createFromFileObject(new SplTempFileObject());
$writer->addFormatter($formatter);
$writer->insertOne(['john', 'doe', 'john.doe@example.com']);

$writer->__toString();
//will display something like JOHN,DOE,JOHN.DOE@EXAMPLE.COM

Row validation

CSV validator

A validator is a callable which takes a array as its sole argument and returns a boolean.

<?php

function(array $row): bool

The validator must return true to validate the submitted row.

Any other expression, including thruthy ones like yes, 1,… will make the insertOne method throw an League\Csv\Exception\InvalidRowException.

As with the new formatter capabilities, you can attach as many validators as you want to your data prior to its insertion. The row data is checked against your supplied validators after being formatted.

Validator API

The validator API comes with the following public API:

<?php

public Writer::addValidator(callable $callable, string $validatorName): Writer
public Writer::removeValidator(string $validatorName): Writer
public Writer::hasValidator(string $validatorName): bool
public Writer::clearValidators(void): Writer

Validation failed

If the validation failed a League\Csv\Exception\InvalidRowException is thrown by the Writer object. This exception extends PHP’s InvalidArgumentException by adding two public getter methods

<?php

public InvalidRowException::getName(void): string
public InvalidRowException::getData(void): array

Validation example

<?php

use League\Csv\Writer;
use League\Csv\Exception\InvalidRowException;

$writer->addValidator(function (array $row) {
    return 10 == count($row);
}, 'row_must_contain_10_cells');
try {
    $writer->insertOne(['john', 'doe', 'john.doe@example.com']);
} catch (InvalidRowException $e) {
    echo $e->getName(); //display 'row_must_contain_10_cells'
    $e->getData();//will return the invalid data ['john', 'doe', 'john.doe@example.com']
}

Stream filtering

Some data formatting can still occur while writing the data to the CSV document after validation using the Stream Filters capabilities.

Handling newline

Because the php fputcsv implementation has a hardcoded \n, we need to be able to replace the last LF code with one supplied by the developper for more interoperability between CSV packages on different platforms. The newline sequence will be appended to each CSV newly inserted line.

At any given time you can get and modify the $newline property using the getNewline and setNewline methods described in CSV properties documentation page.

<?php

use League\Csv\Writer;

$writer = Writer::createFromFileObject(new SplFileObject());
$newline = $writer->getNewline(); // equals "\n";
$writer->setNewline("\r\n");
$newline = $writer->getNewline(); // equals "\r\n";
$writer->insertOne(["one", "two"]);
echo $writer; // displays "one,two\r\n";

Please refer to the BOM character dedicated documentation page for more informations on how the library manage the BOM character.