com doc/ja: Match fgetcsv parameter names to values in reflection: reference/filesystem/functions/fgetcsv.xml

Commit: e0c524c08396d65a6b3d9423f6eef74e1bf24912 Author: Yoshinari Takaoka <mumumu@mumumu.org> Sat, 20 Mar 2021 04:02:31 +0900 Parents: 32e83c6da3717cc39135dfae9ea70952536c4dea Branches: master Link: http://git.php.net/?p=doc/ja.git;a=commitdiff;h=e0c524c08396d65a6b3d9423f6eef74e1bf24912 Log: Match fgetcsv parameter names to values in reflection 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. Bugs: https://bugs.php.net/0 https://bugs.php.net/1 https://bugs.php.net/2 https://bugs.php.net/3 https://bugs.php.net/4 Changed paths: M reference/filesystem/functions/fgetcsv.xml Diff: diff --git a/reference/filesystem/functions/fgetcsv.xml b/reference/filesystem/functions/fgetcsv.xml index 15d7b0b258..a9136760f4 100644 --- a/reference/filesystem/functions/fgetcsv.xml +++ b/reference/filesystem/functions/fgetcsv.xml @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="utf-8"?> <!-- $Revision$ --> -<!-- EN-Revision: be5b0f33a18415823da76389915b49aae4ee6835 Maintainer: hirokawa Status: ready --> +<!-- EN-Revision: 397f37e9308c5946fe98229711d19c43421aeee6 Maintainer: hirokawa Status: ready --> <!-- CREDITS: shimooka,mumumu --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fgetcsv"> <refnamediv> @@ -12,9 +12,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> @@ -38,7 +38,7 @@ <para> <variablelist> <varlistentry> - <term><parameter>handle</parameter></term> + <term><parameter>stream</parameter></term> <listitem> <para> ファイルポインタは有効なものでなければならず、また @@ -65,10 +65,10 @@ </listitem> </varlistentry> <varlistentry> - <term><parameter>delimiter</parameter></term> + <term><parameter>separator</parameter></term> <listitem> <para> - オプションの <parameter>delimiter</parameter> パラメータで、フィールドのデリミタ (1 文字のみ) を設定します。 + オプションの <parameter>separator</parameter> パラメータで、フィールドのデリミタ (1 文字のみ) を設定します。 </para> </listitem> </varlistentry> @@ -119,7 +119,7 @@ </note> &note.line-endings; <para> - <function>fgetcsv</function> は、無効な <parameter>handle</parameter> + <function>fgetcsv</function> は、無効な <parameter>stream</parameter> を受け取った場合に &null; を返します。 また、ファイルの終端に達した場合を含めたその他のエラー時には &false; を返します。 </para>