svn: /phpdoc/ja/trunk/reference/intl/collator/ get-sort-key.xml

mumumu                                   Sun, 12 Apr 2020 10:58:38 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=349652

Log:
Fix #72271: Collator::getSortKey() doc page is out of date, incomplete, inaccurate

Bug: https://bugs.php.net/72271 (Closed) Collator::getSortKey() doc page is out of date, incomplete, inaccurate
      
Changed paths:
    U   phpdoc/ja/trunk/reference/intl/collator/get-sort-key.xml

Modified: phpdoc/ja/trunk/reference/intl/collator/get-sort-key.xml
===================================================================
--- phpdoc/ja/trunk/reference/intl/collator/get-sort-key.xml	2020-04-12 10:47:58 UTC (rev 349651)
+++ phpdoc/ja/trunk/reference/intl/collator/get-sort-key.xml	2020-04-12 10:58:38 UTC (rev 349652)
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 330543 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 349647 Maintainer: takagi Status: ready -->
+<!-- Credits: mumumu -->
 <refentry xml:id="collator.getsortkey" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>Collator::getSortKey</refname>
@@ -30,6 +31,9 @@
   </methodsynopsis>
   <para>
    文字列用の照合キーを返します。
+   照合キーは文字列のかわりに直接比較することができますが、
+   これは実装依存の動きであり、ICUライブラリのバージョンによって変わる可能性があります。
+   一般的に、ソート用のキーはデータベース内部か、関数呼び出しコストがとても高い状況でのみ役に立ちます。
   </para>
  </refsect1>

@@ -59,10 +63,32 @@

  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
-  <para>文字列の照合キーを返します。照合キーを、文字列のかわりに直接比較することができます。</para>
+  <para>文字列の照合キーを返します。&return.falseforfailure;</para>
   &return.falseproblem;
  </refsect1>

+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>5.3.15, 5.4.5</entry>
+      <entry>
+       ソート用のキーに <literal>NUL</literal> バイトは含まれなくなりました。
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
@@ -73,16 +99,16 @@
 <?php
 $s1 = 'Hello';

-$coll = collator_create( 'en_US' );
-$res  = collator_get_sort_key( $coll, $s1);
+$coll = collator_create('en_US');
+$res  = collator_get_sort_key($coll, $s1);

-echo urlencode($res);
+echo bin2hex($res);
 ?>
 ]]>
     </programlisting>
-    &example.outputs;
+    &example.outputs.similar;
     <screen>
-     71%3F%3FE%01%09%01%8F%08%00
+     3832404046010901dc08
     </screen>
    </example>
   </para>