/
ini-get-all.xml
230 lines (216 loc) · 5.31 KB
/
ini-get-all.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
<?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>array</type><methodname>ini_get_all</methodname>
<methodparam choice="opt"><type>string</type><parameter>extension</parameter></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 set, the function return 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.
</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="notes">
&reftitle.notes;
<note>
<para>
<function>ini_get_all</function> ignores "array" ini options such as
pdo.dsn.*.
</para>
</note>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.3.0</entry>
<entry>
Added <parameter>details</parameter>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</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="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
-->