construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1976eae0d815797af97a1e16c5cd90ffc2868395 Maintainer: takagi Status: ready -->
<refentry xml:id="collator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Collator::__construct</refname>
  <refpurpose>collator を作成する</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis role="Collator">
   <modifier>public</modifier> <methodname>Collator::__construct</methodname>
   <methodparam><type>string</type><parameter>locale</parameter></methodparam>
  </constructorsynopsis>
  <para>
   新しい <classname>Collator</classname> のインスタンスを作成します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>locale</parameter></term>
     <listitem>
      <para>
       照合規則を使用するロケール。特殊な場合として、
       空文字列を渡した場合はデフォルトのロケールの照合規則を使用します。
       <literal>"root"</literal> を渡した場合は、
       <link xlink:href="&url.icu.uca;">UCA</link> の規則を使用します。
      </para>
      <para>
       <parameter>locale</parameter> 属性は、
       各国・各地域のユーザーの期待通りに並べ替えやマッチングを行うために
       もっとも重要な属性です。デフォルトの
       <link xlink:href="&url.icu.uca;">UCA</link>
       の並び順で正しく ("正しく" とは、その言語を使用する人の期待通りにということです)
       処理できるのは、オランダ語やポルトガル語などの一部の言語だけです。
       それ以外の場合は、UCA にロケールを指定して
       その言語に応じた適切な照合を行えるようにする必要があります。
       従って、各ロケールにあわせて正しく設定した collator を使用する必要があります。
       ロケールを選択すると、その他の属性の値も適切な物に自動設定されます。
       従って、その他の属性については明示的に設定する必要はほとんどありません。
       選択したロケールによっては、文字列比較のパフォーマンスやソートキーの長さに違いが出ることがあります。
       <!--
        In short attribute names,
        &lt;language&gt;_&lt;script&gt;_&lt;region&gt;_&lt;keyword&gt;
        is represented by:
        L&lt;language&gt;_Z&lt;script&gt;_R&lt;region&gt;_V&lt;variant&gt;_K&lt;keyword&gt;.
        for <emphasis>RFC4646</emphasis> locale naming.
        
        <example><title>Locale format</title>
        Example:
        Locale="sv" (Swedish) "Kypper" &lt; "Köpfe"
        Locale="de" (German) "Köpfe" &lt; "Kypper"
        </example>
       -->
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   エラー時には "空の" オブジェクトを返します。何が起こったのかを知るには
   <function>intl_get_error_code</function>
   や
   <function>intl_get_error_message</function>
   を使用します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>Collator::__construct</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$coll = new Collator('en_CA');
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>Collator::create</function></member>
    <member><function>collator_create</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
 sgml-omittag:t
 sgml-shorttag:t
 sgml-minimize-attributes:nil
 sgml-always-quote-attributes:t
 sgml-indent-step:1
 sgml-indent-data:t
 indent-tabs-mode:nil
 sgml-parent-document:nil
 sgml-default-dtd-file:"~/.phpdoc/manual.ced"
 sgml-exposed-tags:nil
 sgml-local-catalogs:nil
 sgml-local-ecat-files:nil
 End:
 vim600: syn=xml fen fdm=syntax fdl=2 si
 vim: et tw=78 syn=sgml
 vi: ts=1 sw=1
-->