Repository navigation
Expand file tree
/
Copy patharray-rand.xml
More file actions
174 lines (166 loc) · 5.13 KB
/
Copy patharray-rand.xml
File metadata and controls
174 lines (166 loc) · 5.13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d6dc2be3c5c70e4a1c3d13f788643ea232747c19 Maintainer: gerdtsteltner Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: cd943f94a013b74df8765ab8e1a620a916a64a85 Reviewer: samesch -->
<!-- CREDITS: tom -->
<refentry xml:id="function.array-rand" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>array_rand</refname>
<refpurpose>Liefert einen oder mehrere zufällige Schlüssel eines Arrays</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>string</type><type>array</type></type><methodname>array_rand</methodname>
<methodparam><type>array</type><parameter>array</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>num</parameter><initializer>1</initializer></methodparam>
</methodsynopsis>
<para>
Wählt einen oder mehrere Einträge aus einem Array aus und gibt den
Schlüssel des zufälligen Eintrags bzw. die Schlüssel der zufälligen
Einträge zurück.
</para>
&caution.cryptographically-insecure;
&caution.mt19937-global-state;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
Das Eingabe-Array; darf nicht leer sein
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>num</parameter></term>
<listitem>
<para>
Gibt an, wie viele Einträge ausgewählt werden sollen; muss größer als
Null und kleiner oder gleich der Länge von <parameter>array</parameter>
sein
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Wenn nur ein Eintrag ausgewählt wird, gibt <function>array_rand</function>
den Schlüssel eines zufälligen Eintrages zurück. Andernfalls wird ein Array
mit den Schlüsseln der zufälligen Einträge zurückgegeben. Dies hat den
Zweck, dass zufällige Schlüssel und auch Werte aus dem Array ausgewählt
werden können. Wenn mehrere Schlüssel zurückgegeben werden, werden sie in
der Reihenfolge zurückgegeben, in der sie im ursprünglichen Array
vorliegen.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Wenn <parameter>array</parameter> leer ist oder <parameter>num</parameter>
außerhalb des zulässigen Bereichs liegt, wird ein
<classname>ValueError</classname> geworfen.
</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.0.0</entry>
<entry>
Wenn <parameter>num</parameter> außerhalb des zulässigen Bereichs
liegt, wirft <function>array_rand</function> nun einen
<classname>ValueError</classname>; zuvor wurde ein
<constant>E_WARNING</constant> ausgegeben, und die Funktion gab &null;
zurück.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
Wenn <parameter>array</parameter> leer ist, wirft
<function>array_rand</function> nun einen
<classname>ValueError</classname>; zuvor wurde ein
<constant>E_WARNING</constant> ausgegeben, und die Funktion gab &null;
zurück.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
Zur Erzeugung der Zufallszahlen
<link linkend="migration71.incompatible.rand-srand-aliases">kommt intern nun</link>
der
<link xlink:href="&url.mersenne;">Mersenne-Primzahlen</link>-Zufallsgenerator
statt der vorherigen libc-rand-Funktion zum Einsatz.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>array_rand</function>-Beispiel</title>
<programlisting role="php">
<![CDATA[
<?php
$input = array("Neo", "Morpheus", "Trinity", "Cypher", "Tank");
$rand_keys = array_rand($input, 2);
echo $input[$rand_keys[0]] . "\n";
echo $input[$rand_keys[1]] . "\n";
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Random\Randomizer::pickArrayKeys</function></member>
<member><function>Random\Randomizer::shuffleArray</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->