doc-fr/reference/intl/collator/compare.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 388226f9e106d2ab1fdc2ce193a3b311b2f4b6b9 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="collator.compare" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>Collator::compare</refname>
  <refname>collator_compare</refname>
  <refpurpose>Compare deux chaînes Unicode</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis role="oop">
   <modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>Collator::compare</methodname>
   <methodparam><type>string</type><parameter>string1</parameter></methodparam>
   <methodparam><type>string</type><parameter>string2</parameter></methodparam>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis role="procedural">
   <type class="union"><type>int</type><type>false</type></type><methodname>collator_compare</methodname>
   <methodparam><type>Collator</type><parameter>object</parameter></methodparam>
   <methodparam><type>string</type><parameter>string1</parameter></methodparam>
   <methodparam><type>string</type><parameter>string2</parameter></methodparam>
  </methodsynopsis>
  <para>
   Compare deux chaînes Unicode en fonction des règles de collation.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>object</parameter></term>
     <listitem>
      <para>
       Objet <classname>Collator</classname>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>string1</parameter></term>
     <listitem>
      <para>
       La première chaîne à comparer.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>string2</parameter></term>
     <listitem>
      <para>
       La deuxième chaîne à comparer.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>Résultats de comparaison</para>
  <para>
   <itemizedlist>
    <listitem>
     <para>
      1 si <parameter>string1</parameter> est <emphasis>plus grand</emphasis> que
      <parameter>string2</parameter> ;
     </para>
    </listitem>
    <listitem>
     <para>
      0 si <parameter>string1</parameter> est <emphasis>égal</emphasis> à
      <parameter>string2</parameter>;
     </para>
    </listitem>
    <listitem>
     <para>
      -1 si <parameter>string1</parameter> est <emphasis>plus petit</emphasis> que
      <parameter>string2</parameter> .
     </para>
    </listitem>
   </itemizedlist>
   Retourne &false; en cas d'échec.
  </para>
  &return.falseproblem;
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>collator_compare</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$s1 = 'Hello';
$s2 = 'hello';

$coll = collator_create( 'en_US' );
$res  = collator_compare( $coll, $s1, $s2 );

if ($res === false) {
    echo collator_get_error_message( $coll );
} else if( $res > 0 ) {
    echo "s1 est plus grand que s2\n";
} else if( $res < 0 ) {
    echo "s1 est plus petit que s2\n";
} else {
    echo "s1 est égal à s2\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
     s1 est plus grand que s2
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>Comparer des chaînes sans diacritique ou sensibilité à la casse</title>
    <programlisting role="php">
     <![CDATA[
<?php
$c = new Collator( 'en' );
$c->setStrength( Collator::PRIMARY );
if ( $c->compare( 'Séan', 'Sean' ) == 0 )
{
    echo "The same\n";
}
]]>
    </programlisting>
    &example.outputs;
    <screen>
     The same
    </screen>
    <para>
     Cet exemple demande au collator de ne comparer en ne prenant compte que
     des caractères de base. La documentation pour
     <function>Collator->setStrength</function> explique les duretés différentes.
    </para>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>collator_sort</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
-->