fgetcsv

Gets line from file pointer and parse for CSV fields

Syntax

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

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, 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.

Return

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.

Examples

1 · handle

<?

$filename = $_SERVER["DOCUMENT_ROOT"] . "/assets/csv/file.csv";
$mode = "r";

$handle = fopen($filename, $mode);

    $return = fgetcsv($handle);

    print_r($return);

fclose($handle);

?>
Array
(
    [0] => H e 'l ''l''' o
)

2 · length

<?

$filename = $_SERVER["DOCUMENT_ROOT"] . "/assets/csv/file.csv";
$mode = "r";

$handle = fopen($filename, $mode);

    $length = 3;

    $return = fgetcsv($handle, $length);

    print_r($return);

fclose($handle);

?>
Array
(
    [0] => H e
)

3 · delimiter

<?

$filename = $_SERVER["DOCUMENT_ROOT"] . "/assets/csv/file.csv";
$mode = "r";

$handle = fopen($filename, $mode);

    $length = 0;
    $delimiter = " ";

    $return = fgetcsv($handle, $length, $delimiter);

    print_r($return);

fclose($handle);

?>
Array
(
    [0] => H
    [1] => e
    [2] => 'l
    [3] => ''l'''
    [4] => o
)

4 · enclosure

<?

$filename = $_SERVER["DOCUMENT_ROOT"] . "/assets/csv/file.csv";
$mode = "r";

$handle = fopen($filename, $mode);

    $length = 0;
    $delimiter = " ";
    $enclosure = "'";

    $return = fgetcsv($handle, $length, $delimiter, $enclosure);

    print_r($return);

fclose($handle);

?>
Array
(
    [0] => H
    [1] => e
    [2] => l 'l'
    [3] => o
)

5 · escape

<?

$filename = $_SERVER["DOCUMENT_ROOT"] . "/assets/csv/file.csv";
$mode = "r";

$handle = fopen($filename, $mode);

    $length = 0;
    $delimiter = " ";
    $enclosure = "'";
    $escape = "'";

    $return = fgetcsv($handle, $length, $delimiter, $enclosure, $escape);

    print_r($return);

fclose($handle);

?>
Array
(
    [0] => H
    [1] => e
    [2] => l 'l'
    [3] => o
)

basename

chgrp

chmod

chown

clearstatcache

copy

dirname

disk_free_space

disk_total_space

diskfreespace

fclose

feof

fflush

fgetc

fgets

file

file_exists

file_get_contents

file_put_contents

fileatime

filectime

filegroup

fileinode

filemtime

fileowner

fileperms

filesize

filetype

flock

fnmatch

fopen

fpassthru

fputcsv

fputs

fread

fscanf

fseek

fstat

ftell

ftruncate

fwrite

glob

is_dir

is_executable

is_file

is_link

is_readable

is_uploaded_file

is_writable

is_writeable

lchgrp

lchown

link

linkinfo

lstat

mkdir

move_uploaded_file

pathinfo

pclose

popen

readfile

readlink

realpath

realpath_cache_get

realpath_cache_size

rename

rewind

rmdir

set_file_buffer

stat

symlink

tempnam

tmpfile

touch

umask

unlink

PHP

Home Menu