reference/strings/functions/str-shuffle.xml
52c495140bdb84f45f186bfb1cccf09788b0121e
52c495140bdb84f45f186bfb1cccf09788b0121e
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.str-shuffle">
3
+
<refentry xml:id="function.str-shuffle" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
4
4
<refnamediv>
5
5
<refname>str_shuffle</refname>
6
6
<refpurpose>Randomly shuffles a string</refpurpose>
...
...
@@ -10,12 +10,13 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>string</type><methodname>str_shuffle</methodname>
13
-
<methodparam><type>string</type><parameter>str</parameter></methodparam>
13
+
<methodparam><type>string</type><parameter>string</parameter></methodparam>
14
14
</methodsynopsis>
15
15
<simpara>
16
16
<function>str_shuffle</function> shuffles a string. One permutation
17
17
of all possible is created.
18
18
</simpara>
19
+
&caution.cryptographically-insecure;
19
20
</refsect1>
20
21
21
22
<refsect1 role="parameters">
...
...
@@ -23,7 +24,7 @@
23
24
<para>
24
25
<variablelist>
25
26
<varlistentry>
26
-
<term><parameter>str</parameter></term>
27
+
<term><parameter>string</parameter></term>
27
28
<listitem>
28
29
<para>
29
30
The input string.
...
...
@@ -41,6 +42,30 @@
41
42
</para>
42
43
</refsect1>
43
44
45
+
<refsect1 role="changelog">
46
+
&reftitle.changelog;
47
+
<para>
48
+
<informaltable>
49
+
<tgroup cols="2">
50
+
<thead>
51
+
<row>
52
+
<entry>&Version;</entry>
53
+
<entry>&Description;</entry>
54
+
</row>
55
+
</thead>
56
+
<tbody>
57
+
<row>
58
+
<entry>7.1.0</entry>
59
+
<entry>
60
+
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.
61
+
</entry>
62
+
</row>
63
+
</tbody>
64
+
</tgroup>
65
+
</informaltable>
66
+
</para>
67
+
</refsect1>
68
+
44
69
<refsect1 role="examples">
45
70
&reftitle.examples;
46
71
<para>
...
...
@@ -65,14 +90,13 @@ echo $shuffled;
65
90
&reftitle.seealso;
66
91
<para>
67
92
<simplelist>
68
-
<member><function>shuffle</function></member>
69
-
<member><function>rand</function></member>
93
+
<member><function>Random\Randomizer::shuffleBytes</function></member>
94
+
<member><function>Random\Randomizer::shuffleArray</function></member>
70
95
</simplelist>
71
96
</para>
72
97
</refsect1>
73
98
74
99
</refentry>
75
-
76
100
<!-- Keep this comment at the end of the file
77
101
Local variables:
78
102
mode: sgml
79
103