Write a field array as a CSV line

# SplFileObject::fputcsv

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

SplFileObject::fputcsv — Write a field array as a CSV line

### Beschreibung

public function SplFileObject::fputcsv(
array `$fields`,
string `$separator` = ",",
string `$enclosure` = "\"",
string `$escape` = "\\",
string `$eol` = "\n"
): int|false

Writes the `fields` array to the file as a CSV line.

### Parameter-Liste

`fields`

  An array of values.

`separator`

  The field delimiter (one single-byte character only). By default `,` or the value set by a prior call to SplFileObject::setCsvControl().

`enclosure`

  The field enclosure character (one single-byte character only). By default `"` or the value set by a prior call to SplFileObject::setCsvControl().

`escape`

  The escape character (at most one single-byte character). By default `\` or the value set by a prior call to SplFileObject::setCsvControl(). An empty string (`""`) disables the proprietary escape mechanism.

  Warnung

  Im Eingabe Stream kann das `enclosure`-Zeichen immer maskiert werden, indem es innerhalb einer in Anführungszeichen gesetzten Zeichenkette verdoppelt wird, was zu einem einzelnen `enclosure`-Zeichen im geparsten Ergebnis führt. Das `escape`-Zeichen funktioniert anders: wenn eine Sequenz aus `escape`- und `enclosure`-Zeichen in der Eingabe erscheint, werden beide Zeichen im geparsten Ergebnis vorhanden sein. Für die Standardparameter wird also eine CSV-Zeile wie `"a""b","c\"d"` die Felder als `a"b` und `c\"d` parsen.

  Warnung

  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, or by a call to SplFileObject::setCsvControl().

`eol`

  The optional `eol` parameter sets a custom End of Line sequence.

Warnung

Wenn `escape` auf etwas anderes als eine leere Zeichenkette (`""`) gesetzt wird, kann dies zu einer CSV-Datei führen, die nicht mit » RFC 4180 konform ist oder die den Umlauf durch die PHP-CSV-Funktionen nicht übersteht. Der Standardwert für `escape` ist `"\\"`, weshalb empfohlen wird, diesen Parameter explizit auf eine leere Zeichenkette zu setzen. Der Standardwert wird sich in einer zukünftigen Version von PHP ändern, jedoch nicht vor PHP 9.0.

> Hinweis:

> If an `enclosure` character is contained in a field, it will be escaped by doubling it, unless it is immediately preceded by an `escape`.

### Rückgabewerte

Returns the length of the written stringBei einem Fehler wird `false` zurückgegeben..

### Fehler/Exceptions

Wenn `separator` oder `enclosure` nicht ein Byte lang ist, wird ein ValueError geworfen.

Wenn `escape` nicht ein Byte lang oder eine leere Zeichenkette ist, wird ein ValueError geworfen.

### Changelog

Version | Beschreibung
--- | ---
8.4.0 | Sich auf den Standardwert von `escape` zu verlassen, ist nun veraltet.
8.1.0 | The optional `eol` parameter has been added.
7.4.0 | The `escape` parameter now also accepts an empty string to disable the proprietary escape mechanism.

### Beispiele

Beispiel #1 SplFileObject::fputcsv() example

    <?php

    $list = array (
        array('aaa', 'bbb', 'ccc', 'dddd'),
        array('123', '456', '789'),
        array('"aaa"', '"bbb"')
    );

    $file = new SplFileObject('file.csv', 'w');

    foreach ($list as $fields) {
        $file->fputcsv($fields);
    }

    ?>

The above example will write the following to `file.csv`:

    aaa,bbb,ccc,dddd
    123,456,789
    """aaa""","""bbb"""

### Siehe auch

- SplFileObject::fgetcsv() - Gets line from file and parse as CSV fields
- SplFileObject::setCsvControl() - Set the delimiter, enclosure and escape character for CSV
- SplFileObject::getCsvControl() - Get the delimiter, enclosure and escape character for CSV
- fputcsv() - Format line as CSV and write to file pointer
- fgetcsv() - Liest eine Zeile von der Position des Dateizeigers und prüft diese auf kommaseparierte Werte (CSV)
- str_getcsv() - Parst einen CSV-String in ein Array

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open