fgetcsv

Gets line from file pointer and parse for CSV fields.

fgetcsv Function synopsis

fgetcsv(
    $stream,
    ?int $length = null,
    string $separator = ",",
    string $enclosure = "\"",
    string $escape = "\\"
  ): array|false

Parameters

$stream

A valid file pointer to a file successfully opened by fopen, popen, or fsockopen.

$length

OptionalType?intDefault valuenull

Must be greater than the longest line (in characters) to be found in the CSV file (allowing for trailing line-end characters). Otherwise the line is split in chunks of $length characters, unless the split would occur inside an enclosure.

$separator

OptionalTypestringDefault value","

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

$enclosure

OptionalTypestringDefault value"\""

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

$escape

OptionalTypestringDefault value"\"

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.

Return value

Typearray|false

Returns an indexed array containing the fields read on success, or false on failure.

A blank line in a CSV file will be returned as an array
comprising a single `null` field, and will not be treated
as an error.