Documentation of index reset effect of some array functions - issue #876 (#1077)

Co-authored-by: Alexey Kryuchkov <alexey.kryuchkov@jetbrains.com>

Closes GH-1077.

language-snippets.ent

@@ -147,6 +147,13 @@ from one file system to another.</para></note>'>
 </note>
 '>
 
+<!ENTITY note.reset-index "<note xmlns='http://docbook.org/ns/docbook'>
+ <para>
+    Resets array's internal pointer to the first element.
+ </para>
+</note>
+">
+
 <!ENTITY note.resource-migration-8.0-dead-function '<note xmlns="http://docbook.org/ns/docbook">
  <para>
   This function has no effect. Prior to PHP 8.0.0, this function was used to close the resource.

reference/array/functions/array-multisort.xml

@@ -24,6 +24,7 @@
    keys will be re-indexed.
   </para>
   &note.sort-unstable;
+  &note.reset-index;
  </refsect1>
 
  <refsect1 role="parameters">

reference/array/functions/array-unshift.xml

@@ -19,6 +19,7 @@
    order.  All numerical array keys will be modified to start counting from
    zero while literal keys won't be changed.
   </para>
+  &note.reset-index;
  </refsect1>
  <refsect1 role="parameters">
   &reftitle.parameters;

reference/array/functions/arsort.xml

@@ -22,6 +22,7 @@
    element order is significant.
   </para>
   &note.sort-unstable;
+  &note.reset-index;
  </refsect1>
  <refsect1 role="parameters">
   &reftitle.parameters;

reference/array/functions/asort.xml

@@ -22,6 +22,7 @@
    element order is significant.
   </para>
   &note.sort-unstable;
+  &note.reset-index;
  </refsect1>
 
  <refsect1 role="parameters">

reference/array/functions/krsort.xml

@@ -17,6 +17,7 @@
    in descending order.
   </para>
   &note.sort-unstable;
+  &note.reset-index;
  </refsect1>
 
  <refsect1 role="parameters">

reference/array/functions/ksort.xml

@@ -17,6 +17,7 @@
    in ascending order.
   </para>
   &note.sort-unstable;
+  &note.reset-index;
  </refsect1>
 
  <refsect1 role="parameters">

reference/array/functions/natcasesort.xml

@@ -21,6 +21,7 @@
    key/value associations.  This is described as a "natural ordering".
   </para>
   &note.sort-unstable;
+  &note.reset-index;
  </refsect1>
  <refsect1 role="parameters">
   &reftitle.parameters;

reference/array/functions/natsort.xml

@@ -19,6 +19,7 @@
    (used in <function>sort</function>) can be seen in the example below.
   </para>
   &note.sort-unstable;
+  &note.reset-index;
  </refsect1>
  <refsect1 role="parameters">
   &reftitle.parameters;

reference/array/functions/rsort.xml

@@ -18,6 +18,7 @@
   </para>
   &note.sort-unstable;
   &note.no-key-association;
+  &note.reset-index;
  </refsect1>
 
  <refsect1 role="parameters">

reference/array/functions/shuffle.xml

@@ -84,6 +84,7 @@ foreach ($numbers as $number) {
  <refsect1 role="notes">
   &reftitle.notes;
   &note.no-key-association;
+  &note.reset-index;
  </refsect1>
  <refsect1 role="seealso">
   &reftitle.seealso;

reference/array/functions/sort.xml

@@ -18,6 +18,7 @@
   </para>
   &note.sort-unstable;
   &note.no-key-association;
+  &note.reset-index;
  </refsect1>
 
  <refsect1 role="parameters">

reference/array/functions/uasort.xml

@@ -23,6 +23,7 @@
    element order is significant.
   </para>
   &note.sort-unstable;
+  &note.reset-index;
  </refsect1>
 
  <refsect1 role="parameters">

reference/array/functions/uksort.xml

@@ -17,6 +17,7 @@
    user-supplied comparison function to determine the order.
   </para>
   &note.sort-unstable;
+  &note.reset-index;
  </refsect1>
 
  <refsect1 role="parameters">