mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
5e19181d4f
added note about the prefix parameter, spoted by user note git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@172175 c90b9560-bf6c-de11-be94-00142212c4b1
87 lines
2.8 KiB
XML
87 lines
2.8 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.8 $ -->
|
|
<!-- splitted from ./en/functions/misc.xml, last change in rev 1.2 -->
|
|
<refentry id="function.uniqid">
|
|
<refnamediv>
|
|
<refname>uniqid</refname>
|
|
<refpurpose>Generate a unique ID</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>uniqid</methodname>
|
|
<methodparam choice="opt"><type>string</type><parameter>prefix</parameter></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>more_entropy</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<simpara>
|
|
<function>uniqid</function> returns a prefixed unique identifier
|
|
based on the current time in microseconds. <parameter>prefix</parameter>
|
|
is optional but can be useful, for instance, if you generate identifiers
|
|
simultaneously on several hosts that might happen to generate the
|
|
identifier at the same microsecond. Up until PHP 4.3.1,
|
|
<parameter>prefix</parameter> could only be a maximum of 114
|
|
characters long.
|
|
</simpara>
|
|
<simpara>
|
|
If the optional <parameter>more_entropy</parameter> parameter is
|
|
&true;, <function>uniqid</function> will add additional entropy (using
|
|
the combined linear congruential generator) at the end of the return
|
|
value, which should make the results more unique.
|
|
</simpara>
|
|
<simpara>
|
|
With an empty <parameter>prefix</parameter>, the returned string
|
|
will be 13 characters long. If <parameter>more_entropy</parameter> is
|
|
&true;, it will be 23 characters.
|
|
</simpara>
|
|
<note>
|
|
<simpara>
|
|
The <parameter>prefix</parameter> parameter became optional in PHP 5.
|
|
</simpara>
|
|
</note>
|
|
<para>
|
|
If you need a unique identifier or token and you intend to give
|
|
out that token to the user via the network (i.e. session cookies),
|
|
it is recommended that you use something along these lines:
|
|
</para>
|
|
<para>
|
|
<informalexample>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// no prefix
|
|
$token = md5(uniqid());
|
|
|
|
// better, difficult to guess
|
|
$better_token = md5(uniqid(rand(), true));
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</informalexample>
|
|
</para>
|
|
<simpara>
|
|
This will create a 32 character identifier (a 128 bit hex number)
|
|
that is extremely difficult to predict.
|
|
</simpara>
|
|
</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
|
|
-->
|