ini-get.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c8a8981a9df9a1564a4b9a79e84583d41a7b6ac5 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ini-get" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ini_get</refname>
  <refpurpose>Получает значение параметра конфигурации</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>
   Функция возвращает значение параметра конфигурации в случае успешного выполнения.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       Название параметра конфигурации.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает значение параметра конфигурации в виде строки.
   Для значений
   <literal>null</literal> функция вернёт пустую строку. Функция вернёт
   &false;, если опция не существует.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Примеры использования функции <function>ini_get</function></title>
    <programlisting role="php">
<![CDATA[
<?php

/**
 * Файл php.ini содержит следующие настройки:
 *
 * display_errors = On
 * register_globals = Off
 * post_max_size = 8M
 */

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

function return_bytes($val)
{
    $val = trim($val);
    $num = (int) rtrim($val, 'KMG');
    $last = strtolower($val[strlen($val) - 1]);

    switch ($last) {
        // Модификатор 'G' доступен
        case 'g':
            $num = $num * 1024 * 1024 * 1024;
            break;
        case 'm':
            $num = $num * 1024 * 1024;
            break;
        case 'k':
            $num *= 1024;
            break;
    }

    return $num;
}

?>
]]>
    </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>Логические значения</title>
   <para>
    Логическое ini-значение <literal>off</literal> возвращается как пустая
    строка или как строка "0", тогда как ini-значение <literal>on</literal>
    возвращается как строка "1". Функция умеет также возвращать сороковый литерал
    INI-значения.
   </para>
  </note>
  <note>
   <title>Значения размера памяти</title>
   <para>
    В файле &php.ini; размер памяти во многих ini-значениях директив наподобие
    <link linkend="ini.upload-max-filesize">upload_max_filesize</link> хранится
    в сокращённой нотации.
    Функция <function>ini_get</function> вернёт точную строку, которая хранится
    в файле &php.ini;, а <emphasis>не</emphasis> целочисленный (<type>int</type>) эквивалент
    строкового значения. Попытка передать значения таких деректив в стандартные арифметические функции
    не даст того же результата, который функции вернули бы при работе с целочисленными значениями.
    Приведённый пример показывает способ преобразования
    сокращённой записи в байты, который очень похож на то, как это делается в исходном PHP-коде.
   </para>
  </note>
  <note>
   <para>
    Функция <function>ini_get</function> не умеет читать «массив» ini-опций наподобие
    <literal>pdo.dsn.<replaceable>*</replaceable></literal> и возвращает &false; для таких параметров.
   </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
-->