<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.filesystem.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.parse-ini-string.php',
    1 => 'parse_ini_string',
    2 => '設定文字列をパースする',
  ),
  'up' => 
  array (
    0 => 'ref.filesystem.php',
    1 => 'ファイルシステム 関数',
  ),
  'prev' => 
  array (
    0 => 'function.parse-ini-file.php',
    1 => 'parse_ini_file',
  ),
  'next' => 
  array (
    0 => 'function.pathinfo.php',
    1 => 'pathinfo',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/filesystem/functions/parse-ini-string.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.parse-ini-string" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">parse_ini_string</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">parse_ini_string</span> &mdash; <span class="dc-title">設定文字列をパースする</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.parse-ini-string-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>parse_ini_string</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$ini_string</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$process_sections</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$scanner_mode</code><span class="initializer"> = <strong><code><a href="filesystem.constants.php#constant.ini-scanner-normal">INI_SCANNER_NORMAL</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>parse_ini_string()</strong></span> は、文字列
   <code class="parameter">ini_string</code> の設定を連想配列で返します。
  </p>
  <p class="para">
   文字列の構造は、<var class="filename">php.ini</var> の構造と同じです。
  </p>
  <div class="warning"><strong class="warning">警告</strong>
   <p class="simpara">
    この関数は、信頼できない入力に対して使用してはいけません。
    ただし、<code class="parameter">scanner_mode</code> が
    <strong><code><a href="filesystem.constants.php#constant.ini-scanner-raw">INI_SCANNER_RAW</a></code></strong> の場合を除きます。
    パース済みの出力には、データベースパスワードを保持する定数など、
    機密性の高い定数の値が含まれる可能性があるためです。
   </p>
  </div>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.parse-ini-string-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">ini_string</code></dt>
     <dd>
      <p class="para">
       パースしたい ini ファイルの内容。
      </p>
     </dd>
    
    
     <dt><code class="parameter">process_sections</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">process_sections</code>
       を <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> に設定すると、セクション名と設定を含む多次元配列を返します。
       <code class="parameter">process_sections</code> のデフォルトは <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> です。
      </p>
     </dd>
    
    
     <dt><code class="parameter">scanner_mode</code></dt>
     <dd>
      <p class="para">
       <strong><code><a href="filesystem.constants.php#constant.ini-scanner-normal">INI_SCANNER_NORMAL</a></code></strong> (デフォルト) あるいは
       <strong><code><a href="filesystem.constants.php#constant.ini-scanner-raw">INI_SCANNER_RAW</a></code></strong>。<strong><code><a href="filesystem.constants.php#constant.ini-scanner-raw">INI_SCANNER_RAW</a></code></strong>
       を指定すると、オプションの値はパースされません。
      </p>
      <p class="para">
    PHP 5.6.1 以降では <strong><code><a href="filesystem.constants.php#constant.ini-scanner-typed">INI_SCANNER_TYPED</a></code></strong> も指定できるようになりました。
    このモードでは、boolean や null そして integer の型を、可能な限り維持します。
    文字列 <code class="literal">&quot;true&quot;</code>、<code class="literal">&quot;on&quot;</code> そして <code class="literal">&quot;yes&quot;</code>
    は <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> に変換されます。<code class="literal">&quot;false&quot;</code>、<code class="literal">&quot;off&quot;</code>、<code class="literal">&quot;no&quot;</code>
    そして <code class="literal">&quot;none&quot;</code> は <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> だとみなされます。このモードでは、<code class="literal">&quot;null&quot;</code> は <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>
    に変換されます。また数値形式の文字列も、可能な限り integer 型に変換されます。
   </p>
     </dd>
    
   </dl>
  </p>
 </div>

 
 <div class="refsect1 returnvalues" id="refsect1-function.parse-ini-string-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   成功した場合に設定を連想配列形式で返します。
   失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.parse-ini-string-notes">
  <h3 class="title">注意</h3>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <span class="simpara">
    ini ファイル上でキーとして使ってはいけない単語があります。
    <code class="literal">null</code>, <code class="literal">yes</code>, <code class="literal">no</code>,
    <code class="literal">true</code>, <code class="literal">false</code>,
    <code class="literal">on</code>, <code class="literal">off</code>, <code class="literal">none</code> などです。
    <code class="literal">null</code>, <code class="literal">off</code>, <code class="literal">no</code>
    および <code class="literal">false</code> は <code class="literal">&quot;&quot;</code> となり、
    <code class="literal">on</code>, <code class="literal">yes</code> および <code class="literal">true</code>
    は <code class="literal">&quot;1&quot;</code> となります。
    ただし <strong><code><a href="filesystem.constants.php#constant.ini-scanner-typed">INI_SCANNER_TYPED</a></code></strong> モードを使っている場合は別です。
    次の文字 <code class="literal">?{}|&amp;~![()^&quot;</code> は、キーで使ってはいけません。
    また、値の中で特別な意味を持ちます。
   </span>
  </p></blockquote>
 </div>

 
 <div class="refsect1 seealso" id="refsect1-function.parse-ini-string-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.parse-ini-file.php" class="function" rel="rdfs-seeAlso">parse_ini_file()</a> - 設定ファイルをパースする</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>