fputcsv

(PHP 5 >= 5.1.0)

fputcsv — Format line as CSV and write to file pointer

Beschreibung

int fputcsv ( resource $handle , array $fields [, string $delimiter = ',' [, string $enclosure = '"' ]] )

fputcsv() formats a line (passed as a fields array) as CSV and write it (terminated by a newline) to the specified file handle.

Parameter-Liste

handle: Der Zeiger auf eine Datei muss gültig sein und auf eine Datei verweisen, die vorher erfolgreich mit fopen() oder fsockopen() geöffnet (und nicht bereits von fclose() geschlossen) wurde.
fields: An array of values.
delimiter: The optional delimiter parameter sets the field delimiter (one character only).
enclosure: The optional enclosure parameter sets the field enclosure (one character only).

Rückgabewerte

Returns the length of the written stringIm Fehlerfall wird FALSE zurückgegeben..

Beispiele

Beispiel #1 fputcsv() example


<?php

$list = array (
    array('aaa', 'bbb', 'ccc', 'dddd'),
    array('123', '456', '789'),
    array('"aaa"', '"bbb"')
);

$fp = fopen('file.csv', 'w');

foreach ($list as $fields) {
    fputcsv($fp, $fields);
}

fclose($fp);
?>

The above example will write the following to file.csv:

aaa,bbb,ccc,dddd
123,456,789
"""aaa""","""bbb"""

Anmerkungen

Hinweis: Wenn Sie Probleme damit haben, dass PHP Zeilenendezeichen nicht erkennt, entweder beim Lesen von Dateien auf einem Macintosh oder bei Dateien, die auf einem Macintosh erstellt wurden, können Sie die Option auto_detect_line_endings aktivieren.

Siehe auch

fgetcsv() - Liest eine Zeile von der Position des Dateizeigers und prüft diese auf Komma-Separierte-Werte (CSV)

add a note User Contributed Notes
fputcsv

enzo dot d dot a at example dot com
26-Jun-2007 12:08


Compact fputcsv function(), for Php version >= 4.0.5 and < 5.1.

Not a "good programming practice", but if you need save bytes ...



function fputcsv($fp, $arr, $del=",", $enc="\"") {

    fwrite($fp, (count($arr)) ? $enc . implode("{$enc}{$del}{$enc}", str_replace("\"", "\"\"", $arr)) . $enc . "\n" : "\n");

}

bl at mindbench dot nl
26-Mar-2007 10:55


If you need to save the output to a variable (e.g. for use within a framework) you can write to a temporary memory-wrapper and retrieve it's contents:



<?php

// output up to 5MB is kept in memory, if it becomes bigger it will automatically be written to a temporary file

$csv = fopen('php://temp/maxmemory:'. (5*1024*1024), 'r+');



fputcsv($csv, array('blah','blah'));



rewind($csv);



// put it all in a variable

$output = stream_get_contents($csv);

?>

MagicalTux at ooKoo dot org
18-Jan-2007 03:08


If you need to send a CSV file directly to the browser, without writing in an external file, you can open the output and use fputcsv on it..



<?php

$out = fopen('php://output', 'w');

fputcsv($out, array('this','is some', 'csv "stuff", you know.'));

fclose($out);

?>

03-Aug-2006 02:09


It's unrealistic to require the field enclosure to be one character because it's very common to have "empty string" as the field delimiter (especially when TAB is used as field delimiter).



I tried to use "\0" as the field enclosure, hoping that'd be interpreted as an empty string, but fputcsv (in PHP5) translated it into literal.



By the way, fputcsv wrongly adds the field enclosures whenever a field contains a space. The expected behavior should be adding the field enclosures when a field contains a field delimiter.

heather at heathercash dot com
26-Sep-2005 01:18


Here is an adaptation to boonerunner's function for fputcsv.

It uses a 2-dimensional array.

Each sub-array is a line in the csv file which then ends up being seperated by commas.



function fputcsv($filePointer,$dataArray,$delimiter=",",$enclosure="\""){

    // Write a line to a file

    // $filePointer = the file resource to write to

    // $dataArray = the data to write out

    // $delimeter = the field separator

     

    // Build the string

    $string = "";

  

    // for each array element, which represents a line in the csv file...

    foreach($dataArray as $line){



        // No leading delimiter

        $writeDelimiter = FALSE;

        

        foreach($line as $dataElement){ 

            // Replaces a double quote with two double quotes

            $dataElement=str_replace("\"", "\"\"", $dataElement);

            

            // Adds a delimiter before each field (except the first)

            if($writeDelimiter) $string .= $delimiter;

            

            // Encloses each field with $enclosure and adds it to the string

            $string .= $enclosure . $dataElement . $enclosure;

            

            // Delimiters are used every time except the first.

            $writeDelimiter = TRUE;

        }

        // Append new line

        $string .= "\n";



    } // end foreach($dataArray as $line)



    // Write the string to the file

    fwrite($filePointer,$string);

}

