com doc/ja: Generate string methodsynopses based on stubs: reference/strings/functions/levenshtein.xml reference/strings/functions/number-format.xml reference/strings/functions/setlocale.xml reference/strings/functions/strtok.xml reference/strings/functions/strtr.xml
[email protected] (Yoshinari Takaoka) Fri, 01 Jan 2021 21:23:08 +0000
| Newsgroups | php.doc.ja |
|---|---|
| Message-ID | <[email protected]> |
Commit: 0692e84cf7a861f56b0a856a5a24f384bd349b09 Author: Yoshinari Takaoka <[email protected]> Sat, 2 Jan 2021 06:23:08 +0900 Parents: 192f91520d83285e77956827f946f77a3b8019d9 Branches: master Link: http://git.php.net/?p=doc/ja.git;a=commitdiff;h=0692e84cf7a861f56b0a856a5a24f384bd349b09 Log: Generate string methodsynopses based on stubs Co-authored-by: Christoph M. Becker <[email protected]> Cf. <https://github.com/php/doc-en/pull/265>. Changed paths: M reference/strings/functions/levenshtein.xml M reference/strings/functions/number-format.xml M reference/strings/functions/setlocale.xml M reference/strings/functions/strtok.xml M reference/strings/functions/strtr.xml
diff_0692e84cf7a861f56b0a856a5a24f384bd349b09.txt
(text/plain, 26.6 KB)
diff --git a/reference/strings/functions/levenshtein.xml b/reference/strings/functions/levenshtein.xml
index f940bb47d1..ba195ccb67 100644
--- a/reference/strings/functions/levenshtein.xml
+++ b/reference/strings/functions/levenshtein.xml
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: af4410a7e15898c3dbe83d6ea38246745ed9c6fb Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 2a7c919451f9a536431ba2117f8f90ae814c1c5f Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.levenshtein" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xml:id="function.levenshtein" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>levenshtein</refname>
<refpurpose>二つの文字列のレーベンシュタイン距離を計算する</refpurpose>
@@ -12,37 +12,28 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>levenshtein</methodname>
- <methodparam><type>string</type><parameter>str1</parameter></methodparam>
- <methodparam><type>string</type><parameter>str2</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis>
- <type>int</type><methodname>levenshtein</methodname>
- <methodparam><type>string</type><parameter>str1</parameter></methodparam>
- <methodparam><type>string</type><parameter>str2</parameter></methodparam>
- <methodparam><type>int</type><parameter>cost_ins</parameter></methodparam>
- <methodparam><type>int</type><parameter>cost_rep</parameter></methodparam>
- <methodparam><type>int</type><parameter>cost_del</parameter></methodparam>
+ <methodparam><type>string</type><parameter>string1</parameter></methodparam>
+ <methodparam><type>string</type><parameter>string2</parameter></methodparam>
+ <methodparam choice="opt"><type>int</type><parameter>insertion_cost</parameter><initializer>1</initializer></methodparam>
+ <methodparam choice="opt"><type>int</type><parameter>replacement_cost</parameter><initializer>1</initializer></methodparam>
+ <methodparam choice="opt"><type>int</type><parameter>deletion_cost</parameter><initializer>1</initializer></methodparam>
</methodsynopsis>
<para>
- レーベンシュタイン距離は、<parameter>str1</parameter> を
- <parameter>str2</parameter> に変換するために置換、挿入、削除
+ レーベンシュタイン距離は、<parameter>string1</parameter> を
+ <parameter>string2</parameter> に変換するために置換、挿入、削除
しなければならない最小の文字数として定義されます。アルゴリズムの複雑さは、
<literal>O(m*n)</literal> です。
ここで、<literal>n</literal> および <literal>m</literal> はそれぞれ
- <parameter>str1</parameter> および <parameter>str2</parameter> の長さです
- (O(max(n,m)**3) となる <function>similar_text</function> よりは良いですが、
+ <parameter>string1</parameter> および <parameter>string2</parameter> の長さです
+ <literal>O(max(n,m)**3)</literal> となる <function>similar_text</function> よりは良いですが、
まだかなりの計算量です)。
</para>
<para>
- 上記の最も簡単な形式では、この関数はパラメータとして引数を二つだけとり、
- <parameter>str1</parameter> から
- <parameter>str2</parameter> に変換する際に必要な
- 挿入、置換、削除演算の数のみを計算します。
- </para>
- <para>
- 2 番目の形式では、挿入、置換、削除演算のコストを定義する
- 3 番目のパラメータが追加されます。この形式は 1 番目の形式より一般的で
- 汎用性が高いですが、効率的ではありません。
+ <parameter>insertion_cost</parameter>, <parameter>replacement_cost</parameter>
+ かつ/または <parameter>deletion_cost</parameter> が <literal>1</literal> 以外の場合、
+ 変換コストが最も小さいアルゴリズムを採用します。
+ たとえば、<code>$insertion_cost + $deletion_cost < $replacement_cost</code> の場合、
+ 置換をせず、挿入と削除が行われます。
</para>
</refsect1>
@@ -51,7 +42,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>str1</parameter></term>
+ <term><parameter>string1</parameter></term>
<listitem>
<para>
レーベンシュタイン距離を計算する文字列のひとつ。
@@ -59,7 +50,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>str2</parameter></term>
+ <term><parameter>string2</parameter></term>
<listitem>
<para>
レーベンシュタイン距離を計算する文字列のひとつ。
@@ -67,7 +58,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>cost_ins</parameter></term>
+ <term><parameter>insertion_cost</parameter></term>
<listitem>
<para>
挿入のコストを定義します。
@@ -75,7 +66,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>cost_rep</parameter></term>
+ <term><parameter>replacement_cost</parameter></term>
<listitem>
<para>
置換のコストを定義します。
@@ -83,7 +74,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>cost_del</parameter></term>
+ <term><parameter>deletion_cost</parameter></term>
<listitem>
<para>
削除のコストを定義します。
@@ -101,7 +92,31 @@
引数文字列の一つが 255 文字の制限より長い場合に -1 を返します。
</para>
</refsect1>
-
+
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ これより前のバージョンでは、
+ <function>levenshtein</function> 関数は引数を2個、
+ または5個指定して呼び出さなければなりませんでした。
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -180,7 +195,6 @@ if ($shortest == 0) {
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/strings/functions/number-format.xml b/reference/strings/functions/number-format.xml
index 1d592326ba..75a1057efc 100644
--- a/reference/strings/functions/number-format.xml
+++ b/reference/strings/functions/number-format.xml
@@ -1,47 +1,24 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 3e15d2894fb35432d2a111db36fe8ba8ebc62024 Maintainer: shimooka Status: ready -->
+<!-- EN-Revision: 2a7c919451f9a536431ba2117f8f90ae814c1c5f Maintainer: shimooka Status: ready -->
<!-- Credits: mumumu -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.number-format" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xml:id="function.number-format" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>number_format</refname>
- <refpurpose>数字を千位毎にグループ化してフォーマットする</refpurpose>
+ <refpurpose>数字を千の位毎にグループ化してフォーマットする</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>number_format</methodname>
- <methodparam><type>float</type><parameter>number</parameter></methodparam>
+ <methodparam><type>float</type><parameter>num</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>decimals</parameter><initializer>0</initializer></methodparam>
+ <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>decimal_separator</parameter><initializer>"."</initializer></methodparam>
+ <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>thousands_separator</parameter><initializer>","</initializer></methodparam>
</methodsynopsis>
- <methodsynopsis>
- <type>string</type><methodname>number_format</methodname>
- <methodparam><type>float</type><parameter>number</parameter></methodparam>
- <methodparam><type>int</type><parameter>decimals</parameter><initializer>0</initializer></methodparam>
- <methodparam><type>string</type><parameter>dec_point</parameter><initializer>"."</initializer></methodparam>
- <methodparam><type>string</type><parameter>thousands_sep</parameter><initializer>","</initializer></methodparam>
- </methodsynopsis>
- <para>
- この関数は 1 つか 2 つもしくは 4 つのパラメータを受け取ります
- (3 つはありません) :
- </para>
- <para>
- パラメータが 1 つだけ渡された場合、
- <parameter>number</parameter> は千位毎にカンマ (",") が追加され、
- 小数なしでフォーマットされます。
- </para>
<para>
- パラメータが 2 つ渡された場合、<parameter>number</parameter>
- は <parameter>decimals</parameter> 桁の小数の前にドット (".") 、
- 千位毎にカンマ (",") が追加されてフォーマットされます。
- </para>
- <para>
- パラメータが 4 つ全て渡された場合、<parameter>number</parameter>
- はドット (".") の代わりに <parameter>dec_point</parameter> が
- <parameter>decimals</parameter> 桁の小数の前に、千位毎にカンマ
- (",") の代わりに <parameter>thousands_sep</parameter>
- が追加されてフォーマットされます。
+ 数値を千の位毎にグループ化し、オプションで小数の桁も追加してフォーマットします。
</para>
</refsect1>
@@ -50,7 +27,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>number</parameter></term>
+ <term><parameter>num</parameter></term>
<listitem>
<para>
フォーマットする数値。
@@ -62,11 +39,13 @@
<listitem>
<para>
小数点以下の桁数。
+ <literal>0</literal> を指定すると、
+ 返り値の <parameter>decimal_separator</parameter> は省略されます。
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>dec_point</parameter></term>
+ <term><parameter>decimal_separator</parameter></term>
<listitem>
<para>
小数点を表す区切り文字。
@@ -74,10 +53,10 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>thousands_sep</parameter></term>
+ <term><parameter>thousands_separator</parameter></term>
<listitem>
<para>
- 千位毎の区切り文字。
+ 千の位毎の区切り文字。
</para>
</listitem>
</varlistentry>
@@ -88,7 +67,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- <parameter>number</parameter> をフォーマットした結果を返します。
+ <parameter>num</parameter> をフォーマットした結果を返します。
</para>
</refsect1>
@@ -105,12 +84,20 @@
</thead>
<tbody>
<row>
+ <entry>8.0.0</entry>
+ <entry>
+ これより前のバージョンでは、
+ <function>number_format</function> 関数は
+ 引数を1個、2個、または4個受け入れていました(つまり、3個はダメでした)。
+ </entry>
+ </row>
+ <row>
<entry>7.2.0</entry>
<entry>
<function>number_format</function> は、
<literal>-0</literal> を返さないように変更されました。
これより前のバージョンでは、
- <parameter>number</parameter> が <literal>-0.01</literal>
+ <parameter>num</parameter> が <literal>-0.01</literal>
のようなケースで <literal>-0</literal> が返される場合がありました。
</entry>
</row>
diff --git a/reference/strings/functions/setlocale.xml b/reference/strings/functions/setlocale.xml
index c5b9fd46bd..07e605f231 100644
--- a/reference/strings/functions/setlocale.xml
+++ b/reference/strings/functions/setlocale.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 2a7c919451f9a536431ba2117f8f90ae814c1c5f Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" xml:id="function.setlocale">
<refnamediv>
@@ -11,15 +11,16 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>string</type><methodname>setlocale</methodname>
+ <type class="union"><type>string</type><type>false</type></type><methodname>setlocale</methodname>
<methodparam><type>int</type><parameter>category</parameter></methodparam>
- <methodparam><type>string</type><parameter>locale</parameter></methodparam>
- <methodparam rep="repeat"><type>string</type><parameter>locales</parameter></methodparam>
+ <methodparam><type>string</type><parameter>locales</parameter></methodparam>
+ <methodparam rep="repeat"><type>string</type><parameter>rest</parameter></methodparam>
</methodsynopsis>
+ <simpara>Alternative signature (not supported with named arguments):</simpara>
<methodsynopsis>
- <type>string</type><methodname>setlocale</methodname>
+ <type class="union"><type>string</type><type>false</type></type><methodname>setlocale</methodname>
<methodparam><type>int</type><parameter>category</parameter></methodparam>
- <methodparam><type>array</type><parameter>locale</parameter></methodparam>
+ <methodparam><type>array</type><parameter>locale_array</parameter></methodparam>
</methodsynopsis>
<para>
ロケール情報を設定します。
@@ -93,31 +94,42 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>locale</parameter></term>
+ <term><parameter>locales</parameter></term>
<listitem>
<para>
- <parameter>locale</parameter>が &null; もしくは空の文字列
+ <parameter>locales</parameter>が空の文字列
<literal>""</literal>
の場合、ロケール名は上記のカテゴリと同じ名前の環境変数の値、
または環境変数 "LANG" からセットされます。
</para>
<para>
- <parameter>locale</parameter> が <literal>"0"</literal> の場合、
+ <parameter>locales</parameter> が <literal>"0"</literal> の場合、
ロケール設定は適用されず、単に現在の設定が返されます。
</para>
<para>
- <parameter>locale</parameter> が配列もしくは追加のパラメータが続く場合、
- それぞれの配列要素もしくはパラメータは成功するまで新規ロケールとしてセットされます。
+ <parameter>locales</parameter> に追加のパラメータが続く場合、
+ それぞれのパラメータは成功するまで新規ロケールとしてセットされます。
これは、ロケールが異なるシステムで異なる名前を持っている、
もしくはロケールが利用できない場合のフォールバックを提供するといった場合に有用です。
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>locales</parameter></term>
+ <term><parameter>rest</parameter></term>
<listitem>
<para>
- (オプションの文字列あるいは配列で、ロケール設定が成功するまで続けます)
+ オプションの文字列。ロケール設定が成功するまで設定を試みます。
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>locale_array</parameter></term>
+ <listitem>
+ <para>
+ それぞれの配列の要素が、
+ 新しいロケールとして設定が成功するまで設定を試みます。
+ これは、異なるシステムでロケールが違う名前として認識されたり、
+ ロケールが利用できない可能性がある場合にフォールバックさせる目的で使うと便利です。
</para>
</listitem>
</varlistentry>
@@ -203,7 +215,7 @@ echo "Preferred locale for german on this system is '$loc_de'";
<tip>
<para>
Windows ユーザーは Microsoft の <acronym>MSDN</acronym> の Web サイトに
- <parameter>locale</parameter>
+ <parameter>locales</parameter>
文字列に関する有用な情報を見つけることができるでしょう。
サポートしている言語文字列は
<link xlink:href="&url.setlocale.lang.win32;">言語文字列のドキュメント</link>、
@@ -215,7 +227,6 @@ echo "Preferred locale for german on this system is '$loc_de'";
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/strings/functions/strtok.xml b/reference/strings/functions/strtok.xml
index 340b4f55f7..e5f5ab1fca 100644
--- a/reference/strings/functions/strtok.xml
+++ b/reference/strings/functions/strtok.xml
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 95bdd6883b5dde9504701777ba81b3c5f15df52b Maintainer: hirokawa Status: ready -->
-<!-- CREDITS: shimooka -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.strtok" xmlns:xlink="http://www.w3.org/1999/xlink">
+<!-- EN-Revision: 2a7c919451f9a536431ba2117f8f90ae814c1c5f Maintainer: hirokawa Status: ready -->
+<!-- CREDITS: shimooka,mumumu -->
+<refentry xml:id="function.strtok" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>strtok</refname>
<refpurpose>文字列をトークンに分割する</refpurpose>
@@ -11,28 +11,29 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>string</type><methodname>strtok</methodname>
- <methodparam><type>string</type><parameter>str</parameter></methodparam>
+ <type class="union"><type>string</type><type>false</type></type><methodname>strtok</methodname>
+ <methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>string</type><parameter>token</parameter></methodparam>
</methodsynopsis>
+ <simpara>代替のシグネチャ (名前付き引数をサポートしていません):</simpara>
<methodsynopsis>
- <type>string</type><methodname>strtok</methodname>
+ <type class="union"><type>string</type><type>false</type></type><methodname>strtok</methodname>
<methodparam><type>string</type><parameter>token</parameter></methodparam>
</methodsynopsis>
<para>
- <function>strtok</function> は文字列 (<parameter>str</parameter>)
+ <function>strtok</function> は文字列 (<parameter>string</parameter>)
を 何らかの文字 <parameter>token</parameter>
によって区切られている小さな文字列 (トークン) に分割します。
"This is an example string" のような文字列がある場合、
空白文字をトークンとするとこの文字列を個々の単語に分割することができます。
</para>
<para>
- strtok は最初のコールの時のみ string 引数を使用することに注意してください。
+ strtok は最初のコールの時のみ <parameter>string</parameter> 引数を使用することに注意してください。
strtok は、文字列のどこにいるのかの情報を保持しているため、
- 2回目以降のコールではトークンのみを必要とします。
+ 2回目以降のコールでは <parameter>token</parameter> のみを必要とします。
最初からやりなおす場合や新しい文字列をトークンに分割する場合、
- 初期化するために再度string引数を指定してstrtokをコールします。
- 文字列は、引数の文字のどれかが見つかったはトークンに分割されます。
+ 初期化するために再度 <parameter>string</parameter> 引数を指定して strtok をコールします。
+ 文字列は、<parameter>token</parameter> の文字のどれかが見つかった場合はトークンに分割されます。
</para>
</refsect1>
@@ -41,7 +42,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>str</parameter></term>
+ <term><parameter>string</parameter></term>
<listitem>
<para>
より小さい文字列 (トークン) に分割する文字列。
@@ -52,7 +53,7 @@
<term><parameter>token</parameter></term>
<listitem>
<para>
- <parameter>str</parameter> を分割する際に使用する区切り文字。
+ <parameter>string</parameter> を分割する際に使用する区切り文字。
</para>
</listitem>
</varlistentry>
@@ -63,7 +64,8 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- 文字列トークンを返します。
+ トークンを文字列で返します。
+ トークンがない場合は、&false; を返します。
</para>
</refsect1>
@@ -128,7 +130,6 @@ var_dump($first_token, $second_token);
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/strings/functions/strtr.xml b/reference/strings/functions/strtr.xml
index 3399ec02a4..26b9da5162 100644
--- a/reference/strings/functions/strtr.xml
+++ b/reference/strings/functions/strtr.xml
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 2a7c919451f9a536431ba2117f8f90ae814c1c5f Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.strtr" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xml:id="function.strtr" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>strtr</refname>
<refpurpose>文字の変換あるいは部分文字列の置換を行う</refpurpose>
@@ -12,17 +12,18 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>strtr</methodname>
- <methodparam><type>string</type><parameter>str</parameter></methodparam>
+ <methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>string</type><parameter>from</parameter></methodparam>
<methodparam><type>string</type><parameter>to</parameter></methodparam>
</methodsynopsis>
+ <simpara>代替のシグネチャ (名前付き引数をサポートしていません):</simpara>
<methodsynopsis>
<type>string</type><methodname>strtr</methodname>
- <methodparam><type>string</type><parameter>str</parameter></methodparam>
+ <methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>array</type><parameter>replace_pairs</parameter></methodparam>
</methodsynopsis>
<para>
- 引数を三つ渡した場合、この関数は <parameter>str</parameter>
+ 引数を三つ渡した場合、この関数は <parameter>string</parameter>
のコピーを返します。その際に、文字列中に <parameter>from</parameter>
の各文字 (シングルバイト) があれば <parameter>to</parameter>
の対応する文字に変換します。つまり、すべての <literal>$from[$n]</literal>
@@ -32,18 +33,18 @@
<para>
<parameter>from</parameter> と <parameter>to</parameter>
の長さが異なる場合、長い方の余分な文字は無視されます。
- 返される文字列の長さは、もとの <parameter>str</parameter> と同じになります。
+ 返される文字列の長さは、もとの <parameter>string</parameter> と同じになります。
</para>
<para>
引数を二つだけ渡す場合は、二番目の引数を
- <literal>array('from' => 'to', ...)</literal> 形式の配列にしなければなりません。
+ <literal>array('from' => 'to', ...)</literal> 形式の配列にしなければなりません。
返される値は文字列で、もとの文字列中にある配列のキーと同じ部分を対応する値で置換したものとなります。
一番長いキーから順に調べます。一度部分文字列の置換を行うと、
置換後の文字列がさらに置換の対象となることはありません。
</para>
<para>
この場合は、配列のキーと値は任意の長さにすることができますが、キーを空にすることだけはできません。
- さらに、返される文字列の長さはもとの <parameter>str</parameter>
+ さらに、返される文字列の長さはもとの <parameter>string</parameter>
とは異なる可能性があります。
しかし、この関数が最も効率的に働くのは、すべてのキーが同じ長さである場合です。
</para>
@@ -54,7 +55,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>str</parameter></term>
+ <term><parameter>string</parameter></term>
<listitem>
<para>
変換する文字列。
@@ -84,7 +85,12 @@
<parameter>replace_pairs</parameter> パラメータを
<parameter>to</parameter> や <parameter>from</parameter>
のかわりに使用することができます。この場合は
- <literal>array('from' => 'to', ...)</literal> 形式の配列となります。
+ <literal>array('from' => 'to', ...)</literal> 形式の配列となります。
+ </para>
+ <para>
+ <parameter>replace_pairs</parameter> の中に空文字列
+ (<literal>""</literal>) のキーがある場合は、その要素は無視されます。
+ PHP 8.0.0 以降では、この場合 <constant>E_WARNING</constant> が発生します。
</para>
</listitem>
</varlistentry>
@@ -97,13 +103,6 @@
<para>
変換後の文字列を返します。
</para>
- <para>
- <parameter>replace_pairs</parameter> の中に空文字列
- (<literal>""</literal>) のキーがある場合は
- &false; を返します。
- <parameter>str</parameter> がスカラー値でない場合は文字列への変換をせず、
- 警告を発して &null; を返します。
- </para>
</refsect1>
<refsect1 role="examples">
@@ -181,7 +180,6 @@ ba01
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml