php-doc-en/reference/info/functions/ini-get.xml
Damien Seguy d44662101a see also reshaping, plus small typos
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@117524 c90b9560-bf6c-de11-be94-00142212c4b1
2003-02-22 04:24:24 +00:00

96 lines
2.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.64 -->
<refentry id="function.ini-get">
<refnamediv>
<refname>ini_get</refname>
<refpurpose>Gets the value of a configuration option</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ini_get</methodname>
<methodparam><type>string</type><parameter>varname</parameter></methodparam>
</methodsynopsis>
<para>
Returns the value of the configuration option on success. Failure, such
as querying for a non-existant value, will return an empty string.
</para>
<note>
<title>When querying boolean values</title>
<para>
A boolean ini value of <literal>off</literal> will be returned as an
empty string while a boolean ini value of <literal>on</literal> will
be returned as "1".
</para>
</note>
<note>
<title>When querying memory size values</title>
<para>
Many ini memory size values, such as <literal>upload_max_filesize</literal>
are stored in the &php.ini; file in shorthand notation. <function>ini_get</function>
will return the exact string stored in the &php.ini; file, <emphasis>NOT</emphasis>
its integer equivalent. Attempting normal arithmetic functions on these values
will not have otherwise expected results.
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
/*
Our php.ini contains the following settings:
display_errors = On
register_globals = Off
post_max_size = 8M
*/
print 'display_errors = ' . ini_get('display_errors') . "\n";
print 'register_globals = ' . ini_get('register_globals') . "\n";
print 'post_max_size = ' . ini_get('post_max_size') . "\n";
print 'post_max_size+1 = ' . (ini_get('post_max_size')+1) . "\n";
/*
This script will produce:
display_errors = 1
register_globals =
post_max_size = 8M
post_max_size+1 = 9
*/
?>
]]>
</programlisting>
</informalexample>
</para>
</note>
<para>
See also
<function>get_cfg_var</function>,
<function>ini_get_all</function>,
<function>ini_alter</function>,
<function>ini_restore</function>, and
<function>ini_set</function>.
</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:"../../../../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
-->