Synchronize manual with stubs for PHP 8.4 - part 5 (php#4206)

Co-authored-by: Niels Dossche <[email protected]>
lufei · Nov 30, 2024 · d75a541 · d75a541
1 parent 561e36d
commit d75a541
Show file tree

Hide file tree

Showing 20 changed files with 310 additions and 12 deletions.
diff --git a/reference/dom/domattr.xml b/reference/dom/domattr.xml
@@ -30,6 +30,11 @@
      <classname>DOMNode</classname>
     </ooclass>
 
+    <classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
+     <xi:fallback/>
+    </xi:include>
+
     <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
     <fieldsynopsis>
      <modifier>public</modifier>
@@ -42,7 +47,6 @@
      <modifier>readonly</modifier>
      <type>bool</type>
      <varname linkend="domattr.props.specified">specified</varname>
-     <initializer>true</initializer>
     </fieldsynopsis>
     <fieldsynopsis>
      <modifier>public</modifier>
@@ -60,7 +64,6 @@
      <modifier>readonly</modifier>
      <type>mixed</type>
      <varname linkend="domattr.props.schematypeinfo">schemaTypeInfo</varname>
-     <initializer>null</initializer>
     </fieldsynopsis>
 
     <classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>

diff --git a/reference/dom/domcdatasection.xml b/reference/dom/domcdatasection.xml
@@ -32,6 +32,11 @@
      <classname>DOMText</classname>
     </ooclass>
 
+    <classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
+     <xi:fallback/>
+    </xi:include>
+
     <classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
     <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domtext')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Properties;']]))">
      <xi:fallback/>

diff --git a/reference/dom/domcharacterdata.xml b/reference/dom/domcharacterdata.xml
@@ -35,6 +35,11 @@
      <interfacename>DOMChildNode</interfacename>
     </oointerface>
 
+    <classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
+     <xi:fallback/>
+    </xi:include>
+
     <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
     <fieldsynopsis>
      <modifier>public</modifier>

diff --git a/reference/dom/domcomment.xml b/reference/dom/domcomment.xml
@@ -30,6 +30,11 @@
      <classname>DOMCharacterData</classname>
     </ooclass>
 
+    <classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
+     <xi:fallback/>
+    </xi:include>
+
     <classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
     <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domcharacterdata')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Properties;']]))">
      <xi:fallback/>

diff --git a/reference/dom/domdocument.xml b/reference/dom/domdocument.xml
@@ -35,6 +35,11 @@
      <interfacename>DOMParentNode</interfacename>
     </oointerface>
 
+    <classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
+     <xi:fallback/>
+    </xi:include>
+
     <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
     <fieldsynopsis>
      <modifier>public</modifier>

diff --git a/reference/dom/domdocumentfragment.xml b/reference/dom/domdocumentfragment.xml
@@ -36,6 +36,11 @@
      <interfacename>DOMParentNode</interfacename>
     </oointerface>
 
+    <classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
+     <xi:fallback/>
+    </xi:include>
+
     <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
     <fieldsynopsis>
      <modifier>public</modifier>

diff --git a/reference/dom/domdocumenttype.xml b/reference/dom/domdocumenttype.xml
@@ -30,6 +30,11 @@
      <classname>DOMNode</classname>
     </ooclass>
 
+    <classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
+     <xi:fallback/>
+    </xi:include>
+
     <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
     <fieldsynopsis>
      <modifier>public</modifier>

diff --git a/reference/dom/domelement.xml b/reference/dom/domelement.xml
@@ -40,6 +40,11 @@
      <interfacename>DOMChildNode</interfacename>
     </oointerface>
 
+    <classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
+     <xi:fallback/>
+    </xi:include>
+
     <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
     <fieldsynopsis>
      <modifier>public</modifier>
@@ -62,7 +67,6 @@
      <modifier>readonly</modifier>
      <type>mixed</type>
      <varname linkend="domelement.props.schematypeinfo">schemaTypeInfo</varname>
-     <initializer>null</initializer>
     </fieldsynopsis>
     <fieldsynopsis>
      <modifier>public</modifier>

diff --git a/reference/dom/domentity.xml b/reference/dom/domentity.xml
@@ -29,6 +29,11 @@
      <classname>DOMNode</classname>
     </ooclass>
 
+    <classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
+     <xi:fallback/>
+    </xi:include>
+
     <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
     <fieldsynopsis>
      <modifier>public</modifier>
@@ -53,21 +58,18 @@
      <modifier>readonly</modifier>
      <type class="union"><type>string</type><type>null</type></type>
      <varname linkend="domentity.props.actualencoding">actualEncoding</varname>
-     <initializer>null</initializer>
     </fieldsynopsis>
     <fieldsynopsis>
      <modifier>public</modifier>
      <modifier>readonly</modifier>
      <type class="union"><type>string</type><type>null</type></type>
      <varname linkend="domentity.props.encoding">encoding</varname>
