|  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Request #38301 field enclosure behavior in fputcsv
Submitted: 2006-08-03 00:17 UTC Modified: 2018-12-15 13:42 UTC
Avg. Score:4.1 ± 1.1
Reproduced:11 of 11 (100.0%)
Same Version:3 (27.3%)
Same OS:8 (72.7%)
From: programmer at tklee dot com Assigned: cmb (profile)
Status: Closed Package: Filesystem function related
PHP Version: 5.1.4 OS: Linux
Private report: No CVE-ID: None
 [2006-08-03 00:17 UTC] programmer at tklee dot com
Regarding the field enclosure parameter in fputcsv...

1. 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 translated it into literal.

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

Reproduce code:
test_in.csv has only one line:
$line = "field 0\tfield_1\tfield 2\n";


// since "" is not accepted as the 4th parameter, I use "\0" instead
$fields = fgetcsv($fh_in, 0, "\t", "\0");
fputcsv($fh_out, $fields, "\t", "\0");


Expected result:
One would expect to see in test_out.csv :
$line = "field 0\tfield_1\tfield_2\n";

Actual result:
However, the result shows:
$line = "\0field 0\0\tfield_1\t\0field 2\0\n";

1. Since space is not the field delimiter, there is no point of using the field enclosure.

2. Empty enclosure is very common and should be accepted.


Add a Patch

Pull Requests

Add a Pull Request


AllCommentsChangesGit/SVN commitsRelated reports
 [2014-12-02 23:57 UTC]
-Package: Feature/Change Request +Package: *General Issues
 [2014-12-02 23:57 UTC]
As far as expected behaviour goes, RFC 4180 states:

> Each field may or may not be enclosed in double quotes

Also, there's a provision that states:

> Spaces are considered part of a field and should not be ignored.

That said, while I agree that spaces (or tabs, if not the delimiter) in a field do not strictly require an enclosure (unlike newlines or the enclosure character itself), the only thing coming close to a standard doesn't forbid it.
 [2014-12-04 08:09 UTC] programmer at tklee dot com
Wow! After 8.5 years! That's dedication!

Thank you for your answer to issue 2.

If we can address issue 1, then issue 2 can be solved at the same time. Allowing "" to be the quote char is actually a closer implementation of RFC 4180. Users can choose whether or not to enclose the field with something.

In short, can we accept "" as the 4th parameter of fputcsv?

Thanks for reconsidering.
 [2018-02-11 17:55 UTC]
-Package: *General Issues +Package: Filesystem function related
 [2018-09-13 12:36 UTC]
<> would implement this
feature request.
 [2018-12-15 13:42 UTC]
-Status: Open +Status: Closed -Assigned To: +Assigned To: cmb
 [2018-12-15 13:42 UTC]
Implemented as commit 3b0f051[1]; available as of PHP 7.4.0.

[1] <;a=commit;h=3b0f05119383fe21ee75adaed3d0239ba8976aef>.
PHP Copyright © 2001-2023 The PHP Group
All rights reserved.
Last updated: Sat Sep 30 01:01:24 2023 UTC