sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 08:28:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Regenerate ext/spl method synopses based on stubs (#1273)

Browse source 
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
This commit is contained in:
Máté Kocsis 2021-12-28 18:34:24 +01:00 committed by GitHub
parent 7a650f743a
commit 4c0d1f0934
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 63 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
reference/spl/arrayiterator/key.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>ArrayIterator::key</methodname>
<modifier>public</modifier> <type class="union"><type>string</type><type>int</type><type>null</type></type><methodname>ArrayIterator::key</methodname>
<void/>
</methodsynopsis>
<para>
@ -50,7 +50,6 @@ echo $iterator->key(); //key
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

2
reference/spl/emptyiterator/current.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>EmptyIterator::current</methodname>
<modifier>public</modifier> <type>never</type><methodname>EmptyIterator::current</methodname>
<void/>
</methodsynopsis>
<para>

3
reference/spl/emptyiterator/key.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>EmptyIterator::key</methodname>
<modifier>public</modifier> <type>never</type><methodname>EmptyIterator::key</methodname>
<void/>
</methodsynopsis>
<para>
@ -38,7 +38,6 @@
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

36
reference/spl/multipleiterator/current.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>MultipleIterator::current</methodname>
<modifier>public</modifier> <type>array</type><methodname>MultipleIterator::current</methodname>
<void/>
</methodsynopsis>
<para>
@ -28,21 +28,45 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An <type>array</type> containing the current values of each attached iterator,
or &false; if no iterators are attached.
An <type>array</type> containing the current values of each attached iterator.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
A <classname>RuntimeException</classname> if mode <constant>MIT_NEED_ALL</constant>
is set and at least one attached iterator is not valid. Or an
<classname>IllegalValueException</classname> if a key is &null; and
A <classname>RuntimeException</classname> if the iterator is invalid (as of PHP 8.1.0),
or mode <constant>MIT_NEED_ALL</constant> is set and at least one attached iterator is
not valid. Or an <classname>IllegalValueException</classname> if a key is &null; and
<constant>MIT_KEYS_ASSOC</constant> is set.
</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.1.0</entry>
<entry>
A <classname>RuntimeException</classname> is now thrown if
<methodname>MultipleIterator::current</methodname> is called on an
invalid iterator. Previously, &false; was returned.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>

33
reference/spl/multipleiterator/key.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>MultipleIterator::key</methodname>
<modifier>public</modifier> <type>array</type><methodname>MultipleIterator::key</methodname>
<void/>
</methodsynopsis>
<para>
@ -28,16 +28,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An <type>array</type> of all registered iterator instances,
or &false; if no sub iterator is attached.
An <type>array</type> of all registered iterator instances.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
A <classname>LogicException</classname> if mode <constant>MIT_NEED_ALL</constant> is set,
and at least one attached iterator is not valid.
A <classname>RuntimeException</classname> if the iterator is invalid (as of PHP 8.1.0), or
mode <constant>MIT_NEED_ALL</constant> is set, and at least one attached iterator is not valid.
</para>
<para>
Calling this method from <xref linkend="control-structures.foreach"/>
@ -45,6 +44,30 @@
</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.1.0</entry>
<entry>
A <classname>RuntimeException</classname> is now thrown if
<methodname>MultipleIterator::key</methodname> is called on an
invalid iterator. Previously, &false; was returned.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>

6
reference/spl/recursiveiteratoriterator/callhaschildren.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>bool</type><type>null</type></type><methodname>RecursiveIteratorIterator::callHasChildren</methodname>
<modifier>public</modifier> <type>bool</type><methodname>RecursiveIteratorIterator::callHasChildren</methodname>
<void/>
</methodsynopsis>
<para>
@ -28,11 +28,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&null; if the element has children, otherwise &false;
Returns whether the element has children.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: