-
Notifications
You must be signed in to change notification settings - Fork 73
/
uniqid.xml
152 lines (140 loc) · 5.9 KB
/
uniqid.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<?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
-->