The League of Extraordinary Packages

Our Packages:

Presented by The League of Extraordinary Packages

Getting Started

Connections Settings

Inserting Records

Selecting Records

Interoperability

Converting Records

Upgrading Guide

Charset conversion

<?php

class CharsetConverter extends php_user_filter
{
    public function __invoke(array $record): array
    public static function addTo(AbstractCsv $csv, string $input_encoding, string $output_encoding): AbstractCsv
    public function convert(iterable $records): iterable
    public static function getFiltername(string $input_encoding, string $output_encoding): string
    public function inputEncoding(string $input_encoding): self
    public function outputEncoding(string $output_encoding): self
    public static function register(): void
}

The CharsetConverter class converts your CSV records using the mbstring extension and its supported character encodings.

Settings

<?php

public CharsetConverter::inputEncoding(string $input_encoding): self
public CharsetConverter::outputEncoding(string $output_encoding): self

The inputEncoding and outputEncoding methods sets the object encoding properties. By default, the input encoding and the output encoding are set to UTF-8.

When building a CharsetConverter object, the methods do not need to be called in any particular order, and may be called multiple times. Because the CharsetConverter is immutable, each time its setter methods are called they return a new object without modifying the current one.

If the submitted charset is not supported by the mbstring extension an OutOfRangeException will be thrown.

Conversion

<?php

public CharsetConverter::convert(iterable $records): iterable

CharsetConverter::convert converts the collection of records according to the encoding settings.

<?php

use League\Csv\CharsetConverter;

$csv = new SplFileObject('/path/to/french.csv', 'r');
$csv->setFlags(SplFileObject::READ_CSV | SplFileObject::SKIP_EMPTY);

$encoder = (new CharsetConverter())->inputEncoding('iso-8859-15');
$records = $encoder->convert($csv);

The resulting data is converted from iso-8859-15 to the default UTF-8 since no output encoding charset was set using the CharsertConverter::outputEncoding method.

CharsetConverter as a Writer formatter

<?php

public CharsetConverter::__invoke(array $record): array

Using the CharsetConverter::__invoke method, you can register a CharsetConverter object as a record formatter using Writer::addFormatter method.

<?php

use League\Csv\CharsetConverter;
use League\Csv\Writer;

$encoder = (new CharsetConverter())
    ->inputEncoding('utf-8')
    ->outputEncoding('iso-8859-15')
;

$writer = Writer::createFromPath('/path/to/your/csv/file.csv');
$writer->addFormatter($encoder);

$writer->insertOne(["foo", "bébé", "jouet"]);
//all 'utf-8' caracters are now automatically encoded into 'iso-8859-15' charset

CharsetConverter as a PHP stream filter

<?php

public static CharsetConverter::addTo(AbstractCsv $csv, string $input_encoding, string $output_encoding): AbstractCsv
public static CharsetConverter::register(): void
public static CharsetConverter::getFiltername(string $input_encoding, string $output_encoding): string

Usage with CSV objects

If your CSV object supports PHP stream filters then you can use the CharsetConverter class as a PHP stream filter and use the library stream filtering mechanism instead.

The CharsetConverter::addTo static method:

<?php

use League\Csv\CharsetConverter;
use League\Csv\Writer;

$writer = Writer::createFromPath('/path/to/your/csv/file.csv');
CharsetConverter::addTo($writer, 'utf8', 'iso-8859-15');

$writer->insertOne(["foo", "bébé", "jouet"]);
//all 'utf-8' caracters are now automatically encoded into 'iso-8859-15' charset

Usage with PHP stream resources

To use this stream filter outside League\Csv objects you need to:

<?php

use League\Csv\CharsetConverter;

CharsetConverter::register();

$resource = fopen('/path/to/my/file', 'r');
$filter = stream_filter_append(
	$resource,
	CharsetConverter::getFiltername('utf-8', 'iso-8859-15'),
	STREAM_FILTER_READ
);

while (false !== ($record = fgetcsv($resource))) {
    //$record is correctly encoded
}

If your system supports the iconv extension you should use PHP's built in iconv stream filters instead for better performance.