boonerunner at hotmail dot com
16-Sep-2005 04:47


Here is an adaption of the above code that adds support for double quotes inside a field. (One double quote is replaced with a pair of double quotes per the CSV format).



<?php

 function fputcsv($filePointer,$dataArray,$delimiter,$enclosure)

  {

  // Write a line to a file

  // $filePointer = the file resource to write to

  // $dataArray = the data to write out

  // $delimeter = the field separator

  

  // Build the string

  $string = "";

  

  // No leading delimiter

  $writeDelimiter = FALSE;

  foreach($dataArray as $dataElement)

   {

    // Replaces a double quote with two double quotes

    $dataElement=str_replace("\"", "\"\"", $dataElement);

    

    // Adds a delimiter before each field (except the first)

    if($writeDelimiter) $string .= $delimiter;

    

    // Encloses each field with $enclosure and adds it to the string

    $string .= $enclosure . $dataElement . $enclosure;

    

    // Delimiters are used every time except the first.

    $writeDelimiter = TRUE;

   } // end foreach($dataArray as $dataElement)

  

  // Append new line

  $string .= "\n";

  

  // Write the string to the file

  fwrite($filePointer,$string);

  }

?>

twebb at boisecenter dot com
21-Jan-2005 02:54


What about cells that span multiple lines?  This function allows for cells to contain newlines:



function fputcsv($handle, $row, $fd=',', $quot='"')

{

   $str='';

   foreach ($row as $cell) 

   {

      $cell = str_replace($quot, $quot.$quot, $cell);

         

      if (strchr($cell, $fd) !== FALSE || strchr($cell, $quot) !== FALSE || strchr($cell, "\n") !== FALSE) 

      {

         $str .= $quot.$cell.$quot.$fd;

      } 

      else 

      {

         $str .= $cell.$fd;

      }

   }



   fputs($handle, substr($str, 0, -1)."\n");



   return strlen($str);

}



I found this reference on the web: 

http://www.creativyst.com/Doc/Articles/CSV/CSV01.htm

drew at zitnay dot com
22-Nov-2004 06:42


I found the following problems with the below function:



- when calling str_replace(), you must assign $cell the return value or nothing gets saved



- when using strchr(), you should explicitly check !== FALSE, or it'll treat a return value of 0 (found the character at string position 0) as FALSE



- Excel seems to quote not only fields containing commas, but fields containing quotes as well, so I've added another strchr() for quotes; I'm not saying Microsoft knows the correct way for sure, but it seems reasonable to me



- the original function put a space after each comma; that might be legal, I don't know, but I've never seen it (and I don't think it is, because then how would you indicate you wanted a field to start with a space other than by quoting it?)



- the original function didn't correctly return the length of the data outputted



Here's the function, fixed up a bit:



function fputcsv($handle, $row, $fd=',', $quot='"')

{

   $str='';

   foreach ($row as $cell) {

       $cell=str_replace(Array($quot,        "\n"),

                         Array($quot.$quot,  ''),

                         $cell);

       if (strchr($cell, $fd)!==FALSE || strchr($cell, $quot)!==FALSE) {

           $str.=$quot.$cell.$quot.$fd;

       } else {

           $str.=$cell.$fd;

       }

   }



   fputs($handle, substr($str, 0, -1)."\n");



   return strlen($str);

}



Drew

arthur.at.korn.ch
19-Nov-2004 06:56


The function in the prior comment doesn't escape quotes in fields, here mine:



function fputcsv($handle, $row, $fd=',', $quot='"')

{

    $str='';

    foreach ($row as $cell) {

        str_replace(Array($quot,        "\n"),

                    Array($quot.$quot,  ''),

                    $cell);

        if (strchr($cell, $fd)) {

            $str.=$quot.$cell.$quot.$fd.' ';

        } else {

            $str.=$cell.$fd.' ';

        }

    }



    fputs($handle, substr($str, 0, -2)."\n");



    return $str-1;

}

arthur at mclean dot ws
11-Nov-2004 11:10


Here's a simplistic fputcsv function that you can use until the real one gets out of CVS:



function fputcsv($filePointer, $dataArray, $delimiter, $enclosure){

      // Write a line to a file

      // $filePointer = the file resource to write to

      // $dataArray = the data to write out

      // $delimeter = the field separator

      

      // Build the string

      $string = "";

      $writeDelimiter = FALSE;

      foreach($dataArray as $dataElement){

        if($writeDelimiter) $string .= $delimiter;

        $string .= $enclosure . $dataElement . $enclosure;

        $writeDelimiter = TRUE;

        } // end foreach($dataArray as $dataElement)

      

      // Append new line

      $string .= "\n";

      

      // Write the string to the file

      fwrite($filePointer, $string);

      

      } // end function fputcsv($filePointer, $dataArray, $delimiter)

add a note

fputs

fpassthru

Last updated: Fri, 18 May 2012