parse-ini-string.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0c9c2dd669fe9395eaa73d487fbd160f9057429a Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.parse-ini-string" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>parse_ini_string</refname>
  <refpurpose>Analyse une chaîne de configuration</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>parse_ini_string</methodname>
   <methodparam><type>string</type><parameter>ini_string</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>process_sections</parameter><initializer>&false;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>scanner_mode</parameter><initializer><constant>INI_SCANNER_NORMAL</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>parse_ini_string</function> retourne la configuration dans la
   chaîne <parameter>ini_string</parameter> dans un tableau associatif.
  </para>
  <para>
   La structure de la chaîne doit être la même que celle du fichier &php.ini;.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>ini_string</parameter></term>
     <listitem>
      <para>
       Le contenu de type ini à analyser.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>process_sections</parameter></term>
     <listitem>
      <para>
       En activant le paramètre <parameter>process_sections</parameter>
       avec &true;, vous obtiendrez un tableau multidimensionnel,
       avec les noms de sections et de directives. La valeur par 
       défaut du paramètre <parameter>process_sections</parameter> est &false;      
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>scanner_mode</parameter></term>
     <listitem>
      <para>
       Peut prendre les valeurs des constantes <constant>INI_SCANNER_NORMAL</constant> 
       (par défaut) ou <constant>INI_SCANNER_RAW</constant>. Si 
       <constant>INI_SCANNER_RAW</constant> est utilisé, les valeurs des 
       options ne seront pas analysées.
      </para>
      &ini.scanner.typed;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Les directives sont retournées sous forme de tableau <type>array</type> 
   en cas de succès, et &false; en cas d'erreur.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <simpara>
    Il y a plusieurs mots réservés que ne doivent pas être
    utilisés comme clé dans les fichiers .ini. Cela inclut : 
    <literal>null</literal>, <literal>yes</literal>, <literal>no</literal>, 
    <literal>true</literal>, <literal>false</literal>, <literal>on</literal>,
    <literal>off</literal>, <literal>none</literal>.
    Les valeurs <literal>null</literal>, <literal>off</literal>, 
    <literal>no</literal> et
    <literal>false</literal> sont retournées comme "" (chaîne vide) et les valeurs
    <literal>on</literal>, <literal>yes</literal> et <literal>true</literal>
    sont retournées comme "1" à moins que le mode <constant>INI_SCANNER_TYPED</constant>
    ne soit utilisé. Les caractères <literal>?{}|&amp;~![()^"</literal> ne
    doivent être utilisés nulle part dans les clés, et ont une signification
    spéciale dans les valeurs.
   </simpara>
  </note>
  </refsect1>
  
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>parse_ini_file</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
-->