sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-17 01:18:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Match fgetcsv parameter names to values in reflection

Browse source 
The documented parameters differ from the names exposed in reflection/source code. Now that named parameters are supported in PHP 8, this discrepancy is confusing and impactful.

```
 $ php --rf fgetcsv
Function [ <internal:standard> function fgetcsv ] {

  - Parameters [5] {
    Parameter #0 [ <required> $stream ]
    Parameter #1 [ <optional> ?int $length = null ]
    Parameter #2 [ <optional> string $separator = "," ]
    Parameter #3 [ <optional> string $enclosure = "\"" ]
    Parameter #4 [ <optional> string $escape = "\\" ]
  }
  - Return [ array|false ]
}
```

Closes GH-493.
This commit is contained in:
Eric Stern 2021-03-18 12:25:04 -07:00 committed by Christoph M. Becker
parent 7e5d0d1bb6
commit 397f37e930
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
reference/filesystem/functions/fgetcsv.xml
View file

@ -10,9 +10,9 @@
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>fgetcsv</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<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>separator</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>
</methodsynopsis>
@ -36,7 +36,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<term><parameter>stream</parameter></term>
<listitem>
<para>
A valid file pointer to a file successfully opened by
@ -62,10 +62,10 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>delimiter</parameter></term>
<term><parameter>separator</parameter></term>
<listitem>
<para>
The optional <parameter>delimiter</parameter> parameter sets the field delimiter (one character only).
The optional <parameter>separator</parameter> parameter sets the field separator (one character only).
</para>
</listitem>
</varlistentry>
@ -117,7 +117,7 @@
&note.line-endings;
<para>
<function>fgetcsv</function> returns &null; if an invalid
<parameter>handle</parameter> is supplied or &false; on other errors,
<parameter>stream</parameter> is supplied or &false; on other errors,
including end of file.
</para>
</refsect1>