From 9d3b35d2a8bc6326f5981827eec18b028007b1f2 Mon Sep 17 00:00:00 2001
From: Christoph Michael Becker <cmb@php.net>
Date: Sat, 21 Nov 2020 12:28:48 +0000
Subject: [PATCH] Generate xmlreader methodsynopses based on stubs
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Based on a patch contributed by Máté Kocsis <kocsismate@woohoolabs.com>.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351468 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/xmlreader/xmlreader/expand.xml      |  9 ++--
 .../xmlreader/xmlreader/getattribute.xml      | 28 ++++++++++--
 .../xmlreader/xmlreader/getattributeno.xml    |  5 +--
 .../xmlreader/xmlreader/getattributens.xml    | 19 +++++---
 .../xmlreader/xmlreader/lookupnamespace.xml   | 28 ++++++++++--
 .../xmlreader/xmlreader/movetoattributens.xml | 13 +++---
 reference/xmlreader/xmlreader/next.xml        | 32 +++++++++++---
 reference/xmlreader/xmlreader/open.xml        | 43 ++++++++++++++-----
 .../xmlreader/xmlreader/setrelaxngschema.xml  |  7 +--
 .../xmlreader/setrelaxngschemasource.xml      |  7 +--
 reference/xmlreader/xmlreader/setschema.xml   |  5 +--
 reference/xmlreader/xmlreader/xml.xml         | 34 +++++++++++++--
 12 files changed, 163 insertions(+), 67 deletions(-)

diff --git a/reference/xmlreader/xmlreader/expand.xml b/reference/xmlreader/xmlreader/expand.xml
index 8e9abd3d42..6e0c86bc47 100644
--- a/reference/xmlreader/xmlreader/expand.xml
+++ b/reference/xmlreader/xmlreader/expand.xml
@@ -8,10 +8,8 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
-   <type>DOMNode</type>
-   <methodname>XMLReader::expand</methodname>
-   <methodparam choice="opt"><type>DOMNode</type><parameter>basenode</parameter></methodparam>
+   <modifier>public</modifier> <type class="union"><type>DOMNode</type><type>false</type></type><methodname>XMLReader::expand</methodname>
+   <methodparam choice="opt"><type class="union"><type>DOMNode</type><type>null</type></type><parameter>baseNode</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>
   <para>
    This method copies the current node and returns the appropriate DOM object.
@@ -22,7 +20,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>basenode</parameter></term>
+     <term><parameter>baseNode</parameter></term>
      <listitem>
       <para>
        A <classname>DOMNode</classname> defining the target <classname>DOMDocument</classname> for the created DOM object.
@@ -40,7 +38,6 @@
  </refsect1> 
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
diff --git a/reference/xmlreader/xmlreader/getattribute.xml b/reference/xmlreader/xmlreader/getattribute.xml
index 0ba6b27040..9669768126 100644
--- a/reference/xmlreader/xmlreader/getattribute.xml
+++ b/reference/xmlreader/xmlreader/getattribute.xml
@@ -8,9 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
-   <type>string</type>
-   <methodname>XMLReader::getAttribute</methodname>
+   <modifier>public</modifier> <type class="union"><type>string</type><type>null</type></type><methodname>XMLReader::getAttribute</methodname>
    <methodparam><type>string</type><parameter>name</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -33,6 +31,29 @@
    </variablelist>
   </para>
  </refsect1>
+
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.0.0</entry>
+      <entry>
+       This function can longer return &false;.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
@@ -51,7 +72,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
diff --git a/reference/xmlreader/xmlreader/getattributeno.xml b/reference/xmlreader/xmlreader/getattributeno.xml
index bdc8638213..6ebc141bbb 100644
--- a/reference/xmlreader/xmlreader/getattributeno.xml
+++ b/reference/xmlreader/xmlreader/getattributeno.xml
@@ -8,9 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
-   <type>string</type>
-   <methodname>XMLReader::getAttributeNo</methodname>
+   <modifier>public</modifier> <type class="union"><type>string</type><type>null</type></type><methodname>XMLReader::getAttributeNo</methodname>
    <methodparam><type>int</type><parameter>index</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -80,7 +78,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
diff --git a/reference/xmlreader/xmlreader/getattributens.xml b/reference/xmlreader/xmlreader/getattributens.xml
index b5013379b7..393ce9095f 100644
--- a/reference/xmlreader/xmlreader/getattributens.xml
+++ b/reference/xmlreader/xmlreader/getattributens.xml
@@ -8,9 +8,9 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>string</type><methodname>XMLReader::getAttributeNs</methodname>
-   <methodparam><type>string</type><parameter>localName</parameter></methodparam>
-   <methodparam><type>string</type><parameter>namespaceURI</parameter></methodparam>
+   <modifier>public</modifier> <type class="union"><type>string</type><type>null</type></type><methodname>XMLReader::getAttributeNs</methodname>
+   <methodparam><type>string</type><parameter>name</parameter></methodparam>
+   <methodparam><type>string</type><parameter>namespace</parameter></methodparam>
   </methodsynopsis>
   <para>
    Returns the value of an attribute by name and namespace URI or an empty 
