strnatcmp.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a3573c18b89fd32aca1c3924d3fd9568900b4a33 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.strnatcmp">
 <refnamediv>
  <refname>strnatcmp</refname>
  <refpurpose>"自然順"アルゴリズムにより文字列比較を行う</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>strnatcmp</methodname>
   <methodparam><type>string</type><parameter>string1</parameter></methodparam>
   <methodparam><type>string</type><parameter>string2</parameter></methodparam>
  </methodsynopsis>
  <para>
   この関数は、人間が行うような手法でアルファベットまたは数字の
   文字列の順序を比較するアルゴリズムを実装します。この手法は、"自然順"
   と言われます。
   この比較は、大文字小文字を区別することに注意してください。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string1</parameter></term>
     <listitem>
      <para>
       最初の文字列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>string2</parameter></term>
     <listitem>
      <para>
       次の文字列。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   他の文字列比較関数と同様に、この関数は、
   <parameter>string1</parameter> が <parameter>string2</parameter>
   より小さいに場合に <literal>-1</literal>、<parameter>string1</parameter> が
   <parameter>string2</parameter> より大きい場合に <literal>1</literal>、等しい場合に
   <literal>0</literal> を返します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &standard.changelog.binary-safe-string-comparison;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   このアルゴリズムと (<function>strcmp</function> を使用した)
   通常のコンピュータ文字列ソートの間の違いの例を次に示します。
   <informalexample>
    <programlisting role="php">
<![CDATA[
<?php
$arr1 = $arr2 = array("img12.png", "img10.png", "img2.png", "img1.png");
echo "標準の文字列比較\n";
usort($arr1, "strcmp");
print_r($arr1);
echo "\n自然順での文字列比較\n";
usort($arr2, "strnatcmp");
print_r($arr2);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
標準の文字列比較
Array
(
    [0] => img1.png
    [1] => img10.png
    [2] => img12.png
    [3] => img2.png
)

自然順での文字列比較
Array
(
    [0] => img1.png
    [1] => img2.png
    [2] => img10.png
    [3] => img12.png
)
]]>
    </screen>
   </informalexample>
   詳細な情報については、Martin Pool の
   <link xlink:href="&url.strnatcmp;">自然順文字列比較</link>
   のページを参照ください。
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>preg_match</function></member>
    <member><function>strcasecmp</function></member>
    <member><function>substr</function></member>
    <member><function>stristr</function></member>
    <member><function>strcmp</function></member>
    <member><function>strncmp</function></member>
    <member><function>strncasecmp</function></member>
    <member><function>strnatcasecmp</function></member>
    <member><function>strstr</function></member>
    <member><function>natsort</function></member>
    <member><function>natcasesort</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
-->