Add escape_char paramter to fputcsv, formatting consistancy with fgetcsv

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335815 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Matt Li 2015-01-28 05:49:05 +00:00
parent b2640f8900
commit 6501c09ded
2 changed files with 38 additions and 4 deletions

View file

@ -14,7 +14,7 @@
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>delimiter</parameter><initializer>","</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>enclosure</parameter><initializer>'"'</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>escape</parameter><initializer>"\\"</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>escape</parameter><initializer>"\"</initializer></methodparam>
</methodsynopsis>
<para>
Similar to <function>fgets</function> except that
@ -54,7 +54,7 @@
<term><parameter>delimiter</parameter></term>
<listitem>
<para>
Set the field delimiter (one character only).
The optional <parameter>delimiter</parameter> parameter sets the field delimiter (one character only).
</para>
</listitem>
</varlistentry>
@ -62,7 +62,7 @@
<term><parameter>enclosure</parameter></term>
<listitem>
<para>
Set the field enclosure character (one character only).
The optional <parameter>enclosure</parameter> parameter sets the field enclosure character (one character only).
</para>
</listitem>
</varlistentry>
@ -70,7 +70,7 @@
<term><parameter>escape</parameter></term>
<listitem>
<para>
Set the escape character (one character only). Defaults as a backslash.
The optional <parameter>escape</parameter> parameter sets the escape character (one character only).
</para>
</listitem>
</varlistentry>

View file

@ -14,6 +14,7 @@
<methodparam><type>array</type><parameter>fields</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>delimiter</parameter><initializer>","</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>enclosure</parameter><initializer>'"'</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>escape_char</parameter><initializer>"\"</initializer></methodparam>
</methodsynopsis>
<para>
<function>fputcsv</function> formats a line (passed as a
@ -58,6 +59,15 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>escape_char</parameter></term>
<listitem>
<para>
The optional <parameter>escape_char</parameter> parameter sets the
escape character (one character only).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@ -69,6 +79,30 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.5.4</entry>
<entry>
The <parameter>escape_char</parameter> parameter was added
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>