@@ -23,7 +23,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>localName</parameter></term>
+     <term><parameter>name</parameter></term>
      <listitem>
       <para>
        The local name.
@@ -31,7 +31,7 @@
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>namespaceURI</parameter></term>
+     <term><parameter>namespace</parameter></term>
      <listitem>
       <para>
        The namespace URI.
@@ -47,7 +47,7 @@
   <para>
    The value of the attribute, or an empty string (before PHP 5.6) or &null;
    (from PHP 5.6 onwards) if no attribute with the given
-   <parameter>localName</parameter> and <parameter>namespaceURI</parameter> is
+   <parameter>name</parameter> and <parameter>namespace</parameter> is
    found or not positioned of element.
   </para>
  </refsect1>
@@ -64,6 +64,12 @@
       </row>
      </thead>
      <tbody>
+      <row>
+       <entry>8.0.0</entry>
+       <entry>
+        This function can longer return &false;.
+       </entry>
+      </row>
       <row>
        <entry>5.6.0</entry>
        <entry>
@@ -87,7 +93,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
diff --git a/reference/xmlreader/xmlreader/lookupnamespace.xml b/reference/xmlreader/xmlreader/lookupnamespace.xml
index 6165c6b3cf..fb771ee31a 100644
--- a/reference/xmlreader/xmlreader/lookupnamespace.xml
+++ b/reference/xmlreader/xmlreader/lookupnamespace.xml
@@ -8,9 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
-   <type>string</type>
-   <methodname>XMLReader::lookupNamespace</methodname>
+   <modifier>public</modifier> <type class="union"><type>string</type><type>null</type></type><methodname>XMLReader::lookupNamespace</methodname>
    <methodparam><type>string</type><parameter>prefix</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -38,8 +36,30 @@
    &return.success;
   </para>
  </refsect1>
-</refentry>
 
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.0.0</entry>
+      <entry>
+       This function can longer return &false;.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
+</refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
diff --git a/reference/xmlreader/xmlreader/movetoattributens.xml b/reference/xmlreader/xmlreader/movetoattributens.xml
index 957536282e..47fcafb937 100644
--- a/reference/xmlreader/xmlreader/movetoattributens.xml
+++ b/reference/xmlreader/xmlreader/movetoattributens.xml
@@ -8,11 +8,9 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
-   <type>bool</type>
-   <methodname>XMLReader::moveToAttributeNs</methodname>
-   <methodparam><type>string</type><parameter>localName</parameter></methodparam>
-   <methodparam><type>string</type><parameter>namespaceURI</parameter></methodparam>
+   <modifier>public</modifier> <type>bool</type><methodname>XMLReader::moveToAttributeNs</methodname>
+   <methodparam><type>string</type><parameter>name</parameter></methodparam>
+   <methodparam><type>string</type><parameter>namespace</parameter></methodparam>
   </methodsynopsis>
   <para>
    Positions cursor on the named attribute in specified namespace.
@@ -23,7 +21,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>localName</parameter></term>
+     <term><parameter>name</parameter></term>
      <listitem>
       <para>
        The local name.
@@ -31,7 +29,7 @@
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>namespaceURI</parameter></term>
+     <term><parameter>namespace</parameter></term>
      <listitem>
       <para>
        The namespace URI.
@@ -59,7 +57,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
diff --git a/reference/xmlreader/xmlreader/next.xml b/reference/xmlreader/xmlreader/next.xml
index 7daec6d68f..357aec4dbd 100644
--- a/reference/xmlreader/xmlreader/next.xml
+++ b/reference/xmlreader/xmlreader/next.xml
@@ -8,10 +8,8 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
-   <type>bool</type>
-   <methodname>XMLReader::next</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>localname</parameter></methodparam>
+   <modifier>public</modifier> <type>bool</type><methodname>XMLReader::next</methodname>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>
   <para>
    Positions cursor on the next node skipping all subtrees.
@@ -22,7 +20,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>localname</parameter></term>
+     <term><parameter>name</parameter></term>
      <listitem>
       <para>
        The name of the next node to move to.
@@ -38,6 +36,29 @@
    &return.success;
   </para>
  </refsect1>
+
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.0.0</entry>
+      <entry>
+       <parameter>name</parameter> is nullable now.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
@@ -49,7 +70,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
diff --git a/reference/xmlreader/xmlreader/open.xml b/reference/xmlreader/xmlreader/open.xml
index 28173460f6..40ef4ea1be 100644
--- a/reference/xmlreader/xmlreader/open.xml
+++ b/reference/xmlreader/xmlreader/open.xml
@@ -9,12 +9,10 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
-   <type>bool</type>
-   <methodname>XMLReader::open</methodname>
-   <methodparam><type>string</type><parameter>URI</parameter></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
-   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
+   <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>bool</type><type>XMLReader</type></type><methodname>XMLReader::open</methodname>
+   <methodparam><type>string</type><parameter>uri</parameter></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   </methodsynopsis>
   <para>
    Set the URI containing the XML document to be parsed.
