uniqid.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b65b98da1039e01b4a8f51f94560822ec9a113d9 Maintainer: sammywg Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: b65b98da1039e01b4a8f51f94560822ec9a113d9 Reviewer: samesch -->
<refentry xml:id="function.uniqid" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>uniqid</refname>
  <refpurpose>Erzeugt eine zeitsbasierte ID</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>
   Gibt eine ID zurück, die auf der aktuellen Zeit mit einer Genauigkeit von
   einer Mikrosekunde basiert. Als Präfix wird der angegebene
   <parameter>prefix</parameter> verwendet und optional wird ein zufällig
   generierter Wert angehängt.
  </para>
  &caution.cryptographically-insecure;
  <warning>
    <para>
     Diese Funktion garantiert nicht die Eindeutigkeit des Rückgabewerts,
     weil dieser auf der aktuellen Zeit in Mikrosekunden basiert oder, wenn
     <parameter>more_entropy</parameter> &true; ist, auf der aktuellen Zeit
     mit einer kleinen Menge an Zufallsdaten.
    </para>
  </warning>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>prefix</parameter></term>
     <listitem>
      <para>
       Dieser Parameter ist &zb; nützlich, wenn IDs auf mehreren Hosts erzeugt
       werden und die Gefahr besteht, dass sie in derselben Mikrosekunde
       dieselbe Kennung erzeugen. Dies kann sogar auf einem einzelnen Host
       passieren, wenn die Systemuhr &zb; durch NTP angepasst und dadurch
       zurückgestellt wird.
      </para>
      <para>
       Bei leerem <parameter>prefix</parameter> ist die zurückgegebene
       Zeichenkette 13 Zeichen lang. Falls <parameter>more_entropy</parameter>
       &true; ist, sind es 23 Zeichen.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>more_entropy</parameter></term>
     <listitem>
      <para>
       Falls dieser Parameter auf &true; gesetzt ist, fügt
       <function>uniqid</function> am Ende des Rückgabewertes zusätzliche mit
       dem Kongruenzgenerator für Pseudozufallszahlen (Combined Linear
       Congruential Generator) erzeugte Entropie an, wodurch die
       Wahrscheinlichkeit erhöht wird, dass das Ergebnis eindeutig ist.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt eine zeitstempelbasierte ID als Zeichenkette zurück.
  </para>
  <warning>
   <para>
    Diese Funktion garantiert nicht die Eindeutigkeit des Rückgabewerts.
   </para>
  </warning>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>uniqid</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
/* Eine eindeutige ID, beispielsweise: 4b3403665fea6 */
printf("uniqid(): %s\r\n", uniqid());

/* Zusätzlich kann ein Präfix genutzt werden. Dabei sind die
 * folgenden beiden Anweisungen identisch:
 *
 * $uniqid = $prefix . uniqid();
 * $uniqid = uniqid($prefix);
 */
printf("uniqid('php_'): %s\r\n", uniqid('php_'));

/* Weiterhin kann der Parameter more_entropy aktiviert werden (auf einigen
 * Systemen wie Cygwin ist dies sogar erforderlich). Dadurch generiert
 * uniqid() einen Wert ähnlich dem folgenden: 4b340550242239.64159797
 */
printf("uniqid('', true): %s\r\n", uniqid('', true));
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Unter Cygwin muss der Parameter <parameter>more_entropy</parameter> auf
    &true; gesetzt sein, damit die Funktion funktioniert.
   </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
-->