mirror of
https://github.com/php/doc-zh.git
synced 2026-03-24 07:02:15 +01:00
154 lines
4.6 KiB
XML
Executable File
154 lines
4.6 KiB
XML
Executable File
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- $Revision$ -->
|
||
<!-- EN-Revision: 4a1dedc24b1e085f298ab1d5dadefe306373691b Maintainer: HonestQiao Status: ready -->
|
||
<!-- CREDITS: mowangjuanzi, Luffy -->
|
||
<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>从数组中随机取出一个或多个随机键</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>
|
||
从数组中取出一个或多个随机的单元，并返回随机条目对应的键（一个或多个）。
|
||
</para>
|
||
&caution.cryptographically-insecure;
|
||
</refsect1>
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<para>
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>array</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
输入的数组。
|
||
不能为空。
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>num</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
指定要取出的单元数量。
|
||
必须大于零，且小于或等于 <parameter>array</parameter> 的长度。
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
如果只取出一个，<function>array_rand</function>
|
||
返回随机单元的键名。
|
||
否则就返回包含随机键名的数组。
|
||
完成后，就可以根据随机的键获取数组的随机值。
|
||
如果返回的是包含随机键名的数组，数组单元的顺序按照键名在原数组中的顺序排列。
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="errors">
|
||
&reftitle.errors;
|
||
<para>
|
||
如果 <parameter>array</parameter> 为空，或者 <parameter>num</parameter> 超出范围，
|
||
就会抛出一个 <classname>ValueError</classname>。
|
||
</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>
|
||
如果 <parameter>num</parameter> 超出范围，<function>array_rand</function>
|
||
现在会抛出一个 <classname>ValueError</classname>；
|
||
之前会抛出一个 <constant>E_WARNING</constant>，并返回 &null;。
|
||
</entry>
|
||
</row>
|
||
<row>
|
||
<entry>8.0.0</entry>
|
||
<entry>
|
||
如果 <parameter>array</parameter> 为空，<function>array_rand</function>
|
||
现在会抛出一个 <classname>ValueError</classname>；
|
||
之前会抛出一个 <constant>E_WARNING</constant>，并返回 &null;。
|
||
</entry>
|
||
</row>
|
||
<row>
|
||
<entry>7.1.0</entry>
|
||
<entry>
|
||
内部随机化算法已从 libc rand 函数<link linkend="migration71.incompatible.rand-srand-aliases">更改为</link>使用
|
||
<link xlink:href="&url.mersenne;">梅森旋转算法（Mersenne Twister）</link> 随机数生成器。
|
||
</entry>
|
||
</row>
|
||
</tbody>
|
||
</tgroup>
|
||
</informaltable>
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="examples">
|
||
&reftitle.examples;
|
||
<para>
|
||
<example>
|
||
<title><function>array_rand</function> 例子</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
|
||
-->
|