mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
27960e632c
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@146503 c90b9560-bf6c-de11-be94-00142212c4b1
75 lines
2.2 KiB
XML
75 lines
2.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.9 $ -->
|
|
<!-- splitted from ./en/functions/array.xml, last change in rev 1.13 -->
|
|
<refentry id="function.array-rand">
|
|
<refnamediv>
|
|
<refname>array_rand</refname>
|
|
<refpurpose>
|
|
Pick one or more random entries out of an array
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>array_rand</methodname>
|
|
<methodparam><type>array</type><parameter>input</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>num_req</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>array_rand</function> is rather useful when you want to
|
|
pick one or more random entries out of an array. It takes an
|
|
<parameter>input</parameter> array and an optional argument
|
|
<parameter>num_req</parameter> which specifies how many entries you
|
|
want to pick - if not specified, it defaults to 1.
|
|
</para>
|
|
<para>
|
|
If you are picking only one entry, <function>array_rand</function>
|
|
returns the key for a random entry. Otherwise, it returns an array
|
|
of keys for the random entries. This is done so that you can pick
|
|
random keys as well as values out of the array.
|
|
</para>
|
|
|
|
¬e.randomseed;
|
|
|
|
<para>
|
|
<example>
|
|
<title><function>array_rand</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
srand((float) microtime() * 10000000);
|
|
$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>
|
|
<para>
|
|
See also <function>shuffle</function>.
|
|
</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:"../../../../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
|
|
-->
|