fgetcsv

(PHP 4, PHP 5, PHP 7)

fgetcsvGets line from file pointer and parse for CSV fields

Descrierea

fgetcsv ( resource $handle [, int $length = 0 [, string $delimiter = "," [, string $enclosure = '"' [, string $escape = "\\" ]]]] ) : array

Similar to fgets() except that fgetcsv() parses the line it reads for fields in CSV format and returns an array containing the fields read.

Notă:

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.

Parametri

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.

Notă: Usually an enclosure character is escaped inside a field by doubling it; however, the escape character can be used as an alternative. So for the default parameter values "" and \" have the same meaning. Other than allowing to escape the enclosure character the escape character has no special meaning; it isn't even meant to escape itself.

Valorile întoarse

Returns an indexed array containing the fields read.

Notă:

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.

Notă: Dacă PHP nu recunoaște corect terminațiile liniilor atunci când citește fișiere pe, sau create pe un computer Macintosh, atunci activarea opțiunii de configurare la rulare auto_detect_line_endings ar trebui să ajute la soluționarea problemei.

fgetcsv() returns NULL if an invalid handle is supplied or FALSE on other errors, including end of file.

Istoricul schimbărilor

Versiune Descriere
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.

Exemple

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($handle1000",")) !== 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);
}
?>

A se vedea și

  • 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