Add more function/constant links to ob_get_status #3053
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Girgias
requested changes
Dec 31, 2023
reference/outcontrol/constants.xml
Outdated
| @@ -3,7 +3,7 @@ | |||
| <appendix xml:id="outcontrol.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> | |||
| &reftitle.constants; | |||
| &extension.constants.core; | |||
| <variablelist> | |||
| <variablelist xml:id="constants.flags-passed-to-handler"> | |||
There was a problem hiding this comment.
Please have the IDs as follows for all IDs :)
Suggested change
| <variablelist xml:id="constants.flags-passed-to-handler"> | |
| <variablelist xml:id="outcontrol.constants.flags-passed-to-handler"> |
There was a problem hiding this comment.
Done. I only updated the three new ids I added. I'll update the rest of them when I'm done updating the docs of the six ob_ clean / flush() functions referencing them.
Comment on lines
30
to
54
| <note> | ||
| <para xml:id="function.ob-list-handlers.names"> | ||
| If <link linkend="ini.output-buffering">output_buffering</link> is enabled | ||
| and no <link linkend="ini.output-handler">output_handler</link> is set, | ||
| or no callback or &null; was passed to <function>ob_start</function>, | ||
| <literal>"default output handler"</literal> is returned. | ||
| Enabling <link linkend="ini.output-buffering">output_buffering</link> | ||
| and setting an <link linkend="ini.output-handler">output_handler</link> | ||
| is equivalent to passing | ||
| an <link linkend="functions.internal">internal (built-in) function</link> | ||
| to <function>ob_start</function>. | ||
| </para> | ||
| <para> | ||
| If a <type>callable</type> was passed to <function>ob_start</function>, | ||
| the <link linkend="language.namespaces.basics">fully qualified name</link> | ||
| of the <type>callable</type> is returned. | ||
| If the <type>callable</type> is an object implementing | ||
| <link linkend="language.oop5.magic.invoke">__invoke()</link>, | ||
| the <link linkend="language.namespaces.basics">fully qualified name</link> | ||
| of the object's <link linkend="language.oop5.magic.invoke">__invoke()</link> | ||
| method is returned. | ||
| If the <type>callable</type> is a <classname>Closure</classname>, | ||
| <literal>"Closure::__invoke"</literal> is returned. | ||
| </para> | ||
| </note> |
There was a problem hiding this comment.
I don't think this should be in a note, please revert
There was a problem hiding this comment.
Reverted.
Also, this was the section I had issues with trying to add an xml:id to (#3042 (comment)).
This reverts commit 59b9f8b.
haszi
force-pushed
the
Sync-docs-of-ob_get_status-and-friends
branch
from
9135f25
to
d82b187
Compare
Co-authored-by: Gina Peter Banyard <girgias@php.net>
Girgias
approved these changes
Jan 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added
<link>s toob_get_status()to reference other functions/constants as appropriate and added appropriatexml:ids to these functions/constants so these can be linked to.Also added the same note on the difference in
ob_get_level()andob_get_status()nesting levels as the one inob_get_status().