reference/array/functions/shuffle.xml
f781803449007bb0e3a96c693e0eee067f7eb466
...
...
@@ -8,15 +8,13 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>bool</type><methodname>shuffle</methodname>
11
+
<type>true</type><methodname>shuffle</methodname>
12
12
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
13
13
</methodsynopsis>
14
14
<para>
15
15
This function shuffles (randomizes the order of the elements in) an array.
16
-
It uses a pseudo random number generator that is not suitable for
17
-
cryptographic purposes.
18
16
</para>
19
-
&note.sort-unstable;
17
+
&caution.cryptographically-insecure;
20
18
</refsect1>
21
19
<refsect1 role="parameters">
22
20
&reftitle.parameters;
...
...
@@ -36,7 +34,7 @@
36
34
<refsect1 role="returnvalues">
37
35
&reftitle.returnvalues;
38
36
<para>
39
-
&return.success;
37
+
&return.true.always;
40
38
</para>
41
39
</refsect1>
42
40
<refsect1 role="changelog">
...
...
@@ -54,7 +52,7 @@
54
52
<row>
55
53
<entry>7.1.0</entry>
56
54
<entry>
57
-
<link linkend="migration71.incompatible.rand-srand-aliases">The internal randomization algorithm has been changed to use the <link xlink:href="&url.mersenne;">Mersenne Twister</link> Random Number Generator instead of the libc rand function.</link>
55
+
The internal randomization algorithm <link linkend="migration71.incompatible.rand-srand-aliases">has been changed</link> to use the <link xlink:href="&url.mersenne;">Mersenne Twister</link> Random Number Generator instead of the libc rand function.
58
56
</entry>
59
57
</row>
60
58
</tbody>
...
...
@@ -85,18 +83,20 @@ foreach ($numbers as $number) {
85
83
<refsect1 role="notes">
86
84
&reftitle.notes;
87
85
&note.no-key-association;
86
+
&note.reset-index;
88
87
</refsect1>
89
88
<refsect1 role="seealso">
90
89
&reftitle.seealso;
91
90
<para>
92
91
<simplelist>
93
-
<member><function>array_rand</function></member>
92
+
<member><function>Random\Randomizer::shuffleArray</function></member>
93
+
<member><function>Random\Randomizer::shuffleBytes</function></member>
94
+
<member><function>Random\Randomizer::pickArrayKeys</function></member>
94
95
<member>&seealso.array.sorting;</member>
95
96
</simplelist>
96
97
</para>
97
98
</refsect1>
98
99
</refentry>
99
-

100
100
<!-- Keep this comment at the end of the file
101
101
Local variables:
102
102
mode: sgml
103
103