PHP: SplFileObject::setCsvControl - Manual

(PHP 5 >= 5.2.0, PHP 7, PHP 8)

SplFileObject::setCsvControl — Set the delimiter, enclosure and escape character for CSV

Description

public function SplFileObject::setCsvControl(string $separator = ",", string $enclosure = "\"", string $escape = "\\"): void

Parameters

separator

The separator parameter sets the field separator. It must be a single byte character.

enclosure

The enclosure parameter sets the field enclosure character. It must be a single byte character.

escape

The escape parameter sets the escape character. It must be a single byte character or the empty string. The empty string ("") disables the proprietary escape mechanism.

Warning

In the input stream, the enclosure character can always be escaped by doubling it inside a quoted string, resulting in a single enclosure character in the parsed result. The escape character works differently: If a sequence of escape and enclosure characters appear in the input, both characters will be present in the parsed result. So for the default parameters, a CSV line like "a""b","c\"d" will have the fields parsed as a"b and c\"d, respectively.

Warning

As of PHP 8.4.0, depending on the default value of escape is deprecated. It needs to be provided explicitly either positionally or by the use of named arguments.

Return Values

No value is returned.

Errors/Exceptions

Throws a ValueError if separator or enclosure is not one byte long.

Throws a ValueError if escape is not one byte long or the empty string.

Changelog

Examples

<?php
$file = new SplFileObject("data.csv");
$file->setFlags(SplFileObject::READ_CSV);
$file->setCsvControl('|');
foreach ($file as $row) {
    list ($fruit, $quantity) = $row;
    // Do something with values
}
?>

<?php
apples|20
bananas|14
cherries|87
?>

See Also

• SplFileObject::getCsvControl() - Get the delimiter, enclosure and escape character for CSV
• SplFileObject::fgetcsv() - Gets line from file and parse as CSV fields
• SplFileObject::fputcsv() - Write a field array as a CSV line
• fputcsv() - Format line as CSV and write to file pointer
• fgetcsv() - Gets line from file pointer and parse for CSV fields
• str_getcsv() - Parse a CSV string into an array