<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: d6dc2be3c5c70e4a1c3d13f788643ea232747c19 Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: no -->

<!-- CREDITS: DavidA. -->

<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>Toma una o varias claves, al azar en un array</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>

Selecciona uno o varios valores al azar en un array

y devuelve la o las claves de estos valores.

</para>

&caution.cryptographically-insecure;

&caution.mt19937-global-state;

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>array</parameter></term>

<listitem>

<para>

El array de entrada.

No puede estar vacío.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>num</parameter></term>

<listitem>

<para>

Especifica el número de entradas que se desean recuperar.

Debe ser mayor a cero e inferior o igual a la longitud de <parameter>array</parameter>.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Cuando se recupera una sola entrada, la función

<function>array_rand</function> devuelve la clave de una entrada elegida

al azar. De lo contrario, se devolverá un array de claves de entradas aleatorias. Esto permite hacer una selección al azar de claves,

o bien de valores. Si se devuelven varias claves, entonces lo serán en el orden en que estaban en el array original.

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<para>

Lanza una <classname>ValueError</classname> si <parameter>array</parameter> está vacío,

o si <parameter>num</parameter> está fuera de rango.

</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>

<function>array_rand</function> ahora lanza una <classname>ValueError</classname>

si <parameter>num</parameter> está fuera de rango; anteriormente, se generaba un

<constant>E_WARNING</constant> y la función devolvía &null;.

</entry>

</row>

<row>

<entry>8.0.0</entry>

<entry>

<function>array_rand</function> ahora lanza una <classname>ValueError</classname>

si <parameter>array</parameter> está vacío; anteriormente, se generaba un

<constant>E_WARNING</constant> y la función devolvía &null;.

</entry>

</row>

<row>

<entry>7.1.0</entry>

<entry>

El algoritmo

interno de generación aleatoria <link linkend="migration71.incompatible.rand-srand-aliases">ha sido modificado</link> para usar el

generador de números aleatorios <link xlink:href="&url.mersenne;">

Mersenne Twister</link> en lugar de la función aleatoria libc

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Ejemplo con <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

-->