From 7df91dc7326d8e70d4c65a6ad549d5cdb21c06ca Mon Sep 17 00:00:00 2001
From: Gina Peter Banyard <girgias@php.net>
Date: Tue, 12 Nov 2024 15:16:54 +0000
Subject: [PATCH 1/7] PHP 8.4: Document SplObjectStorage::seek()

---
 reference/spl/splobjectstorage/seek.xml | 134 ++++++++++++++++++++++++
 1 file changed, 134 insertions(+)
 create mode 100644 reference/spl/splobjectstorage/seek.xml

diff --git a/reference/spl/splobjectstorage/seek.xml b/reference/spl/splobjectstorage/seek.xml
new file mode 100644
index 000000000000..ad451917f66d
--- /dev/null
+++ b/reference/spl/splobjectstorage/seek.xml
@@ -0,0 +1,134 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="splobjectstorage.seek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>SplObjectStorage::seek</refname>
+  <refpurpose>Description</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="SplObjectStorage">
+   <modifier>public</modifier> <type>void</type><methodname>SplObjectStorage::seek</methodname>
+   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
+  </methodsynopsis>
+  &warn.undocumented.func;
+  <simpara>
+   Description.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <simpara>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>offset</parameter></term>
+     <listitem>
+      <simpara>
+       Description.
+      </simpara>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   &return.void;
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <simpara>
+   When does this function issue <constant>E_*</constant> level errors,
+   and/or throw <exceptionname>Exception</exceptionname>s.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.X.0</entry>
+      <entry>
+       Description
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example xml:id="splobjectstorage.seek.example.basic">
+   <title><methodname>SplObjectStorage::seek</methodname> example</title>
+   <simpara>
+    Description.
+   </simpara>
+   <programlisting role="php">
+<![CDATA[
+<?php
+echo "Code example";
+?>
+]]>
+   </programlisting>
+   &example.outputs;
+   <screen>
+<![CDATA[
+Code example
+]]>
+   </screen>
+  </example>
+ </refsect1>
+
+ <refsect1 role="notes">
+  &reftitle.notes;
+  <note>
+   <simpara>
+    Any notes that don't fit anywhere else should go here.
+   </simpara>
+  </note>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><methodname>ClassName::otherMethodName</methodname></member>
+   <member><function>some_function</function></member>
+   <member><link linkend="some.id.chunk.to.link">something appendix</link></member>
+  </simplelist>
+ </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
+-->

From 35497639ef258bcf1d3d3eeace3afa1e0d04ff54 Mon Sep 17 00:00:00 2001
From: Gina Peter Banyard <girgias@php.net>
Date: Tue, 12 Nov 2024 15:18:48 +0000
Subject: [PATCH 2/7] Add info in versions.xml

---
 reference/spl/versions.xml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/reference/spl/versions.xml b/reference/spl/versions.xml
index 9468a4f10848..916e02d852c4 100644
--- a/reference/spl/versions.xml
+++ b/reference/spl/versions.xml
@@ -979,6 +979,7 @@
  <function name="splobjectstorage::removeall" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
  <function name="splobjectstorage::removeallexcept" from="PHP 5 &gt;= 5.3.6, PHP 7, PHP 8"/>
  <function name="splobjectstorage::rewind" from="PHP 5 &gt;= 5.1.0, PHP 7, PHP 8"/>
+ <function name="splobjectstorage::seek" from="PHP 8 &gt;= 8.4.0"/>
  <function name="splobjectstorage::serialize" from="PHP 5 &gt;= 5.2.2, PHP 7, PHP 8"/>
  <function name="splobjectstorage::setinfo" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
  <function name="splobjectstorage::unserialize" from="PHP 5 &gt;= 5.2.2, PHP 7, PHP 8"/>

From 42b203441d28169446f69c499741250f52be6bee Mon Sep 17 00:00:00 2001
From: Niels Dossche <7771979+nielsdos@users.noreply.github.com>
Date: Tue, 12 Nov 2024 18:31:26 +0100
Subject: [PATCH 3/7] Document SplObjectStorage::seek()

---
 reference/spl/splobjectstorage/seek.xml | 76 ++++++++++---------------
 1 file changed, 31 insertions(+), 45 deletions(-)

