uniqid.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b65b98da1039e01b4a8f51f94560822ec9a113d9 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.uniqid" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>uniqid</refname>
  <refpurpose>Генерирует идентификатор на основе времени</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>
   Функция получает идентификатор на основе текущего времени с точностью до микросекунды.
   Функция добавляет в начало идентификатора префикс <parameter>prefix</parameter>,
   а в конец, если требуется, — случайное значение.
  </para>
  &caution.cryptographically-insecure;
  <warning>
   <para>
    Функция не гарантирует уникальность значения, поскольку основывает значение
    на текущем времени в микросекундах или на текущем времени с добавлением
    небольшого количества случайных данных, которые функция добавляет в конец
    идентификатора, когда для параметра <parameter>more_entropy</parameter>
    установили значение &true;.
   </para>
  </warning>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>prefix</parameter></term>
     <listitem>
      <para>
       Параметр полезен, когда функция генерирует идентификаторы на серии хостов,
       и появляется риск генерации одинаковых идентификаторов в одну и ту же микросекунду.
       Иногда одинаковые идентификаторы генерируются даже на одном хосте, если системные часы,
       например, отстают после настройки времени через NTP-сервер.
      </para>
      <para>
       С пустым параметром <parameter>prefix</parameter> функция вернёт строку
       длиной 13 символов. Длина строки будет составлять 23 символа,
       если параметр <parameter>more_entropy</parameter>
       равен &true;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>more_entropy</parameter></term>
     <listitem>
      <para>
       Функция <function>uniqid</function> добавит через комбинированный линейный
       конгруэнтный генератор дополнительную энтропию в конец значения возврата,
       что увеличивает вероятность уникальности результата, если значение параметра равно &true;.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает в виде строки уникальный идентификатор на основе метки времени.
  </para>
  <warning>
   <para>
    Функция не гарантирует уникальность значения, которое она возвращает.
   </para>
  </warning>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования функции <function>uniqid</function></title>
    <programlisting role="php">
<![CDATA[
<?php

/* Уникальный ID, например: 4b3403665fea6 */
printf("uniqid(): %s\r\n", uniqid());

/* Префикс к уникальному ID добавляют следующими
 * способами:
 *
 * $uniqid = $prefix . uniqid();
 * $uniqid = uniqid($prefix);
 */
printf("uniqid('php_'): %s\r\n", uniqid('php_'));

/* Можно также активировать параметр more_entropy, который требуется в ряде систем наподобие Cygwin,
 * чтобы увеличить энтропию. Тогда
 * функция uniqid() создаст значение наподобие: 4b340550242239.64159797
 */
printf("uniqid('', true): %s\r\n", uniqid('', true));

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    В среде Cygwin параметру <parameter>more_entropy</parameter> для работы этой функции
    требуется установить значение &true;.
   </para>
  </note>

 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>random_bytes</function></member>
  </simplelist>
 </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
-->