Document locale_canonicalize

php/doc-en@8a22321

Author: mumumu

reference/intl/locale/canonicalize.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 1976eae0d815797af97a1e16c5cd90ffc2868395 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 8a22321e312e13fb1e2785169a0e83df84c0c3d0 Maintainer: takagi Status: ready -->
 
 <refentry xml:id="locale.canonicalize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -15,12 +15,19 @@
    <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>string</type><type>null</type></type><methodname>Locale::canonicalize</methodname>
    <methodparam><type>string</type><parameter>locale</parameter></methodparam>
   </methodsynopsis>
-  <para>
-
-  </para>
-
-  &warn.undocumented.func;
-
+  <simpara>
+   渡されたロケール文字列を、ICU フォーマットに正規化します。
+  </simpara>
+  <simpara>
+   この関数は有効なロケールを示す、
+   または返すとは限りません。
+   単に、ICU の規則に従って正規化された入力のバージョンに過ぎません。
+  </simpara>
+  <simpara>
+   この関数の振る舞いは、
+   PHP が使っている ICU のバージョン
+   (<constant>INTL_ICU_VERSION</constant>) に依存します。
+  </simpara>
  </refsect1>
 
  <refsect1 role="parameters">
@@ -29,9 +36,9 @@
    <varlistentry>
     <term><parameter>locale</parameter></term>
     <listitem>
-     <para>
-
-     </para>
+     <simpara>
+      オリジナルのロケール文字列
+     </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
@@ -45,7 +52,25 @@
   &intl.locale-len.return;
  </refsect1>
 
-
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+   <title><function>locale_canonicalize</function> の例</title>
+   <programlisting role="php">
+    <![CDATA[
+echo Locale::canonicalize('en-US.utf8') . "\n";
+echo Locale::canonicalize('totally-not-valid') . "\n";
+    ]]>
+   </programlisting>
+  </example>
+  &example.outputs.similar;
+  <screen>
+   <![CDATA[
+en_US
+totally_NOT_VALID
+   ]]>
+  </screen>
+ </refsect1>
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables: