<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: bb54309eff8a7d75ead0fdf48cc6dae99dd00367 Maintainer: bfl Status: ready -->

<!-- Reviewed: no -->

<refentry xml:id="function.parse-ini-string" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>parse_ini_string</refname>

<refpurpose>Разбирает строку конфигурации</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> возвращает настройки из строки

<parameter>ini_string</parameter> в виде ассоциативного массива.

</para>

<para>

Структура INI-строки такая же, как и в &php.ini;.

</para>

<warning>

<simpara>

Функция не должна использоваться с недоверенными входными данными,

за исключением случаев, когда значение параметра <parameter>scanner_mode</parameter>

равно <constant>INI_SCANNER_RAW</constant>, поскольку обработанные данные

могут содержать значения конфиденциальных констант, таких как константы,

содержащие пароль базы данных.

</simpara>

</warning>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>ini_string</parameter></term>

<listitem>

<para>

Содержимое разбираемого INI-файла.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>process_sections</parameter></term>

<listitem>

<para>

Установив в параметр <parameter>process_sections</parameter>

&true;, можно получить многомерный массив, который включает

названия секций и настроек. По умолчанию

<parameter>process_sections</parameter> равен &false;

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>scanner_mode</parameter></term>

<listitem>

<para>

Может принимать следующие значения: <constant>INI_SCANNER_NORMAL</constant>

(по умолчанию) или <constant>INI_SCANNER_RAW</constant>. Если

указано значение <constant>INI_SCANNER_RAW</constant>, то

значения опций не будут обрабатываться.

</para>

&ini.scanner.typed;

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

В случае успешного выполнения, настройки возвращаются в виде ассоциативного

массива (<type>array</type>). В случае возникновения ошибки, возвращается &false;.

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<note>

<simpara>

Существует зарезервированные слова, которые нельзя использовать

в качестве ключей в ini-файлах. Такими словами являются:

<literal>null</literal>, <literal>yes</literal>,

<literal>no</literal>, <literal>true</literal>, <literal>false</literal>,

<literal>on</literal>, <literal>off</literal>, <literal>none</literal>.

Значения <literal>null</literal>, <literal>off</literal>, <literal>no</literal> и

<literal>false</literal> преобразуются в <literal>""</literal>, а значения

<literal>on</literal>, <literal>yes</literal> и <literal>true</literal> в <literal>"1"</literal>

, но только если не используется режим

<constant>INI_SCANNER_TYPED</constant> (доступен с PHP 5.6.1).

Символы <literal>?{}|&amp;~!()^"</literal> не должны использоваться

в ключах и иметь какой-либо особый смысл в значениях.

</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

-->