-     <initializer>null</initializer>
     </fieldsynopsis>
     <fieldsynopsis>
      <modifier>public</modifier>
      <modifier>readonly</modifier>
      <type class="union"><type>string</type><type>null</type></type>
      <varname linkend="domentity.props.version">version</varname>
-     <initializer>null</initializer>
     </fieldsynopsis>
 
     <classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>

diff --git a/reference/dom/domentityreference.xml b/reference/dom/domentityreference.xml
@@ -39,6 +39,11 @@ Remove me once you perform substitutions
      <classname>DOMNode</classname>
     </ooclass>
 
+    <classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
+     <xi:fallback/>
+    </xi:include>
+
     <classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
     <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Properties;']]))">
      <xi:fallback/>

diff --git a/reference/dom/domnamespacenode.xml b/reference/dom/domnamespacenode.xml
@@ -84,6 +84,11 @@
      <type class="union"><type>DOMElement</type><type>null</type></type>
      <varname linkend="domnamespacenode.props.parentelement">parentElement</varname>
     </fieldsynopsis>
+
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnamespacenode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='DOMNameSpaceNode'])">
+     <xi:fallback/>
+    </xi:include>
    </classsynopsis>
 <!-- }}} -->
 
@@ -208,6 +213,8 @@
 
  </partintro>
 
+ &reference.dom.entities.domnamespacenode;
+
 </reference>
 <!-- Keep this comment at the end of the file
 Local variables:

diff --git a/reference/dom/domnamespacenode/sleep.xml b/reference/dom/domnamespacenode/sleep.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="domnamespacenode.sleep" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>DOMNameSpaceNode::__sleep</refname>
+  <refpurpose>Forbids serialization unless serialization methods are implemented in a subclass</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="DOMNameSpaceNode">
+   <modifier>public</modifier> <type>array</type><methodname>DOMNameSpaceNode::__sleep</methodname>
+   <void/>
+  </methodsynopsis>
+  <simpara>
+   Forbids serialization unless serialization methods are implemented in a subclass.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   The method always throws an exception.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <simpara>
+   Throws an <exceptionname>Error</exceptionname> exception when called.
+  </simpara>
+ </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
+-->
diff --git a/reference/dom/domnamespacenode/wakeup.xml b/reference/dom/domnamespacenode/wakeup.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="domnamespacenode.wakeup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>DOMNameSpaceNode::__wakeup</refname>
+  <refpurpose>Forbids unserialization unless unserialization methods are implemented in a subclass</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="DOMNameSpaceNode">
+   <modifier>public</modifier> <type>void</type><methodname>DOMNameSpaceNode::__wakeup</methodname>
+   <void/>
+  </methodsynopsis>
+  <simpara>
+   Forbids unserialization unless unserialization methods are implemented in a subclass.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   The method always throws an exception.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <simpara>
+   Throws an <exceptionname>Error</exceptionname> exception when called.
+  </simpara>
+ </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
+-->
diff --git a/reference/dom/domnode.xml b/reference/dom/domnode.xml
@@ -30,42 +30,42 @@
      <modifier>const</modifier>
      <type>int</type>
      <varname linkend="domnode.constants.document-position-disconnected">DOMNode::DOCUMENT_POSITION_DISCONNECTED</varname>
-     <initializer>1</initializer>
+     <initializer>0x1</initializer>
     </fieldsynopsis>
     <fieldsynopsis>
      <modifier>public</modifier>
      <modifier>const</modifier>
      <type>int</type>
      <varname linkend="domnode.constants.document-position-preceding">DOMNode::DOCUMENT_POSITION_PRECEDING</varname>
-     <initializer>2</initializer>
+     <initializer>0x2</initializer>
     </fieldsynopsis>
     <fieldsynopsis>
      <modifier>public</modifier>
      <modifier>const</modifier>
      <type>int</type>
      <varname linkend="domnode.constants.document-position-following">DOMNode::DOCUMENT_POSITION_FOLLOWING</varname>
-     <initializer>4</initializer>
+     <initializer>0x4</initializer>
     </fieldsynopsis>
     <fieldsynopsis>
      <modifier>public</modifier>
      <modifier>const</modifier>
      <type>int</type>
      <varname linkend="domnode.constants.document-position-contains">DOMNode::DOCUMENT_POSITION_CONTAINS</varname>
-     <initializer>8</initializer>
+     <initializer>0x8</initializer>
     </fieldsynopsis>
     <fieldsynopsis>
      <modifier>public</modifier>
      <modifier>const</modifier>
      <type>int</type>
      <varname linkend="domnode.constants.document-position-contained-by">DOMNode::DOCUMENT_POSITION_CONTAINED_BY</varname>
-     <initializer>16</initializer>
+     <initializer>0x10</initializer>
     </fieldsynopsis>
     <fieldsynopsis>
      <modifier>public</modifier>
      <modifier>const</modifier>
      <type>int</type>
      <varname linkend="domnode.constants.document-position-implementation-specific">DOMNode::DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC</varname>
-     <initializer>32</initializer>
+     <initializer>0x20</initializer>
     </fieldsynopsis>
 
     <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>