PHP 8.4: Document new errors in XML{Reader,Writer} (#4123)

php · Nov 21, 2024 · ca220fb · ca220fb
1 parent b94d63f
commit ca220fb
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 8 deletions.
diff --git a/reference/xmlreader/xmlreader/open.xml b/reference/xmlreader/xmlreader/open.xml
@@ -68,10 +68,20 @@
 
  <refsect1 role="errors">
   &reftitle.errors;
-  <para>
-   This method may be called statically, but prior to PHP 8.0.0, will issue an
-   <constant>E_DEPRECATED</constant> error in this case.
-  </para>
+  <itemizedlist>
+   <listitem>
+    <simpara>
+     Passing an invalid <parameter>encoding</parameter> will throw a
+     <exceptionname>ValueError</exceptionname>.
+    </simpara>
+   </listitem>
+   <listitem>
+    <simpara>
+     This method may be called statically, but prior to PHP 8.0.0, will issue an
+     <constant>E_DEPRECATED</constant> error in this case.
+    </simpara>
+   </listitem>
+  </itemizedlist>
  </refsect1>
 
  <refsect1 role="changelog">
@@ -85,6 +95,13 @@
      </row>
     </thead>
     <tbody>
+     <row>
+      <entry>8.4.0</entry>
+      <entry>
+       Passing an invalid <parameter>encoding</parameter> will now throw a
+       <exceptionname>ValueError</exceptionname>.
+      </entry>
+     </row>
      <row>
       <entry>8.0.0</entry>
       <entry>

diff --git a/reference/xmlreader/xmlreader/xml.xml b/reference/xmlreader/xmlreader/xml.xml
@@ -68,10 +68,20 @@
 
  <refsect1 role="errors">
   &reftitle.errors;
-  <para>
-   This method may be called statically, but prior to PHP 8.0.0, will issue an
-   <constant>E_DEPRECATED</constant> error in this case.
-  </para>
+  <itemizedlist>
+   <listitem>
+    <simpara>
+     Passing an invalid <parameter>encoding</parameter> will throw a
+     <exceptionname>ValueError</exceptionname>.
+    </simpara>
+   </listitem>
+   <listitem>
+    <simpara>
+     This method may be called statically, but prior to PHP 8.0.0, will issue an
+     <constant>E_DEPRECATED</constant> error in this case.
+    </simpara>
+   </listitem>
+  </itemizedlist>
  </refsect1>
 
  <refsect1 role="changelog">
@@ -85,6 +95,13 @@
      </row>
     </thead>
     <tbody>
+     <row>
+      <entry>8.4.0</entry>
+      <entry>
+       Passing an invalid <parameter>encoding</parameter> will now throw a
+       <exceptionname>ValueError</exceptionname>.
+      </entry>
+     </row>
      <row>
       <entry>8.0.0</entry>
       <entry>

diff --git a/reference/xmlwriter/xmlwriter/startdocument.xml b/reference/xmlwriter/xmlwriter/startdocument.xml
@@ -68,6 +68,14 @@
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <simpara>
+   Passing an <parameter>encoding</parameter> containing null bytes will
+   throw a <exceptionname>ValueError</exceptionname>.
+  </simpara>
+ </refsect1>
+
  <refsect1 role="changelog">
   &reftitle.changelog;
   <informaltable>
@@ -79,6 +87,13 @@
      </row>
     </thead>
     <tbody>
+     <row>
+      <entry>8.4.0</entry>
+      <entry>
+       Passing an <parameter>encoding</parameter> containing null bytes will
+       now throw a <exceptionname>ValueError</exceptionname>.
+      </entry>
+     </row>
      &xmlwriter.changelog.writer-param;
     </tbody>
    </tgroup>