[prev in list] [next in list] [prev in thread] [next in thread] 

List:       php-doc-cvs
Subject:    [DOC-CVS] [doc-en] master: Sync DirectoryIterator method return types (#1293)
From:       Máté_Kocsis_via_GitHub <noreply () php ! net>
Date:       2022-03-31 6:37:37
Message-ID: eyaprrHtYEOWYM6AMGXJwQMxJxP7g3sCy1OJAoRak0s () main ! php ! net
[Download RAW message or body]

Author: Máté Kocsis (kocsismate)
Committer: GitHub (web-flow)
Pusher: kocsismate
Date: 2022-03-31T08:34:47+02:00

Commit: https://github.com/php/doc-en/commit/72d156e2064c3a4ebf3789c0e955c101669f0116
Raw diff: https://github.com/php/doc-en/commit/72d156e2064c3a4ebf3789c0e955c101669f0116.diff


Sync DirectoryIterator method return types (#1293)

Changed paths:
  M  reference/spl/directoryiterator/current.xml
  M  reference/spl/directoryiterator/key.xml


Diff:

diff --git a/reference/spl/directoryiterator/current.xml \
b/reference/spl/directoryiterator/current.xml index c6eb263b317..08b9b834e2c 100644
--- a/reference/spl/directoryiterator/current.xml
+++ b/reference/spl/directoryiterator/current.xml
@@ -9,7 +9,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> \
<type>DirectoryIterator</type><methodname>DirectoryIterator::current</methodname> +   \
<modifier>public</modifier> \
<type>mixed</type><methodname>DirectoryIterator::current</methodname>  <void/>
   </methodsynopsis>
 
@@ -79,7 +79,6 @@ while($iterator->valid()) {
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
diff --git a/reference/spl/directoryiterator/key.xml \
b/reference/spl/directoryiterator/key.xml index a409c4eeb5c..b946ba09748 100644
--- a/reference/spl/directoryiterator/key.xml
+++ b/reference/spl/directoryiterator/key.xml
@@ -8,7 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type \
class="union"><type>int</type><type>false</type></type><methodname>DirectoryIterator::key</methodname>
 +   <modifier>public</modifier> \
<type>mixed</type><methodname>DirectoryIterator::key</methodname>  <void/>
   </methodsynopsis>
 
@@ -25,7 +25,32 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   The key for the current <classname>DirectoryIterator</classname> item on success, \
or &false; on failure. +   The key for the current \
<classname>DirectoryIterator</classname> item as an &integer;. +  </para>
+ </refsect1>
+
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>8.1.0</entry>
+       <entry>
+        When the iterator is uninitialized, an <classname>Error</classname> is
+        thrown now. Previously, the method returned &false;.
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
   </para>
  </refsect1>
 

-- 
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php


[prev in list] [next in list] [prev in thread] [next in thread]