fgetcsv
Gets line from file pointer and parse for CSV fields
Description
arrayfalse fgetcsv(
resource $stream,
intnull $length = null,
string $separator = ",",
string $enclosure = "\"",
string $escape = "\\"
)
Note:
The locale settings are taken into account by this function.
For example, data encoded in certain one-byte encodings may be parsed
incorrectly if LC_CTYPE is
en_US.UTF-8.
Parameters
-
stream
-
A valid file pointer to a file successfully opened by
fopen, popen, or
fsockopen.
-
length
-
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.
Omitting this parameter (or setting it to 0,
or null in PHP 8.0.0 or later) the maximum line length is not limited,
which is slightly slower.
-
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 CVS 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.
Warning
When escape is set to anything other than an empty string
("") it can result in CSV that is not compliant with
» RFC 4180 or unable to survive a roundtrip
through the PHP CSV functions. The default for escape is
"\\" so it is recommended to set it to the empty string explicitly.
The default value will change in a future version of PHP, no earlier than PHP 9.0.
Return Values
Returns an indexed array containing the fields read on success, or false on failure.
Note:
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.
Note: If PHP is not properly recognizing
the line endings when reading files either on or created by a Macintosh
computer, enabling the
auto_detect_line_endings
run-time configuration option may help resolve the problem.
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.
Examples
Example #1 Read and print the entire contents of a CSV file
<?php
$row = 1;
if (($handle = fopen("test.csv", "r")) !== FALSE) {
while (($data = fgetcsv($handle, 1000, ",")) !== FALSE) {
$num = count($data);
echo "<p> $num fields in line $row: <br /></p>\n";
$row++;
for ($c=0; $c < $num; $c++) {
echo $data[$c] . "<br />\n";
}
}
fclose($handle);
}
?>
See Also
- fputcsv
- str_getcsv
- SplFileObject::fgetcsv
- SplFileObject::fputcsv
- SplFileObject::setCsvControl
- SplFileObject::getCsvControl
- explode
- file
- pack