diff --git a/reference/spl/splobjectstorage/seek.xml b/reference/spl/splobjectstorage/seek.xml
index ad451917f66d..f86e5c551b81 100644
--- a/reference/spl/splobjectstorage/seek.xml
+++ b/reference/spl/splobjectstorage/seek.xml
@@ -2,7 +2,7 @@
 <refentry xml:id="splobjectstorage.seek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>SplObjectStorage::seek</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Seeks iterator to a position</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -11,26 +11,26 @@
    <modifier>public</modifier> <type>void</type><methodname>SplObjectStorage::seek</methodname>
    <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   </methodsynopsis>
-  &warn.undocumented.func;
+
   <simpara>
-   Description.
+   Seeks to a given position in the iterator.
   </simpara>
  </refsect1>
 
  <refsect1 role="parameters">
   &reftitle.parameters;
-  <simpara>
+  <para>
    <variablelist>
     <varlistentry>
      <term><parameter>offset</parameter></term>
      <listitem>
       <simpara>
-       Description.
+       The position to seek to.
       </simpara>
      </listitem>
     </varlistentry>
    </variablelist>
-  </simpara>
+  </para>
  </refsect1>
 
  <refsect1 role="returnvalues">
@@ -43,71 +43,57 @@
  <refsect1 role="errors">
   &reftitle.errors;
   <simpara>
-   When does this function issue <constant>E_*</constant> level errors,
-   and/or throw <exceptionname>Exception</exceptionname>s.
+   Throws an <classname>OutOfBoundsException</classname>
+   if the <parameter>offset</parameter> is not seekable.
   </simpara>
  </refsect1>
 
- <refsect1 role="changelog">
-  &reftitle.changelog;
-  <informaltable>
-   <tgroup cols="2">
-    <thead>
-     <row>
-      <entry>&Version;</entry>
-      <entry>&Description;</entry>
-     </row>
-    </thead>
-    <tbody>
-     <row>
-      <entry>8.X.0</entry>
-      <entry>
-       Description
-      </entry>
-     </row>
-    </tbody>
-   </tgroup>
-  </informaltable>
- </refsect1>
-
  <refsect1 role="examples">
   &reftitle.examples;
   <example xml:id="splobjectstorage.seek.example.basic">
    <title><methodname>SplObjectStorage::seek</methodname> example</title>
    <simpara>
-    Description.
+    Seeks to item position 2 in the iterator.
    </simpara>
    <programlisting role="php">
 <![CDATA[
 <?php
-echo "Code example";
+class Test {
+    public function __construct(public string $marker) {}
+}
+
+$a = new Test("a");
+$b = new Test("b");
+$c = new Test("c");
+
+$storage = new SplObjectStorage();
+$storage[$a] = "first";
+$storage[$b] = "second";
+$storage[$c] = "third";
+
+$storage->seek(2);
+var_dump($storage->key());
+var_dump($storage->current());
 ?>
 ]]>
    </programlisting>
    &example.outputs;
    <screen>
 <![CDATA[
-Code example
+int(2)
+object(Test)#3 (1) {
+  ["marker"]=>
+  string(1) "c"
+}
 ]]>
    </screen>
   </example>
  </refsect1>
 
- <refsect1 role="notes">
-  &reftitle.notes;
-  <note>
-   <simpara>
-    Any notes that don't fit anywhere else should go here.
-   </simpara>
-  </note>
- </refsect1>
-
  <refsect1 role="seealso">
   &reftitle.seealso;
   <simplelist>
-   <member><methodname>ClassName::otherMethodName</methodname></member>
-   <member><function>some_function</function></member>
-   <member><link linkend="some.id.chunk.to.link">something appendix</link></member>
+   <member><classname>SeekableIterator</classname></member>
   </simplelist>
  </refsect1>
 

From 5a9c684602cd984e9d026de4ee1b6fdf4fd4a389 Mon Sep 17 00:00:00 2001
From: Niels Dossche <7771979+nielsdos@users.noreply.github.com>
Date: Tue, 12 Nov 2024 18:31:39 +0100
Subject: [PATCH 4/7] Change para to simpara in errors of
 SeekableIterator::seek()

---
 reference/spl/seekableiterator/seek.xml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/reference/spl/seekableiterator/seek.xml b/reference/spl/seekableiterator/seek.xml
