Skip to content

Document new key builtin_default_value of the array returned by ini_get_all() in PHP >= 8.6.0#5581

Open
sebastianbergmann wants to merge 1 commit into
php:masterfrom
sebastianbergmann:master
Open

Document new key builtin_default_value of the array returned by ini_get_all() in PHP >= 8.6.0#5581
sebastianbergmann wants to merge 1 commit into
php:masterfrom
sebastianbergmann:master

Conversation

@sebastianbergmann
Copy link
Copy Markdown
Contributor

This updates the documentation for ini_get_all() after php/php-src#22134.

@sebastianbergmann sebastianbergmann changed the title Document new key "builtin_default_value" of the array returned by ini_get_all() in PHP >= 8.6.0 Document new key builtin_default_value of the array returned by ini_get_all() in PHP >= 8.6.0 May 25, 2026
Copy link
Copy Markdown
Member

@jordikroon jordikroon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Just a few style guide nits. Also meant to reduce the chances of a merge conflict later om.

Comment on lines +82 to +102
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.6.0</entry>
<entry>
The <literal>builtin_default_value</literal> element was added to the
details array returned for each directive.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.6.0</entry>
<entry>
The <literal>builtin_default_value</literal> element was added to the
details array returned for each directive.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.6.0</entry>
<entry>
The <literal>builtin_default_value</literal> element was added to the
details array returned for each directive.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>

Returns &false; and raises an <constant>E_WARNING</constant> level error
if the <parameter>extension</parameter> doesn't exist.
</para>
<para>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<simpara>

directive, or &null; if it has none, independent of values set in
&php.ini;, on the command line, or at runtime), and
<literal>access</literal> (the access level).
</para>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
</para>
</simpara>

@jordikroon
Copy link
Copy Markdown
Member

This should probably wait until PHP 8.6 actually drops.

@jordikroon jordikroon added this to the PHP 8.6 milestone May 25, 2026

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<simpara>

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>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
</simpara>

Comment on lines 64 to 77
@@ -74,6 +77,31 @@
</note>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<simpara>
When <parameter>details</parameter> is &false; the value will be the
current value of the option.
</simpara>
<simpara>
See the <link linkend="configuration.changes.modes">manual section</link>
for information on what access levels mean.
</simpara>
<note>
<simpara>
It's possible for a directive to have multiple access levels, which is
why <literal>access</literal> shows the appropriate bitmask values.
</simpara>
</note>

@jordikroon
Copy link
Copy Markdown
Member

@lacatoire as long as those inner para's do not change. There is no need to suggest to migrate to simpara. It will only put the bar up unnecessarily for the contributors. Though it's up to Sebastian if he wishes to include them. It's just extra maintenance work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants