Various methodsynopsis updates based on recent stub changes

* Update ext/zip methodsynopses based on stubs * Update resource-related ext/standard methodsynopses based on stubs * Update ext/dom methodsynopses based on stubs * Update ext/ffi methodsynopses based on stubs * Update ext/fileinfo methodsynopses based on stubs * Update ext/soap methodsynopses based on stubs * Update ext/sodium methodsynopses based on stubs * Update ext/ldap methodsynopses based on stubs Closes GH-598.
php · May 22, 2021 · 5770355 · 5770355
1 parent 0867f48
commit 5770355
Show file tree

Hide file tree

Showing 18 changed files with 190 additions and 38 deletions.
diff --git a/reference/dom/domdocument/getelementsbytagnamens.xml b/reference/dom/domdocument/getelementsbytagnamens.xml
@@ -11,7 +11,7 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type>DOMNodeList</type><methodname>DOMDocument::getElementsByTagNameNS</methodname>
-   <methodparam><type>string</type><parameter>namespace</parameter></methodparam>
+   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>namespace</parameter></methodparam>
    <methodparam><type>string</type><parameter>localName</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -51,6 +51,29 @@
    elements.
   </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.3</entry>
+      <entry>
+       <parameter>namespace</parameter> is nullable now.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>

diff --git a/reference/dom/domelement/getelementsbytagnamens.xml b/reference/dom/domelement/getelementsbytagnamens.xml
@@ -9,7 +9,7 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type>DOMNodeList</type><methodname>DOMElement::getElementsByTagNameNS</methodname>
-   <methodparam><type>string</type><parameter>namespace</parameter></methodparam>
+   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>namespace</parameter></methodparam>
    <methodparam><type>string</type><parameter>localName</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -49,6 +49,29 @@
    which they are encountered in a preorder traversal of this element tree.
   </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.3</entry>
+      <entry>
+       <parameter>namespace</parameter> is nullable now.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>

diff --git a/reference/dom/domimplementation/createdocument.xml b/reference/dom/domimplementation/createdocument.xml
@@ -11,7 +11,7 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type class="union"><type>DOMDocument</type><type>false</type></type><methodname>DOMImplementation::createDocument</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>namespace</parameter><initializer>""</initializer></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>namespace</parameter><initializer>&null;</initializer></methodparam>
    <methodparam choice="opt"><type>string</type><parameter>qualifiedName</parameter><initializer>""</initializer></methodparam>
    <methodparam choice="opt"><type class="union"><type>DOMDocumentType</type><type>null</type></type><parameter>doctype</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>
@@ -61,6 +61,28 @@
   </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.3</entry>
+      <entry>
+       <parameter>namespace</parameter> is nullable now.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="errors">
   &reftitle.errors;
   <para>

diff --git a/reference/ffi/ffi/cast.xml b/reference/ffi/ffi/cast.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-
 <refentry xml:id="ffi.cast" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>FFI::cast</refname>
@@ -15,7 +14,7 @@
    <methodparam><type class="union"><type>FFI\CData</type><type>int</type><type>float</type><type>bool</type><type>null</type></type><parameter role="reference">ptr</parameter></methodparam>
   </methodsynopsis>
   <methodsynopsis>
-   <modifier>public</modifier> <type class="union"><type>FFI\CData</type><type>null</type></type><methodname>FFI::cast</methodname>
+   <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>FFI\CData</type><type>null</type></type><methodname>FFI::cast</methodname>
    <methodparam><type class="union"><type>FFI\CType</type><type>string</type></type><parameter>type</parameter></methodparam>
    <methodparam><type class="union"><type>FFI\CData</type><type>int</type><type>float</type><type>bool</type><type>null</type></type><parameter role="reference">ptr</parameter></methodparam>
   </methodsynopsis>
@@ -62,7 +61,6 @@
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/ffi/ffi/new.xml b/reference/ffi/ffi/new.xml
@@ -15,7 +15,7 @@
    <methodparam choice="opt"><type>bool</type><parameter>persistent</parameter><initializer>&false;</initializer></methodparam>
   </methodsynopsis>
   <methodsynopsis>
-   <modifier>public</modifier> <type class="union"><type>FFI\CData</type><type>null</type></type><methodname>FFI::new</methodname>
+   <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>FFI\CData</type><type>null</type></type><methodname>FFI::new</methodname>
    <methodparam><type class="union"><type>FFI\CType</type><type>string</type></type><parameter>type</parameter></methodparam>
    <methodparam choice="opt"><type>bool</type><parameter>owned</parameter><initializer>&true;</initializer></methodparam>
    <methodparam choice="opt"><type>bool</type><parameter>persistent</parameter><initializer>&false;</initializer></methodparam>

diff --git a/reference/ffi/ffi/type.xml b/reference/ffi/ffi/type.xml
@@ -13,7 +13,7 @@
    <methodparam><type>string</type><parameter>type</parameter></methodparam>
   </methodsynopsis>
   <methodsynopsis>
-   <modifier>public</modifier> <type class="union"><type>FFI\CType</type><type>null</type></type><methodname>FFI::type</methodname>
+   <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>FFI\CType</type><type>null</type></type><methodname>FFI::type</methodname>
    <methodparam><type>string</type><parameter>type</parameter></methodparam>
   </methodsynopsis>
   <para>

diff --git a/reference/fileinfo/finfo/construct.xml b/reference/fileinfo/finfo/construct.xml
@@ -11,12 +11,34 @@
   <constructorsynopsis role="oop">
    <modifier>public</modifier> <methodname>finfo::__construct</methodname>
    <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>FILEINFO_NONE</constant></initializer></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>magic_database</parameter><initializer>""</initializer></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>magic_database</parameter><initializer>&null;</initializer></methodparam>
   </constructorsynopsis>
   <para>
    &info.function.alias; <function>finfo_open</function>
   </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.3</entry>
