ini-get-all.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ini-get-all" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ini_get_all</refname>
  <refpurpose>Gets all configuration options</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>ini_get_all</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>extension</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>details</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Returns all the registered configuration options. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>extension</parameter></term>
     <listitem>
      <para>
       An optional extension name. If not &null; or the &string; <literal>core</literal>, the function returns only options
       specific for that extension.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>details</parameter></term>
     <listitem>
      <para>
       Retrieve details settings or only the current value for each setting.
       Default is &true; (retrieve details).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an associative array with directive name as the array key.
   Returns &false; and raises an <constant>E_WARNING</constant> level error
   if the <parameter>extension</parameter> doesn't exist.
  </para>
  <para>
   When <parameter>details</parameter> is &true; (default) the array will
   contain <literal>global_value</literal> (set in
   &php.ini;), <literal>local_value</literal> (perhaps set with
   <function>ini_set</function> or &htaccess;), and
   <literal>access</literal> (the access level).
  </para>
  <para>
   When <parameter>details</parameter> is &false; the value will be the
   current value of the option.
  </para>
  <para>
   See the <link linkend="configuration.changes.modes">manual section</link>
   for information on what access levels mean.
  </para>
  <note>
   <para>
    It's possible for a directive to have multiple access levels, which is
    why <literal>access</literal> shows the appropriate bitmask values.
   </para>
  </note>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>ini_get_all</function> examples</title>
    <programlisting role="php">
<![CDATA[
<?php
print_r(ini_get_all("pcre"));
print_r(ini_get_all());
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Array
(
    [pcre.backtrack_limit] => Array
        (
            [global_value] => 100000
            [local_value] => 100000
            [access] => 7
        )

    [pcre.recursion_limit] => Array
        (
            [global_value] => 100000
            [local_value] => 100000
            [access] => 7
        )

)
Array
(
    [allow_call_time_pass_reference] => Array
        (
            [global_value] => 0
            [local_value] => 0
            [access] => 6
        )

    [allow_url_fopen] => Array
        (
            [global_value] => 1
            [local_value] => 1
            [access] => 4
        )

    ...

)
]]>
    </screen>
   </example>
   <example>
    <title>Disabling <parameter>details</parameter></title>
    <programlisting role="php">
<![CDATA[
<?php
print_r(ini_get_all("pcre", false)); // Added in PHP 5.3.0
print_r(ini_get_all(null, false)); // Added in PHP 5.3.0
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Array
(
    [pcre.backtrack_limit] => 100000
    [pcre.recursion_limit] => 100000
)
Array
(
    [allow_call_time_pass_reference] => 0
    [allow_url_fopen] => 1
    ...
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    <function>ini_get_all</function> ignores "array" ini options such as
    pdo.dsn.*.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><xref linkend="configuration.changes"/></member>
    <member><function>ini_get</function></member>
    <member><function>ini_restore</function></member>
    <member><function>ini_set</function></member>
    <member><function>get_loaded_extensions</function></member>
    <member><function>phpinfo</function></member>
    <member><methodname>ReflectionExtension::getINIEntries</methodname></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
-->