(PHP 4, PHP 5, PHP 7, PHP 8)
fgetcsv — Gets line from file pointer and parse for CSV fields
$stream
,$length
= null
,$separator
= ",",$enclosure
= "\"",$escape
= "\\"Similar to fgets() except that fgetcsv() parses the line it reads for fields in CSV format and returns an array containing the fields read.
Зауваження:
The locale settings are taken into account by this function. If
LC_CTYPE
is e.g.en_US.UTF-8
, files in one-byte encodings may be read wrongly by this function.
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 optional separator
parameter sets the field separator (one single-byte character only).
enclosure
The optional enclosure
parameter sets the field enclosure character (one single-byte character only).
escape
The optional escape
parameter sets the escape character (at most one single-byte character).
An empty string (""
) disables the proprietary escape mechanism.
Зауваження: Usually an
enclosure
character is escaped inside a field by doubling it; however, theescape
character can be used as an alternative. So for the default parameter values""
and\"
have the same meaning. Other than allowing to escape theenclosure
character theescape
character has no special meaning; it isn't even meant to escape itself.
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.
Returns an indexed array containing the fields read on success, або false
в разі помилки.
Зауваження:
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.
Зауваження: Якщо виникають проблеми з розпізнаванням закінчення рядків під час читання чи створення файлів на компʼютері Macintosh, може допомогти застосування директиви auto_detect_line_endings під час виконання.
Версія | Опис |
---|---|
8.0.0 |
length is now nullable.
|
7.4.0 |
The escape parameter now also accepts an empty
string to disable the proprietary escape mechanism.
|
Приклад #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);
}
?>