get.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f7f861700c504afc40c14603d0fa0b36629a87ff Maintainer: lacatoire Status: ready -->
<!-- Reviewed: no -->
<!-- CREDITS: DAnnebicque -->
<refentry xml:id="resourcebundle.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>ResourceBundle::get</refname>
  <refname>resourcebundle_get</refname>
  <refpurpose>Récupère les données depuis le faisceau</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis role="ResourceBundle">
   <modifier>public</modifier> <type class="union"><type>ResourceBundle</type><type>array</type><type>string</type><type>int</type><type>null</type></type><methodname>ResourceBundle::get</methodname>
   <methodparam><type class="union"><type>string</type><type>int</type></type><parameter>index</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>fallback</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis>
   <type class="union"><type>ResourceBundle</type><type>array</type><type>string</type><type>int</type><type>null</type></type><methodname>resourcebundle_get</methodname>
   <methodparam><type>ResourceBundle</type><parameter>bundle</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>int</type></type><parameter>index</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>fallback</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Récupère les données depuis le faisceau par l'index ou la clé.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>bundle</parameter></term>
     <listitem>
      <para>
       Un objet <classname>ResourceBundle</classname>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>index</parameter></term>
     <listitem>
      <para>
       L'index des données ; peut être une &string; ou un &integer;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>fallback</parameter></term>
     <listitem>
      <para>
       Les paramètres régionaux doivent correspondre exactement ou le retour aux
       paramètres régionaux parents est autorisé
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne les données situées à un index donné ou &null; si une erreur
   survient. Les chaînes de caractères, les entiers et les données binaires
   sont retournés sous leurs formes correspondantes en types PHP ; les tableaux
   d'entiers sont retournés sous la forme de tableau PHP. Les types complexes
   sont retournés sous la forme d'objet <classname>ResourceBundle</classname>.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   Une <exceptionname>TypeError</exceptionname> est levée si
   le type du décalage est invalide.
  </simpara>
  <simpara>
   Une <exceptionname>ValueError</exceptionname> est levée si
   <parameter>index</parameter> est une <type>string</type>
   et est vide ou est un <type>int</type> et ne peut pas
   être contenu dans un entier 32 bits.
  </simpara>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.4.0</entry>
      <entry>
       <simpara>
        Une <exceptionname>TypeError</exceptionname> est levée si
        le type du décalage est invalide.
        Une <exceptionname>ValueError</exceptionname> est levée si
        <parameter>index</parameter> est une <type>string</type>
        et est vide ou est un <type>int</type> et ne peut pas
        être contenu dans un entier 32 bits.
       </simpara>
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple avec <function>resourcebundle_get</function></title>
   <programlisting role="php">
<![CDATA[
<?php
$r = resourcebundle_create( 'es', "/usr/share/data/myapp");
echo resourcebundle_get($r, 'somestring');
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>Exemple orienté objet</title>
   <programlisting role="php">
<![CDATA[
<?php
$r = new ResourceBundle( 'es', "/usr/share/data/myapp");
echo $r->get('somestring');
?>
]]>
   </programlisting>
  &example.outputs;
  <screen>
<![CDATA[
?Hola, mundo!
]]>
  </screen>
  </example>
 </refsect1>

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