+      <entry>
+       <parameter>magic_database</parameter> is nullable now.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:

diff --git a/reference/fileinfo/functions/finfo-open.xml b/reference/fileinfo/functions/finfo-open.xml
@@ -13,13 +13,13 @@
   <methodsynopsis role="procedural">
    <type class="union"><type>resource</type><type>false</type></type><methodname>finfo_open</methodname>
    <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>FILEINFO_NONE</constant></initializer></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>magic_database</parameter><initializer>""</initializer></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>magic_database</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>
   <para>&style.oop; (constructor):</para>
   <constructorsynopsis role="oop">
    <modifier>public</modifier> <methodname>finfo::__construct</methodname>
    <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>FILEINFO_NONE</constant></initializer></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>magic_database</parameter><initializer>""</initializer></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>magic_database</parameter><initializer>&null;</initializer></methodparam>
   </constructorsynopsis>
   <para>
    This function opens a magic database and returns its resource.
@@ -67,6 +67,28 @@
   </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.3</entry>
+      <entry>
+       <parameter>magic_database</parameter> is nullable now.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   <warning>

diff --git a/reference/ldap/functions/ldap-next-entry.xml b/reference/ldap/functions/ldap-next-entry.xml
@@ -11,14 +11,14 @@
   <methodsynopsis>
    <type class="union"><type>resource</type><type>false</type></type><methodname>ldap_next_entry</methodname>
    <methodparam><type>resource</type><parameter>ldap</parameter></methodparam>
-   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
+   <methodparam><type>resource</type><parameter>entry</parameter></methodparam>
   </methodsynopsis>
   <para>
    Retrieve the entries stored in the result. Successive calls to the
    <function>ldap_next_entry</function> return entries one by one till there
    are no more entries. The first call to <function>ldap_next_entry</function>
    is made after the call to <function>ldap_first_entry</function> with the
-   <parameter>result</parameter> as returned from the
+   <parameter>entry</parameter> as returned from the
    <function>ldap_first_entry</function>.
   </para>
  </refsect1>
@@ -36,7 +36,7 @@
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>result</parameter></term>
+     <term><parameter>entry</parameter></term>
      <listitem>
       <para>
       </para>

diff --git a/reference/soap/soapclient/setlocation.xml b/reference/soap/soapclient/setlocation.xml
@@ -10,7 +10,7 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type class="union"><type>string</type><type>null</type></type><methodname>SoapClient::__setLocation</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>location</parameter><initializer>""</initializer></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>location</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>
   <para>
    Sets the endpoint URL that will be touched by following SOAP requests. This is equivalent to
@@ -47,6 +47,28 @@
   </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.3</entry>
+      <entry>
+       <parameter>location</parameter> is nullable now.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>

diff --git a/reference/soap/soapvar/construct.xml b/reference/soap/soapvar/construct.xml
@@ -12,10 +12,10 @@
    <modifier>public</modifier> <methodname>SoapVar::__construct</methodname>
    <methodparam><type>mixed</type><parameter>data</parameter></methodparam>
    <methodparam><type class="union"><type>int</type><type>null</type></type><parameter>encoding</parameter></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>typeName</parameter><initializer>""</initializer></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>typeNamespace</parameter><initializer>""</initializer></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>nodeName</parameter><initializer>""</initializer></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>nodeNamespace</parameter><initializer>""</initializer></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>typeName</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>typeNamespace</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>nodeName</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>nodeNamespace</parameter><initializer>&null;</initializer></methodparam>
   </constructorsynopsis>
   <para>
    Constructs a new <classname>SoapVar</classname> object.
@@ -78,6 +78,29 @@
   </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.3</entry>
+      <entry>
+       <parameter>typeName</parameter>, <parameter>typeNamespace</parameter>, <parameter>nodeName</parameter>,and
+       <parameter>nodeNamespace</parameter> are nullable now.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
@@ -117,7 +140,6 @@ $client->echoStruct(new SoapParam($soapstruct, "inputStruct"));
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/sodium/functions/sodium-crypto-box-seal.xml b/reference/sodium/functions/sodium-crypto-box-seal.xml
@@ -11,7 +11,7 @@
   <methodsynopsis>
    <type>string</type><methodname>sodium_crypto_box_seal</methodname>
    <methodparam><type>string</type><parameter>message</parameter></methodparam>
-   <methodparam><type>string</type><parameter>key_pair</parameter></methodparam>
+   <methodparam><type>string</type><parameter>public_key</parameter></methodparam>
   </methodsynopsis>
   <para>
 
@@ -33,7 +33,7 @@
     </listitem>
    </varlistentry>
    <varlistentry>
-    <term><parameter>key_pair</parameter></term>
+    <term><parameter>public_key</parameter></term>
     <listitem>
      <para>
 

diff --git a/reference/sodium/functions/sodium-crypto-sign-open.xml b/reference/sodium/functions/sodium-crypto-sign-open.xml
@@ -10,7 +10,7 @@
   &reftitle.description;
   <methodsynopsis>
    <type class="union"><type>string</type><type>false</type></type><methodname>sodium_crypto_sign_open</methodname>
-   <methodparam><type>string</type><parameter>ciphertext</parameter></methodparam>
+   <methodparam><type>string</type><parameter>signed_message</parameter></methodparam>
    <methodparam><type>string</type><parameter>public_key</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -25,7 +25,7 @@
   &reftitle.parameters;
   <variablelist>
    <varlistentry>
-    <term><parameter>ciphertext</parameter></term>
+    <term><parameter>signed_message</parameter></term>
     <listitem>
      <para>