Document libxml changes for PHP 8.4 (#4051)

* Document version requirement change of libxml * Document error change to libxml_set_streams_context() * Apply suggestions from code review Co-authored-by: Gina Peter Banyard <[email protected]>
php · Nov 12, 2024 · 81bc2b5 · 81bc2b5
1 parent 03674dd
commit 81bc2b5
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 1 deletion.
diff --git a/reference/libxml/functions/libxml-set-streams-context.xml b/reference/libxml/functions/libxml-set-streams-context.xml
@@ -42,6 +42,39 @@
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <simpara>
+   Throws a <classname>TypeError</classname> when a non-stream resource is
+   passed to <parameter>context</parameter>.
+  </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.4.0</entry>
+      <entry>
+       <function>libxml_set_streams_context</function> now throws a
+       <exceptionname>TypeError</exceptionname> when a non-stream resource is passed
+       to <parameter>context</parameter>, instead of throwing later when the
+       context is used.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>

diff --git a/reference/libxml/setup.xml b/reference/libxml/setup.xml
@@ -9,7 +9,7 @@
   &reftitle.required;
   <para>
    This extension requires <link xlink:href="&url.libxml;">libxml</link> &gt;=
-   2.9.0 as of PHP 8.0. libxml &gt;= 2.6.0 prior to PHP 8.0.
+   2.9.4 as of PHP 8.4.0 libxml &gt;= 2.9.0 prior to PHP 8.4.0, and libxml &gt;= 2.6.0 prior to PHP 8.0.0.
   </para>
  </section>
  <!-- }}} -->