Fix bug #67566: escape parameter in fgetcsv() is sometimes ignored

We clarify the actual meaning of $escape.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344268 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2018-02-15 17:04:23 +00:00
parent 47da3a2a8a
commit 9421e06e34
3 changed files with 36 additions and 0 deletions

View file

@ -76,6 +76,18 @@
<para>
The optional <parameter>escape</parameter> parameter sets the escape character (one character only).
</para>
<note>
<simpara>
Usually an <parameter>enclosure</parameter> character is escpaped inside
a field by doubling it; however, the <parameter>escape</parameter>
character can be used as an alternative. So for the default parameter
values <literal>""</literal> and <literal>\"</literal> have the same
meaning. Other than allowing to escape the
<parameter>enclosure</parameter> character the
<parameter>escape</parameter> character has no special meaning; it isn't
even meant to escape itself.
</simpara>
</note>
</listitem>
</varlistentry>
</variablelist>

View file

@ -46,6 +46,18 @@
<para>
The escape character (one character only). Defaults as a backslash (<literal>\</literal>) or the value set using <methodname>SplFileObject::setCsvControl</methodname>.
</para>
<note>
<simpara>
Usually an <parameter>enclosure</parameter> character is escpaped inside
a field by doubling it; however, the <parameter>escape</parameter>
character can be used as an alternative. So for the default parameter
values <literal>""</literal> and <literal>\"</literal> have the same
meaning. Other than allowing to escape the
<parameter>enclosure</parameter> character the
<parameter>escape</parameter> character has no special meaning; it isn't
even meant to escape itself.
</simpara>
</note>
</listitem>
</varlistentry>
</variablelist>

View file

@ -58,6 +58,18 @@
Set the escape character (one character only). Defaults as a backslash
(<literal>\</literal>)
</para>
<note>
<simpara>
Usually an <parameter>enclosure</parameter> character is escpaped inside
a field by doubling it; however, the <parameter>escape</parameter>
character can be used as an alternative. So for the default parameter
values <literal>""</literal> and <literal>\"</literal> have the same
meaning. Other than allowing to escape the
<parameter>enclosure</parameter> character the
<parameter>escape</parameter> character has no special meaning; it isn't
even meant to escape itself.
</simpara>
</note>
</listitem>
</varlistentry>
</variablelist>