mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 11:28:55 +00:00
5ab1ebc578
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338662 c90b9560-bf6c-de11-be94-00142212c4b1
142 lines
3.8 KiB
XML
142 lines
3.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.rand" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>rand</refname>
|
|
<refpurpose>Generate a random integer</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>rand</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>rand</methodname>
|
|
<methodparam><type>int</type><parameter>min</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>max</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<simpara>
|
|
If called without the optional <parameter>min</parameter>,
|
|
<parameter>max</parameter> arguments <function>rand</function>
|
|
returns a pseudo-random integer between 0 and
|
|
<function>getrandmax</function>. If you want a random number
|
|
between 5 and 15 (inclusive), for example, use <literal>rand(5,
|
|
15)</literal>.
|
|
</simpara>
|
|
&caution.cryptographically-insecure;
|
|
<note>
|
|
<simpara>
|
|
On some platforms (such as Windows), <function>getrandmax</function>
|
|
is only 32767. If you require a range larger than 32767, specifying
|
|
<parameter>min</parameter> and <parameter>max</parameter> will allow
|
|
you to create a range larger than this, or consider using
|
|
<function>mt_rand</function> instead.
|
|
</simpara>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>min</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The lowest value to return (default: 0)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>max</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The highest value to return (default: <function>getrandmax</function>)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
A pseudo random value between <parameter>min</parameter>
|
|
(or 0) and <parameter>max</parameter> (or <function>getrandmax</function>, inclusive).
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>rand</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
echo rand() . "\n";
|
|
echo rand() . "\n";
|
|
|
|
echo rand(5, 15);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
7771
|
|
22264
|
|
11
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<warning>
|
|
<para>
|
|
<parameter>min</parameter> <parameter>max</parameter> range must
|
|
be within the range <function>getrandmax</function>. i.e. (<parameter>max</parameter> -
|
|
<parameter>min</parameter>) <= <function>getrandmax</function>
|
|
Otherwise, <function>rand</function> may return poor random numbers
|
|
than it should be.
|
|
</para>
|
|
</warning>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>srand</function></member>
|
|
<member><function>getrandmax</function></member>
|
|
<member><function>mt_rand</function></member>
|
|
<member><function>random_int</function></member>
|
|
<member><function>random_bytes</function></member>
|
|
<member><function>openssl_random_pseudo_bytes</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
|
|
-->
|