Files
doc-fr/reference/misc/functions/uniqid.xml
2021-09-24 04:13:47 +01:00

144 lines
4.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b8758b0605e80c4e3610137b7502a6abeea5c69b Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.uniqid" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>uniqid</refname>
<refpurpose>Génère un identifiant unique</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>uniqid</methodname>
<methodparam choice="opt"><type>string</type><parameter>prefix</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>more_entropy</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
Génère un identifiant unique, préfixé, basé sur la date et heure courante en microsecondes.
</para>
&caution.cryptographically-insecure;
<warning>
<para>
Cette fonction ne garantie pas l'unicité des valeurs de retour.
Car la plupart des systèmes ajustent l'horloge système par NTP ou similaire;
l'horloge système est modifiée constament. Par conséquent, il est possible que
cette fonction ne retourne pas un ID unique pour le processus/thread.
Utiliser <parameter>more_entropy</parameter> pour augmenter la probabilité d'unicité.
</para>
</warning>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>prefix</parameter></term>
<listitem>
<para>
Peut être utile, par exemple, pour identifier facilement différents hôtes, si vous générez
simultanément des fichiers depuis plusieurs hôtes,
à la même microseconde.
</para>
<para>
Sans <parameter>prefix</parameter> (préfixe vide), la
chaîne retournée fera 13 caractères. Si
<parameter>more_entropy</parameter> est à &true;, elle fera 23
caractères.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>more_entropy</parameter></term>
<listitem>
<para>
Si le paramètre optionnel <parameter>more_entropy</parameter> est
&true;, <function>uniqid</function> ajoutera une entropie
<literal>"combined LCG"</literal> à la fin de la valeur retournée,
ce qui augmente la probabilité de l'unicité du résultat.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne un identifiant unique basé sur l'horodatage, sous la forme d'une &string;.
</para>
<warning>
<para>
Cette fonction tente de créer un identifiant unique, mais l'unicité
de la valeur de retour n'est pas garantie à 100%.
</para>
</warning>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>uniqid</function></title>
<programlisting role="php">
<![CDATA[
<?php
/* Un identifiant unique, comme : 4b3403665fea6 */
printf("uniqid(): %s\r\n", uniqid());
/* Nous pouvons également préfixer l'identifiant unique,
* ce qui revient à :
*
* $uniqid = $prefix . uniqid();
* $uniqid = uniqid($prefix);
*/
printf("uniqid('php_'): %s\r\n", uniqid('php_'));
/* Nous pouvons aussi activer le paramètre more_entropy,
* requis par quelques systèmes, comme Cygwin. Ceci fera que
* uniqid() produira une valeur comme : 4b340550242239.64159797
*/
printf("uniqid('', true): %s\r\n", uniqid('', true));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
Sous Cygwin, le paramètre <parameter>more_entropy</parameter> doit être
passé à &true; pour que cette fonction fonctionne.
</para>
</note>
</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
-->