@@ -26,7 +24,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>URI</parameter></term>
+     <term><parameter>uri</parameter></term>
      <listitem>
       <para>
        URI pointing to the document.
@@ -42,7 +40,7 @@
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>options</parameter></term>
+     <term><parameter>flags</parameter></term>
      <listitem>
       <para>
        A bitmask of the <link linkend="libxml.constants">LIBXML_*</link> 
@@ -64,7 +62,33 @@
 
  <refsect1 role="errors">
   &reftitle.errors;
-  &dom.allowstatic;
+  <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>
+ </refsect1>
+
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.0.0</entry>
+      <entry>
+       <methodname>XMLReader::open</methodname> is now declared as static method,
+       but can still be called on an <classname>XMLReader</classname> instance.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
  </refsect1>
 
  <refsect1 role="seealso">
@@ -77,7 +101,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
diff --git a/reference/xmlreader/xmlreader/setrelaxngschema.xml b/reference/xmlreader/xmlreader/setrelaxngschema.xml
index 9ccbdc163a..322c38ef64 100644
--- a/reference/xmlreader/xmlreader/setrelaxngschema.xml
+++ b/reference/xmlreader/xmlreader/setrelaxngschema.xml
@@ -8,10 +8,8 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
-   <type>bool</type>
-   <methodname>XMLReader::setRelaxNGSchema</methodname>
-   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
+   <modifier>public</modifier> <type>bool</type><methodname>XMLReader::setRelaxNGSchema</methodname>
+   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>filename</parameter></methodparam>
   </methodsynopsis>
   <para>
    Set the filename or URI for the RelaxNG Schema to use for validation.
@@ -49,7 +47,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
diff --git a/reference/xmlreader/xmlreader/setrelaxngschemasource.xml b/reference/xmlreader/xmlreader/setrelaxngschemasource.xml
index 5f9df94ca3..83504f8150 100644
--- a/reference/xmlreader/xmlreader/setrelaxngschemasource.xml
+++ b/reference/xmlreader/xmlreader/setrelaxngschemasource.xml
@@ -8,10 +8,8 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
-   <type>bool</type>
-   <methodname>XMLReader::setRelaxNGSchemaSource</methodname>
-   <methodparam><type>string</type><parameter>source</parameter></methodparam>
+   <modifier>public</modifier> <type>bool</type><methodname>XMLReader::setRelaxNGSchemaSource</methodname>
+   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>source</parameter></methodparam>
   </methodsynopsis>
   <para>
    Set the data containing a RelaxNG Schema to use for validation.
@@ -49,7 +47,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
diff --git a/reference/xmlreader/xmlreader/setschema.xml b/reference/xmlreader/xmlreader/setschema.xml
index c21acb6629..53bcc367f5 100644
--- a/reference/xmlreader/xmlreader/setschema.xml
+++ b/reference/xmlreader/xmlreader/setschema.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-
 <refentry xml:id="xmlreader.setschema" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>XMLReader::setSchema</refname>
@@ -11,7 +10,7 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type>bool</type><methodname>XMLReader::setSchema</methodname>
-   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
+   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>filename</parameter></methodparam>
   </methodsynopsis>
   <para>
    Use W3C XSD schema to validate the document as it is processed. Activation
@@ -101,7 +100,6 @@ Use a screen like we did below
   </para>
  </refsect1>
 </refentry>
- 
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
@@ -122,4 +120,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
 vim: et tw=78 syn=sgml
 vi: ts=1 sw=1
 -->
-
diff --git a/reference/xmlreader/xmlreader/xml.xml b/reference/xmlreader/xmlreader/xml.xml
index 54ca343628..82ee1ade9c 100644
--- a/reference/xmlreader/xmlreader/xml.xml
+++ b/reference/xmlreader/xmlreader/xml.xml
@@ -9,12 +9,12 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
+   <modifier>public</modifier> <modifier>static</modifier>
    <type>bool</type>
    <methodname>XMLReader::xml</methodname>
    <methodparam><type>string</type><parameter>source</parameter></methodparam>
    <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
-   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   </methodsynopsis>
   <para>
    Set the data containing the XML to parse.
@@ -42,7 +42,7 @@
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>options</parameter></term>
+     <term><parameter>flags</parameter></term>
      <listitem>
       <para>
        A bitmask of the <link linkend="libxml.constants">LIBXML_*</link> 
@@ -64,7 +64,33 @@
 
  <refsect1 role="errors">
   &reftitle.errors;
-  &dom.allowstatic;
+  <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>
+ </refsect1>
+
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.0.0</entry>
+      <entry>
+       <methodname>XMLReader::xml</methodname> is now declared as static method,
+       but can still be called on an <classname>XMLReader</classname> instance.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
  </refsect1>
 
  <refsect1 role="seealso">