parse-ini-string.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0c9c2dd669fe9395eaa73d487fbd160f9057429a Maintainer: WeijianZhang Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<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>
 </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>。除非使用
    <constant>INI_SCANNER_TYPED</constant> 模式，否则
    <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>。字符 <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
-->