PHP マニュアル: 時刻ベースの識別子を生成する

説明

string uniqid(string $prefix = "", bool $more_entropy = false)

マイクロ秒単位の現在時刻にもとづいた、識別子を取得します。 prefix が指定された場合は接頭辞が付きますし、オプションでランダムに生成された値を付加します。

警告

この関数が生成する値は、暗号学的にセキュアではありません。そのため、これを暗号や、戻り値を推測できないことが必須の値として使っては いけません。

暗号学的にセキュアな乱数が必要な場合は、Random\Randomizer を Random\Engine\Secure と一緒に使いましょう。簡単なユースケースの場合、random_int と random_bytes 関数が、オペレーティングシステムの CSPRNG を使った、便利で安全な API を提供します。

警告

この関数は、戻り値の一意性を保証するものではありません。なぜなら、値がマイクロ秒単位の現在時刻をベースとしていますし、 more_entropy を true にしたとしても、わずかな量のランダムデータが付加されるだけだからです。

パラメータ

prefix

これが有用なのは、たとえば複数ホストで同じマイクロ秒で同時に ID を生成するような場合です。(このような場合は、同一ホストでも NTP によってシステム時刻が巻き戻された場合にも起こりえます)

空の prefix を指定すると、返される文字列は 13 文字となります。 more_entropy が true の場合は 23 文字となります。

more_entropy

true にすると、uniqid は戻り値の最後にさらに別のエントロピーを (線形合同法を使用して) 追加します。これにより、結果が一意になる可能性を高めます。

戻り値

タイムスタンプにもとづいた識別子を文字列で返します。

警告

この関数は戻り値の一意性を完全に保証するものではありません。

例

例1 uniqid の例

<?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));
?>

注意

注意:
Cygwin でこの関数を動作させるには、 more_entropy を true にする必要があります。

参考

random_bytes