Reference spl arrayiterator (#370)

* ajustes count do arrayiterator conforme d51166ca16fda8e766849505b84f9306ef443f71 * ajustes no arquivo current.xml do arrayiterator conforme revisão em inglês d51166ca16fda8e766849505b84f9306ef443f71 * ajustea arquivo getflags.xml do arrayiterator conforme revisão em inglês d51166ca16fda8e766849505b84f9306ef443f71 * ajustes arquivo key.xml do arrayiterator conforme revisão em inglês d51166ca16fda8e766849505b84f9306ef443f71 * ajustes next.xml do spl_arrayiterator conforme revisão em inglês em d51166ca16fda8e766849505b84f9306ef443f71 * ajustes rewind.xml do spl_arrayiterator conforme revisão em inglês em d51166ca16fda8e766849505b84f9306ef443f71 * ajuste seek.xml de spl_arrayiterator conforme revisão em inglês em d51166ca16fda8e766849505b84f9306ef443f71 * ajustes em setflags.xml de spl/arrayiterator conforme revisão em inglês em d51166ca16fda8e766849505b84f9306ef443f71 * ajustes valid.xml de spl/arrayiterator conforme revisão em inglês em d51166ca16fda8e766849505b84f9306ef443f71
php · Nov 28, 2023 · 7c18e3a · 7c18e3a
1 parent 9f933ea
commit 7c18e3a
Show file tree

Hide file tree

Showing 9 changed files with 35 additions and 47 deletions.
diff --git a/reference/spl/arrayiterator/count.xml b/reference/spl/arrayiterator/count.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- EN-Revision: 5154a0e1fad93dd395bf3385bb54f1ae5e05513d Maintainer: none Status: ready --><!-- CREDITS: github:lisaldo -->
-
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: none Status: ready --><!-- CREDITS: github:lisaldo, fernandowobeto -->
 <refentry xml:id="arrayiterator.count" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>ArrayIterator::count</refname>
@@ -9,9 +8,9 @@
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="ArrayIterator">
    <modifier>public</modifier> <type>int</type><methodname>ArrayIterator::count</methodname>
-   <void />
+   <void/>
   </methodsynopsis>
   <para>
    Retorna o número de elementos no <type>array</type>, ou o número de
@@ -45,7 +44,6 @@
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/spl/arrayiterator/current.xml b/reference/spl/arrayiterator/current.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: rafaelbernard Status: ready --><!-- Credits: diogo, @rafaelbernard -->
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: rafaelbernard Status: ready --><!-- Credits: diogo, @rafaelbernard, fernandowobeto -->
 <refentry xml:id="arrayiterator.current" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>ArrayIterator::current</refname>
@@ -8,7 +8,7 @@
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="ArrayIterator">
    <modifier>public</modifier> <type>mixed</type><methodname>ArrayIterator::current</methodname>
    <void/>
   </methodsynopsis>
@@ -64,7 +64,6 @@ for($iterator = $arrayobject->getIterator();
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/spl/arrayiterator/getflags.xml b/reference/spl/arrayiterator/getflags.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- EN-Revision: 4b192801e5fb5c3055db8d506d428e31537160c0 Maintainer: none Status: ready --><!-- CREDITS: github:lisaldo -->
-
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: none Status: ready --><!-- CREDITS: github:lisaldo, fernandowobeto -->
 <refentry xml:id="arrayiterator.getflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>ArrayIterator::getFlags</refname>
@@ -9,9 +8,9 @@
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>ArrayIterator::getFlags</methodname>
-   <void />
+  <methodsynopsis role="ArrayIterator">
+   <modifier>public</modifier> <type>int</type><methodname>ArrayIterator::getFlags</methodname>
+   <void/>
   </methodsynopsis>
   <para>
    Retorna as flags de comportamento do <classname>ArrayIterator</classname>. Veja o método
@@ -43,7 +42,6 @@
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/spl/arrayiterator/key.xml b/reference/spl/arrayiterator/key.xml
@@ -1,5 +1,5 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- EN-Revision: 2fd3f0c96d9d221fe37109775af4df4cf949d5d8 Maintainer: diogo Status: ready -->
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: diogo Status: ready --><!-- CREDITS: fernandowobeto -->
 <refentry xml:id="arrayiterator.key" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>ArrayIterator::key</refname>
@@ -8,8 +8,8 @@
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
-   <type>mixed</type><methodname>ArrayIterator::key</methodname>
+  <methodsynopsis role="ArrayIterator">
+   <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

diff --git a/reference/spl/arrayiterator/next.xml b/reference/spl/arrayiterator/next.xml
@@ -1,5 +1,5 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- EN-Revision: 2fd3f0c96d9d221fe37109775af4df4cf949d5d8 Maintainer: diogo Status: ready -->
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: diogo Status: ready --><!-- CREDITS: fernandowobeto -->
 <refentry xml:id="arrayiterator.next" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>ArrayIterator::next</refname>
@@ -8,8 +8,8 @@
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
-   <type>void</type><methodname>ArrayIterator::next</methodname>
+  <methodsynopsis role="ArrayIterator">
+   <modifier>public</modifier> <type>void</type><methodname>ArrayIterator::next</methodname>
    <void/>
   </methodsynopsis>
   <para>
@@ -63,7 +63,6 @@ while($iterator->valid()) {
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/spl/arrayiterator/rewind.xml b/reference/spl/arrayiterator/rewind.xml
@@ -1,5 +1,5 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- EN-Revision: 2fd3f0c96d9d221fe37109775af4df4cf949d5d8 Maintainer: diogo Status: ready -->
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: diogo Status: ready --><!-- CREDITS: fernandowobeto -->
 <refentry xml:id="arrayiterator.rewind" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>ArrayIterator::rewind</refname>
@@ -8,8 +8,8 @@
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
-   <type>void</type><methodname>ArrayIterator::rewind</methodname>
+  <methodsynopsis role="ArrayIterator">
+   <modifier>public</modifier> <type>void</type><methodname>ArrayIterator::rewind</methodname>
    <void/>
   </methodsynopsis>
   <para>
@@ -57,7 +57,6 @@ echo $iterator->key(); //0
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/spl/arrayiterator/seek.xml b/reference/spl/arrayiterator/seek.xml
@@ -1,5 +1,5 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- EN-Revision: 2fd3f0c96d9d221fe37109775af4df4cf949d5d8 Maintainer: diogo Status: ready -->
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: diogo Status: ready --><!-- CREDITS: fernandowobeto -->
 <refentry xml:id="arrayiterator.seek" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>ArrayIterator::seek</refname>
@@ -8,9 +8,9 @@
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
-   <type>void</type><methodname>ArrayIterator::seek</methodname>
-   <methodparam><type>int</type><parameter>position</parameter></methodparam>
+  <methodsynopsis role="ArrayIterator">
+   <modifier>public</modifier> <type>void</type><methodname>ArrayIterator::seek</methodname>
+   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   </methodsynopsis>
 
    &warn.undocumented.func;
@@ -21,7 +21,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>position</parameter></term>
+     <term><parameter>offset</parameter></term>
      <listitem>
       <para>
        A posição para qual quer apontar.
@@ -40,7 +40,6 @@
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/spl/arrayiterator/setflags.xml b/reference/spl/arrayiterator/setflags.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- EN-Revision: 4b192801e5fb5c3055db8d506d428e31537160c0 Maintainer: none Status: ready --><!-- CREDITS: github:lisaldo -->
-
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: none Status: ready --><!-- CREDITS: github:lisaldo, fernandowobeto -->
 <refentry xml:id="arrayiterator.setflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>ArrayIterator::setFlags</refname>
@@ -9,9 +8,9 @@
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="ArrayIterator">
    <modifier>public</modifier> <type>void</type><methodname>ArrayIterator::setFlags</methodname>
-   <methodparam><type>string</type><parameter>flags</parameter></methodparam>
+   <methodparam><type>int</type><parameter>flags</parameter></methodparam>
   </methodsynopsis>
   <para>
    Define as flags que alteram o comportamento do ArrayIterator
@@ -84,7 +83,6 @@
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/spl/arrayiterator/valid.xml b/reference/spl/arrayiterator/valid.xml
@@ -1,5 +1,5 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- EN-Revision: 2fd3f0c96d9d221fe37109775af4df4cf949d5d8 Maintainer: diogo Status: ready -->
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: diogo Status: ready --><!-- CREDITS: fernandowobeto -->
 <refentry xml:id="arrayiterator.valid" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>ArrayIterator::valid</refname>
@@ -8,8 +8,8 @@
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
-   <type>bool</type><methodname>ArrayIterator::valid</methodname>
+  <methodsynopsis role="ArrayIterator">
+   <modifier>public</modifier> <type>bool</type><methodname>ArrayIterator::valid</methodname>
    <void/>
   </methodsynopsis>
   <para>
@@ -25,7 +25,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   &return.void;
+   Retorna &true; se o iterador for válido, caso contrário &false;
   </para>
  </refsect1>
 
@@ -55,7 +55,6 @@ var_dump($iterator->valid());
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml