mirror of
https://github.com/ramsey/uuid.git
synced 2026-06-14 15:56:48 +03:00
Ben Ramsey
f42afcecbb
Rename `Type\IntegerValue` to `Type\Integer`. It was originally named `IntegerValue` because static analysis sees `Integer` in docblock annotations and treats it as the native `int` type. `Integer` is not a reserved word in PHP, so it should be named `Integer` for consistency with other types in this library. When using it, a class alias prevents static analysis from complaining.
90 lines
2.6 KiB
PHP
90 lines
2.6 KiB
PHP
<?php
|
|
|
|
/**
|
|
* This file is part of the ramsey/uuid library
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*
|
|
* @copyright Copyright (c) Ben Ramsey <ben@benramsey.com>
|
|
* @license http://opensource.org/licenses/MIT MIT
|
|
* phpcs:disable Squiz.Functions.GlobalFunction
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Ramsey\Uuid;
|
|
|
|
use Ramsey\Uuid\Type\Hexadecimal;
|
|
use Ramsey\Uuid\Type\Integer as IntegerObject;
|
|
|
|
/**
|
|
* Returns a version 1 (time-based) UUID from a host ID, sequence number,
|
|
* and the current time
|
|
*
|
|
* @param int|string $node A 48-bit number representing the hardware address;
|
|
* this number may be represented as an integer or a hexadecimal string
|
|
* @param int $clockSeq A 14-bit number used to help avoid duplicates that
|
|
* could arise when the clock is set backwards in time or if the node ID
|
|
* changes
|
|
*/
|
|
function v1($node = null, ?int $clockSeq = null): string
|
|
{
|
|
return Uuid::uuid1($node, $clockSeq)->toString();
|
|
}
|
|
|
|
/**
|
|
* Returns a version 2 (DCE Security) UUID from a local domain, local
|
|
* identifier, host ID, clock sequence, and the current time
|
|
*
|
|
* @param int $localDomain The local domain to use when generating bytes,
|
|
* according to DCE Security
|
|
* @param IntegerObject|null $localIdentifier The local identifier for the
|
|
* given domain; this may be a UID or GID on POSIX systems, if the local
|
|
* domain is person or group, or it may be a site-defined identifier
|
|
* if the local domain is org
|
|
* @param Hexadecimal|null $node A 48-bit number representing the hardware
|
|
* address
|
|
* @param int|null $clockSeq A 14-bit number used to help avoid duplicates
|
|
* that could arise when the clock is set backwards in time or if the
|
|
* node ID changes
|
|
*/
|
|
function v2(
|
|
int $localDomain,
|
|
?IntegerObject $localIdentifier = null,
|
|
?Hexadecimal $node = null,
|
|
?int $clockSeq = null
|
|
): string {
|
|
return Uuid::uuid2($localDomain, $localIdentifier, $node, $clockSeq)->toString();
|
|
}
|
|
|
|
/**
|
|
* Returns a version 3 (name-based) UUID based on the MD5 hash of a
|
|
* namespace ID and a name
|
|
*
|
|
* @param string|UuidInterface $ns The namespace (must be a valid UUID)
|
|
*/
|
|
function v3($ns, string $name): string
|
|
{
|
|
return Uuid::uuid3($ns, $name)->toString();
|
|
}
|
|
|
|
/**
|
|
* Returns a version 4 (random) UUID
|
|
*/
|
|
function v4(): string
|
|
{
|
|
return Uuid::uuid4()->toString();
|
|
}
|
|
|
|
/**
|
|
* Returns a version 5 (name-based) UUID based on the SHA-1 hash of a
|
|
* namespace ID and a name
|
|
*
|
|
* @param string|UuidInterface $ns The namespace (must be a valid UUID)
|
|
*/
|
|
function v5($ns, string $name): string
|
|
{
|
|
return Uuid::uuid5($ns, $name)->toString();
|
|
}
|