doc-fr/reference/info/functions/ini-get.xml

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

<refentry xml:id="function.ini-get" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ini_get</refname>
  <refpurpose>Lit la valeur d'une option de configuration</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>ini_get</methodname>
   <methodparam><type>string</type><parameter>option</parameter></methodparam>
  </methodsynopsis>
  <para>
   Retourne la valeur de l'option de configuration
   <parameter>varname</parameter> en cas de succès.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       Le nom de l'option de configuration.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne la valeur de l'option de configuration
   <parameter>varname</parameter> en cas de succès, ou une
   &string; vide pour les valeurs &null;. Retourne &false;
   si l'option de configuration n'existe pas.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemples avec <function>ini_get</function></title>
    <programlisting role="php">
<![CDATA[
<?php
/*
Notre fichier php.ini contient les directives suivantes :

display_errors = On
register_globals = Off
post_max_size = 8M
*/

echo 'display_errors = ' . ini_get('display_errors') . "\n";
echo 'register_globals = ' . ini_get('register_globals') . "\n";
echo 'post_max_size = ' . ini_get('post_max_size') . "\n";
echo 'post_max_size+1 = ' . (ini_get('post_max_size')+1) . "\n";
echo 'post_max_size in bytes = ' . return_bytes(ini_get('post_max_size'));

function return_bytes($val) {
    $val = trim($val);
    $last = strtolower($val[strlen($val)-1]);
    switch($last) {
        // Le modifieur 'G' est disponible
        case 'g':
            $val *= 1024;
        case 'm':
            $val *= 1024;
        case 'k':
            $val *= 1024;
    }

    return $val;
}

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[

display_errors = 1
register_globals = 0
post_max_size = 8M
post_max_size+1 = 9
post_max_size in bytes = 8388608

]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>Lecture de valeurs booléennes</title>
   <para>
    Une directive de configuration ayant la valeur de <literal>off</literal>
    sera retourné sous la forme d'une chaîne vide ou "0" alors que 
    la valeur <literal>on</literal> retournera "<literal>1</literal>".
    Cette fonction peut également retourner la valeur littérale
    du fichier INI.
   </para>
  </note>
  <note>
   <title>Lors de la lecture des tailles de mémoire</title>
   <para>
    Plusieurs directives traitant de taille mémoire, comme
    <link linkend="ini.upload-max-filesize">upload_max_filesize</link>, sont stockées
    dans le fichier &php.ini; avec une notation courte. <function>ini_get</function>
    retourne la chaîne exacte stockée dans le fichier &php.ini; et
    <emphasis>NON PAS</emphasis> son équivalent &integer;. Appliquer des opérations
    arithmétiques classiques sur ces valeurs ne conduira à rien de bon. L'exemple ci-dessous
    montre une façon de convertir la notation sténographique en octets, de la même
    façon dont le fait le source PHP.
   </para>
  </note>
  <note>
   <para>
    <function>ini_get</function> ne peut pas lire les options ini de type 
    "array" tel que pdo.dsn.*, et retourne &false; dans ce cas.
   </para>
  </note>
 </refsect1>

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