index 2bc98ed188e4..2469f2ca1e60 100644
--- a/reference/spl/seekableiterator/seek.xml
+++ b/reference/spl/seekableiterator/seek.xml
@@ -43,10 +43,10 @@
 
  <refsect1 role="errors">
   &reftitle.errors;
-  <para>
+  <simpara>
    Implementations should throw an <classname>OutOfBoundsException</classname>
    if the <parameter>offset</parameter> is not seekable.
-  </para>
+  </simpara>
  </refsect1>
 
  <refsect1 role="examples">

From 465c1de7254e56e9648698f317e5af4f5df9dff5 Mon Sep 17 00:00:00 2001
From: Niels Dossche <7771979+nielsdos@users.noreply.github.com>
Date: Tue, 12 Nov 2024 18:31:49 +0100
Subject: [PATCH 5/7] Document ArrayIterator::seek()

---
 reference/spl/arrayiterator/seek.xml | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/reference/spl/arrayiterator/seek.xml b/reference/spl/arrayiterator/seek.xml
index b356c24dbe38..9d6eb17df89f 100644
--- a/reference/spl/arrayiterator/seek.xml
+++ b/reference/spl/arrayiterator/seek.xml
@@ -3,7 +3,7 @@
 <refentry xml:id="arrayiterator.seek" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>ArrayIterator::seek</refname>
-  <refpurpose>Seek to position</refpurpose>
+  <refpurpose>Seeks to a position</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -13,7 +13,9 @@
    <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   </methodsynopsis>
 
-  &warn.undocumented.func;
+  <simpara>
+   Seeks to a given position in the iterator.
+  </simpara>
  </refsect1>
  
  <refsect1 role="parameters">
@@ -32,6 +34,14 @@
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <simpara>
+   Throws an <classname>OutOfBoundsException</classname>
+   if the <parameter>offset</parameter> is not seekable.
+  </simpara>
+ </refsect1>
+
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>

From 62259b160d8783563a723c5d556c4329c89f9e2d Mon Sep 17 00:00:00 2001
From: Niels Dossche <7771979+nielsdos@users.noreply.github.com>
Date: Tue, 12 Nov 2024 18:33:09 +0100
Subject: [PATCH 6/7] fix

---
 reference/spl/arrayiterator/seek.xml | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/reference/spl/arrayiterator/seek.xml b/reference/spl/arrayiterator/seek.xml
index 9d6eb17df89f..67914a502f8a 100644
--- a/reference/spl/arrayiterator/seek.xml
+++ b/reference/spl/arrayiterator/seek.xml
@@ -34,6 +34,13 @@
   </para>
  </refsect1>
 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.void;
+  </para>
+ </refsect1>
+
  <refsect1 role="errors">
   &reftitle.errors;
   <simpara>
@@ -42,13 +49,6 @@
   </simpara>
  </refsect1>
 
- <refsect1 role="returnvalues">
-  &reftitle.returnvalues;
-  <para>
-   &return.void;
-  </para>
- </refsect1>
-
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:

From 38bfa49f4d7e7736dfcef08e575c83dd5fb0a322 Mon Sep 17 00:00:00 2001
From: Gina Peter Banyard <girgias@php.net>
Date: Tue, 12 Nov 2024 17:34:48 +0000
Subject: [PATCH 7/7] Fix some markup issues

---
 reference/spl/splobjectstorage/seek.xml | 22 ++++++++++------------
 1 file changed, 10 insertions(+), 12 deletions(-)

diff --git a/reference/spl/splobjectstorage/seek.xml b/reference/spl/splobjectstorage/seek.xml
index f86e5c551b81..81e231d076b6 100644
--- a/reference/spl/splobjectstorage/seek.xml
+++ b/reference/spl/splobjectstorage/seek.xml
@@ -19,18 +19,16 @@
 
  <refsect1 role="parameters">
   &reftitle.parameters;
-  <para>
-   <variablelist>
-    <varlistentry>
-     <term><parameter>offset</parameter></term>
-     <listitem>
-      <simpara>
-       The position to seek to.
-      </simpara>
-     </listitem>
-    </varlistentry>
-   </variablelist>
-  </para>
+  <variablelist>
+   <varlistentry>
+    <term><parameter>offset</parameter></term>
+    <listitem>
+     <simpara>
+      The position to seek to.
+     </simpara>
+    </listitem>
+   </varlistentry>
+  </variablelist>
  </refsect1>
 
  <refsect1 role="returnvalues">