Gets line from file and parse as CSV fields

SplFileObject::fgetc
SplFileObject::fgets
SplFileObject
PHP Manual

# SplFileObject::fgetcsv

(PHP 5 >= 5.1.0)

SplFileObject::fgetcsv — Gets line from file and parse as CSV fields

### Description

public array SplFileObject::fgetcsv ([ string `$delimiter` = "," [, string `$enclosure` = "\"" [, string `$escape` = "\\" ]]] )

Gets a line from the file which is in CSV format and returns an array containing the fields read.

### Parameters

`delimiter`

  The field delimiter (one character only). Defaults as a comma or the value set using SplFileObject::setCsvControl.

`enclosure`

  The field enclosure character (one character only). Defaults as a double quotation mark or the value set using SplFileObject::setCsvControl.

`escape`

  The escape character (one character only). Defaults as a backslash (\) or the value set using SplFileObject::setCsvControl.

### Return Values

Returns an indexed array containing the fields read, or `FALSE` on error.

> Note: A blank line in a CSV file will be returned as an array comprising a single `NULL` field unless using `SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE`, in which case empty lines are skipped.

### Examples

Example #1 SplFileObject::fgetcsv example

`<?php
$file = new SplFileObject("data.csv");
while (!$file->eof()) {
var_dump($file->fgetcsv());
}
?>`

Example #2 `SplFileObject::READ_CSV` example

`<?php
$file = new SplFileObject("animals.csv");
$file->setFlags(SplFileObject::READ_CSV);
foreach ($file as $row) {
list($animal, $class, $legs) = $row;
printf("A %s is a %s with %d legs\n", $animal, $class, $legs);
}
?>`

Contents of animals.csv

    crocodile,reptile,4
    dolphin,mammal,0
    duck,bird,2
    koala,mammal,4
    salmon,fish,0

The above example will output something similar to:

    A crocodile is a reptile with 4 legs
    A dolphin is a mammal with 0 legs
    A duck is a bird with 2 legs
    A koala is a mammal with 4 legs
    A salmon is a fish with 0 legs

### See Also

- SplFileObject::setCsvControl - Set the delimiter and enclosure character for CSV
- SplFileObject::setFlags - Sets flags for the SplFileObject
- SplFileObject::READ_CSV
- SplFileObject::current - Retrieve current line of file

SplFileObject::fgetc
SplFileObject::fgets
SplFileObject
PHP Manual