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

<!-- $Revision$ -->

<!-- EN-Revision: 4c016ab334b90a98258b98e04752af7dc74954cd Maintainer: hirokawa Status: ready -->

<!-- CREDITS: takagi,mumumu -->

<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

opcache.enable_cli = Off

post_max_size = 8M

*/

echo 'display_errors = ' . ini_get('display_errors') . "\n";

echo 'opcache.enable_cli = ' . (int) ini_get('opcache.enable_cli') . "\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'));

?>

]]>

</programlisting>

&example.outputs.similar;

<screen>

<![CDATA[

display_errors = 1

opcache.enable_cli = 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>boolean 値を探す場合</title>

<para>

<literal>off</literal> という boolean の ini 値は空文字列または "0" として返されます。

一方で <literal>on</literal> の ini 値は "1" として返されます。

また、この関数はリテラル文字列で設定された INI 値を返すこともできます。

</para>

</note>

<note>

<title>メモリサイズの値を探す場合</title>

<para>

<link linkend="ini.upload-max-filesize">upload_max_filesize</link>

のようなメモリサイズの値の場合、

&php.ini;上で省略形で格納されています。

<function>ini_get</function>は&php.ini;に格納されている値を

そのままの形式で返します。整数表現に変換したりは<emphasis>しません</emphasis>。

これらの値に通常の算術的な関数を施すと予期しない結果になります。

短縮記法をバイトに変換する用途として、

<function>ini_parse_quantity</function> が使えます。

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

-->