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

<!-- $Revision$ -->

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

<!-- Credits: mumumu -->

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

文字列の構造は、&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>

成功した場合に設定を連想配列形式で返します。

失敗した場合に &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> モードを使っている場合は別です。

次の文字 <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

-->