archived-doc-pt-br/reference/array/functions/array-rand.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 4a1dedc24b1e085f298ab1d5dadefe306373691b Maintainer: ae Status: ready --><!-- CREDITS: narigone,lucasr,felipe,ae,marquesdanielb,leonardolara -->
<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>Escolhe uma ou mais chaves aleatórias de um 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>
   Escolhe aleatóriamente um ou mais itens de um array, e retorna a
   chave (ou chaves) do itens selecionados.
  </para>
  &caution.cryptographically-insecure;
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       O array de entrada.
       Não pode ser vazio.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>num</parameter></term>
     <listitem>
      <para>
       Especifica quantos elementos deseja obter.
       Deve ser maior que zero, e menor ou igual ao comprimento do <parameter>array</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Se estiver selecionando apenas um elemento, <function>array_rand</function> retorna
   a chave para este elemento aleatório. De outra forma, ele retorna um array com as chaves desses
   elementos selecionados. Assim é possível selecionar os elementos pelas chaves
   no array assim como valores aleatórios. Se múltiplas chaves forem retornadas,
   elas serão retornadas na ordem em que estavam presentes no array original.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Lança uma exceção <classname>ValueError</classname> se <parameter>array</parameter> estiver vazio,
   ou se <parameter>num</parameter> estiver fora do intervalo permitido.
  </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> agora lança uma exceção <classname>ValueError</classname>
        se <parameter>num</parameter> estiver fora do intervalo; anteriormente um
        <constant>E_WARNING</constant> era emitido, e a função retornava &null;.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        <function>array_rand</function> agora lança uma exceção <classname>ValueError</classname>
        se <parameter>array</parameter> estiver vazio; anteriormente um
        <constant>E_WARNING</constant> era emitido, e a função retornava &null;.
       </entry>
      </row>
      <row>
       <entry>7.1.0</entry>
       <entry>
        O algoritmo de embaralhamento interno <link linkend="migration71.incompatible.rand-srand-aliases">foi alterado</link> para usar o Gerador de Números Aleatórios <link xlink:href="&url.mersenne;">Mersenne Twister</link> em vez da função rand da libc.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemplo de <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
-->