lookup.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 1976eae0d815797af97a1e16c5cd90ffc2868395 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<!-- CREDITS: DAnnebicque -->
<refentry xml:id="locale.lookup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Locale::lookup</refname>
  <refname>locale_lookup</refname>
  <refpurpose>Recherche dans la liste la meilleure langue</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis role="Locale">
   <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>string</type><type>null</type></type><methodname>Locale::lookup</methodname>
   <methodparam><type>array</type><parameter>languageTag</parameter></methodparam>
   <methodparam><type>string</type><parameter>locale</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>canonicalize</parameter><initializer>&false;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>defaultLocale</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis>
   <type class="union"><type>string</type><type>null</type></type><methodname>locale_lookup</methodname>
   <methodparam><type>array</type><parameter>languageTag</parameter></methodparam>
   <methodparam><type>string</type><parameter>locale</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>canonicalize</parameter><initializer>&false;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>defaultLocale</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Recherche dans la liste <parameter>languageTag</parameter> la meilleure langue,
   pour la locale spécifiée par <parameter>locale</parameter>, en fonction
   de l'algorithme de la RFC 4647.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>languageTag</parameter></term>
     <listitem>
      <para>
       Un &array; contenant une liste de langues à comparer
       à la locale <parameter>locale</parameter>.
       Un maximum de 100 éléments est autorisé.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>locale</parameter></term>
     <listitem>
      <para>
       La locale à utiliser pour effectuer la recherche.
      </para>
     </listitem>
    </varlistentry>
     <varlistentry>
       <term>
         <parameter>canonicalize</parameter>
       </term>
       <listitem>
         <para>
           Si &true; les arguments seront convertis en leur forme
           canonique avant leur recherche.
         </para>
       </listitem>
     </varlistentry>
    <varlistentry>
     <term><parameter>defaultLocale</parameter></term>
     <listitem>
      <para>
       La locale à utiliser si aucune solution n'est trouvée.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   La langue la plus proche qui ait été trouvée dans la liste, ou bien
   la valeur par défaut.
  </para>
  &intl.locale-len.return;
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>7.4.0</entry>
      <entry>
       <parameter>defaultLocale</parameter> est désormais nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple avec <function>locale_lookup</function>, procédural</title>
   <programlisting role="php">
<![CDATA[
<?php
$arr = array(
    'de-DEVA',
    'de-DE-1996',
    'de',
    'de-De'
);
echo locale_lookup($arr, 'de-DE-1996-x-prv1-prv2', true, 'en_US');
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>Exemple avec <function>Locale::lookup</function>, POO</title>
   <programlisting role="php">
<![CDATA[
<?php
$arr = array(
    'de-DEVA',
    'de-DE-1996',
    'de',
    'de-De'
);
echo Locale::lookup($arr, 'de-DE-1996-x-prv1-prv2', true, 'en_US');
?>
]]>
   </programlisting>
  </example>
  &example.outputs;
  <screen>
<![CDATA[
de_de_1996
]]>
  </screen>
 </refsect1>

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