[doc-en] master: SplPriorityQueue::getExtractFlags(): describe the flags and add see also links (#5981)

Author: qodelicious (qodelicious) Committer: GitHub (web-flow) Pusher: lacatoire Date: 2026-10-20T14:03:52+02:00 Commit: https://github.com/php/doc-en/commit/75d7844c5c45e6116c223c2fcd8cc42f6eaf9eac Raw diff: https://github.com/php/doc-en/commit/75d7844c5c45e6116c223c2fcd8cc42f6eaf9eac.diff SplPriorityQueue::getExtractFlags(): describe the flags and add see also links (#5981) Changed paths: M reference/spl/splpriorityqueue/getextractflags.xml M reference/spl/splpriorityqueue/setextractflags.xml Diff: diff --git a/reference/spl/splpriorityqueue/getextractflags.xml b/reference/spl/splpriorityqueue/getextractflags.xml index b5266d03d834..00938ecf81f3 100644 --- a/reference/spl/splpriorityqueue/getextractflags.xml +++ b/reference/spl/splpriorityqueue/getextractflags.xml @@ -12,11 +12,12 @@ <modifier>public</modifier> <type>int</type><methodname>SplPriorityQueue::getExtractFlags</methodname> <void/> </methodsynopsis> - <para> - - </para> - - &warn.undocumented.func; + <simpara> + Gets the flags that define what is extracted by + <methodname>SplPriorityQueue::current</methodname>, + <methodname>SplPriorityQueue::top</methodname> and + <methodname>SplPriorityQueue::extract</methodname>. + </simpara> </refsect1> @@ -27,11 +28,28 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para> - Returns the flags of extraction. - </para> + <simpara> + Returns the flags of extraction, which is one of the following: + </simpara> + <itemizedlist> + <listitem><simpara><constant>SplPriorityQueue::EXTR_DATA</constant> (0x00000001): Extract the data</simpara></listitem> + <listitem><simpara><constant>SplPriorityQueue::EXTR_PRIORITY</constant> (0x00000002): Extract the priority</simpara></listitem> + <listitem><simpara><constant>SplPriorityQueue::EXTR_BOTH</constant> (0x00000003): Extract an array containing both</simpara></listitem> + </itemizedlist> + <simpara> + The default is <constant>SplPriorityQueue::EXTR_DATA</constant>. + </simpara> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <simplelist> + <member><methodname>SplPriorityQueue::setExtractFlags</methodname></member> + <member><methodname>SplPriorityQueue::current</methodname></member> + <member><methodname>SplPriorityQueue::top</methodname></member> + <member><methodname>SplPriorityQueue::extract</methodname></member> + </simplelist> + </refsect1> </refentry> <!-- Keep this comment at the end of the file diff --git a/reference/spl/splpriorityqueue/setextractflags.xml b/reference/spl/splpriorityqueue/setextractflags.xml index 59854f71288a..c0d6ba9de87c 100644 --- a/reference/spl/splpriorityqueue/setextractflags.xml +++ b/reference/spl/splpriorityqueue/setextractflags.xml @@ -47,6 +47,16 @@ </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <simplelist> + <member><methodname>SplPriorityQueue::getExtractFlags</methodname></member> + <member><methodname>SplPriorityQueue::current</methodname></member> + <member><methodname>SplPriorityQueue::top</methodname></member> + <member><methodname>SplPriorityQueue::extract</methodname></member> + </simplelist> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file Local variables: