fgetcsv
(PHP 4, PHP 5, PHP 7)
fgetcsv — Gets line from file pointer and parse for CSV fields
Description
$handle
[, int $length
= 0
[, string $delimiter
= ","
[, string $enclosure
= '"'
[, string $escape
= "\\"
]]]] ) : arraySimilar to fgets() except that fgetcsv() parses the line it reads for fields in CSV format and returns an array containing the fields read.
Note:
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.
Parameters
-
handle
-
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 in PHP 5.1.0 and later) the maximum line length is not limited, which is slightly slower.
-
delimiter
-
The optional
delimiter
parameter sets the field delimiter (one character only). -
enclosure
-
The optional
enclosure
parameter sets the field enclosure character (one character only). -
escape
-
The optional
escape
parameter sets the escape character (at most one character). An empty string ("") disables the proprietary escape mechanism.Note: 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.
Return Values
Returns an indexed array containing the fields read.
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.
fgetcsv() returns NULL
if an invalid
handle
is supplied or FALSE
on other errors,
including end of file.
Changelog
Version | Description |
---|---|
7.4.0 |
The escape parameter now also accepts an empty
string to disable the proprietary escape mechanism.
|
5.3.0 |
The escape parameter was added
|
5.1.0 |
The length is now optional.
Default is 0, meaning no length limit.
|
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
- str_getcsv() - Parse a CSV string into an array
- explode() - Split a string by a string
- file() - Reads entire file into an array
- pack() - Pack data into binary string
- fputcsv() - Format line as CSV and write to file pointer
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-function.fgetcsv.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.