Uuid
in package
implements
UuidInterface
Uses
DeprecatedUuidMethodsTrait
Uuid provides constants and static methods for working with and generating UUIDs
Tags
Interfaces, Classes, Traits and Enums
- UuidInterface
- A UUID is a universally unique identifier adhering to an agreed-upon representation format and standard for generation
Table of Contents
- DCE_DOMAIN_GROUP = 1
- DCE Security group domain
- DCE_DOMAIN_NAMES = [self::DCE_DOMAIN_PERSON => 'person', self::DCE_DOMAIN_GROUP => 'group', self::DCE_DOMAIN_ORG => 'org']
- DCE Security domain string names
- DCE_DOMAIN_ORG = 2
- DCE Security organization domain
- DCE_DOMAIN_PERSON = 0
- DCE Security principal domain
- NAMESPACE_DNS = '6ba7b810-9dad-11d1-80b4-00c04fd430c8'
- When this namespace is specified, the name string is a fully-qualified domain name
- NAMESPACE_OID = '6ba7b812-9dad-11d1-80b4-00c04fd430c8'
- When this namespace is specified, the name string is an ISO OID
- NAMESPACE_URL = '6ba7b811-9dad-11d1-80b4-00c04fd430c8'
- When this namespace is specified, the name string is a URL
- NAMESPACE_X500 = '6ba7b814-9dad-11d1-80b4-00c04fd430c8'
- When this namespace is specified, the name string is an X.500 DN in DER or a text output format
- NIL = '00000000-0000-0000-0000-000000000000'
- The nil UUID is a special form of UUID that is specified to have all 128 bits set to zero
- RESERVED_FUTURE = 7
- Variant: reserved for future definition
- RESERVED_MICROSOFT = 6
- Variant: reserved, Microsoft Corporation backward compatibility
- RESERVED_NCS = 0
- Variant: reserved, NCS backward compatibility
- RFC_4122 = 2
- Variant: the UUID layout specified in RFC 4122
- UUID_TYPE_DCE_SECURITY = 2
- Version 2 (DCE Security) UUID
- UUID_TYPE_HASH_MD5 = 3
- Version 3 (name-based and hashed with MD5) UUID
- UUID_TYPE_HASH_SHA1 = 5
- Version 5 (name-based and hashed with SHA1) UUID
- UUID_TYPE_IDENTIFIER = 2
- UUID_TYPE_PEABODY = 6
- Version 6 (ordered-time) UUID
- UUID_TYPE_RANDOM = 4
- Version 4 (random) UUID
- UUID_TYPE_TIME = 1
- Version 1 (time-based) UUID
- VALID_PATTERN = '^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$'
- $codec : CodecInterface
- $fields : FieldsInterface
- The fields that make up this UUID
- $numberConverter : NumberConverterInterface
- $timeConverter : TimeConverterInterface
- $factory : UuidFactoryInterface|null
- __construct() : mixed
- Creates a universally unique identifier (UUID) from an array of fields
- __toString() : string
- Casts the UUID to the string standard representation
- compareTo() : int
- Returns -1, 0, or 1 if the UUID is less than, equal to, or greater than the other UUID
- equals() : bool
- Returns true if the UUID is equal to the provided object
- fromBytes() : UuidInterface
- Creates a UUID from a byte string
- fromDateTime() : UuidInterface
- Creates a UUID from a DateTimeInterface instance
- fromInteger() : UuidInterface
- Creates a UUID from a 128-bit integer string
- fromString() : UuidInterface
- Creates a UUID from the string standard representation
- getBytes() : string
- Returns the binary string representation of the UUID
- getClockSeqHiAndReserved() : string
- getClockSeqHiAndReservedHex() : string
- getClockSeqLow() : string
- getClockSeqLowHex() : string
- getClockSequence() : string
- getClockSequenceHex() : string
- getDateTime() : DateTimeImmutable
- getFactory() : UuidFactoryInterface
- Returns the factory used to create UUIDs
- getFields() : FieldsInterface
- Returns the fields that comprise this UUID
- getFieldsHex() : array<string|int, string>
- getHex() : Hexadecimal
- Returns the hexadecimal representation of the UUID
- getInteger() : Integer
- Returns the integer representation of the UUID
- getLeastSignificantBits() : string
- getLeastSignificantBitsHex() : string
- getMostSignificantBits() : string
- getMostSignificantBitsHex() : string
- getNode() : string
- getNodeHex() : string
- getNumberConverter() : NumberConverterInterface
- getTimeHiAndVersion() : string
- getTimeHiAndVersionHex() : string
- getTimeLow() : string
- getTimeLowHex() : string
- getTimeMid() : string
- getTimeMidHex() : string
- getTimestamp() : string
- getTimestampHex() : string
- getUrn() : string
- getVariant() : int|null
- getVersion() : int|null
- isValid() : bool
- Returns true if the provided string is a valid UUID
- jsonSerialize() : string
- Converts the UUID to a string for JSON serialization
- serialize() : string
- Converts the UUID to a string for PHP serialization
- setFactory() : void
- Sets the factory used to create UUIDs
- toString() : string
- Returns the string standard representation of the UUID
- unserialize() : void
- Re-constructs the object from its serialized form
- uuid1() : UuidInterface
- Returns a version 1 (time-based) UUID from a host ID, sequence number, and the current time
- uuid2() : UuidInterface
- Returns a version 2 (DCE Security) UUID from a local domain, local identifier, host ID, clock sequence, and the current time
- uuid3() : UuidInterface
- Returns a version 3 (name-based) UUID based on the MD5 hash of a namespace ID and a name
- uuid4() : UuidInterface
- Returns a version 4 (random) UUID
- uuid5() : UuidInterface
- Returns a version 5 (name-based) UUID based on the SHA-1 hash of a namespace ID and a name
- uuid6() : UuidInterface
- Returns a version 6 (ordered-time) UUID from a host ID, sequence number, and the current time
Constants
DCE_DOMAIN_GROUP
DCE Security group domain
public
mixed
DCE_DOMAIN_GROUP
= 1
Tags
DCE_DOMAIN_NAMES
DCE Security domain string names
public
mixed
DCE_DOMAIN_NAMES
= [self::DCE_DOMAIN_PERSON => 'person', self::DCE_DOMAIN_GROUP => 'group', self::DCE_DOMAIN_ORG => 'org']
Tags
DCE_DOMAIN_ORG
DCE Security organization domain
public
mixed
DCE_DOMAIN_ORG
= 2
Tags
DCE_DOMAIN_PERSON
DCE Security principal domain
public
mixed
DCE_DOMAIN_PERSON
= 0
Tags
NAMESPACE_DNS
When this namespace is specified, the name string is a fully-qualified domain name
public
mixed
NAMESPACE_DNS
= '6ba7b810-9dad-11d1-80b4-00c04fd430c8'
Tags
NAMESPACE_OID
When this namespace is specified, the name string is an ISO OID
public
mixed
NAMESPACE_OID
= '6ba7b812-9dad-11d1-80b4-00c04fd430c8'
Tags
NAMESPACE_URL
When this namespace is specified, the name string is a URL
public
mixed
NAMESPACE_URL
= '6ba7b811-9dad-11d1-80b4-00c04fd430c8'
Tags
NAMESPACE_X500
When this namespace is specified, the name string is an X.500 DN in DER or a text output format
public
mixed
NAMESPACE_X500
= '6ba7b814-9dad-11d1-80b4-00c04fd430c8'
Tags
NIL
The nil UUID is a special form of UUID that is specified to have all 128 bits set to zero
public
mixed
NIL
= '00000000-0000-0000-0000-000000000000'
Tags
RESERVED_FUTURE
Variant: reserved for future definition
public
mixed
RESERVED_FUTURE
= 7
Tags
RESERVED_MICROSOFT
Variant: reserved, Microsoft Corporation backward compatibility
public
mixed
RESERVED_MICROSOFT
= 6
Tags
RESERVED_NCS
Variant: reserved, NCS backward compatibility
public
mixed
RESERVED_NCS
= 0
Tags
RFC_4122
Variant: the UUID layout specified in RFC 4122
public
mixed
RFC_4122
= 2
Tags
UUID_TYPE_DCE_SECURITY
Version 2 (DCE Security) UUID
public
mixed
UUID_TYPE_DCE_SECURITY
= 2
Tags
UUID_TYPE_HASH_MD5
Version 3 (name-based and hashed with MD5) UUID
public
mixed
UUID_TYPE_HASH_MD5
= 3
Tags
UUID_TYPE_HASH_SHA1
Version 5 (name-based and hashed with SHA1) UUID
public
mixed
UUID_TYPE_HASH_SHA1
= 5
Tags
UUID_TYPE_IDENTIFIER
public
mixed
UUID_TYPE_IDENTIFIER
= 2
Tags
UUID_TYPE_PEABODY
Version 6 (ordered-time) UUID
public
mixed
UUID_TYPE_PEABODY
= 6
This is named UUID_TYPE_PEABODY
, since the specification is still in
draft form, and the primary author/editor's name is Brad Peabody.
Tags
UUID_TYPE_RANDOM
Version 4 (random) UUID
public
mixed
UUID_TYPE_RANDOM
= 4
Tags
UUID_TYPE_TIME
Version 1 (time-based) UUID
public
mixed
UUID_TYPE_TIME
= 1
Tags
VALID_PATTERN
public
mixed
VALID_PATTERN
= '^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$'
Tags
Properties
$codec
protected
CodecInterface
$codec
$fields
The fields that make up this UUID
protected
FieldsInterface
$fields
$numberConverter
protected
NumberConverterInterface
$numberConverter
$timeConverter
protected
TimeConverterInterface
$timeConverter
$factory
private
static UuidFactoryInterface|null
$factory
= null
Methods
__construct()
Creates a universally unique identifier (UUID) from an array of fields
public
__construct(FieldsInterface $fields, NumberConverterInterface $numberConverter, CodecInterface $codec, TimeConverterInterface $timeConverter) : mixed
Unless you're making advanced use of this library to generate identifiers that deviate from RFC 4122, you probably do not want to instantiate a UUID directly. Use the static methods, instead:
use Ramsey\Uuid\Uuid;
$timeBasedUuid = Uuid::uuid1();
$namespaceMd5Uuid = Uuid::uuid3(Uuid::NAMESPACE_URL, 'http://php.net/');
$randomUuid = Uuid::uuid4();
$namespaceSha1Uuid = Uuid::uuid5(Uuid::NAMESPACE_URL, 'http://php.net/');
Parameters
- $fields : FieldsInterface
-
The fields from which to construct a UUID
- $numberConverter : NumberConverterInterface
-
The number converter to use for converting hex values to/from integers
- $codec : CodecInterface
-
The codec to use when encoding or decoding UUID strings
- $timeConverter : TimeConverterInterface
-
The time converter to use for converting timestamps extracted from a UUID to unix timestamps
Return values
mixed —__toString()
Casts the UUID to the string standard representation
public
__toString() : string
Tags
Return values
string —compareTo()
Returns -1, 0, or 1 if the UUID is less than, equal to, or greater than the other UUID
public
compareTo(UuidInterface $other) : int
The first of two UUIDs is greater than the second if the most significant field in which the UUIDs differ is greater for the first UUID.
- Q. What's the value of being able to sort UUIDs?
- A. Use them as keys in a B-Tree or similar mapping.
Parameters
- $other : UuidInterface
-
The UUID to compare
Return values
int —-1, 0, or 1 if the UUID is less than, equal to, or greater than $other
equals()
Returns true if the UUID is equal to the provided object
public
equals(object|null $other) : bool
The result is true if and only if the argument is not null, is a UUID object, has the same variant, and contains the same value, bit for bit, as the UUID.
Parameters
- $other : object|null
-
An object to test for equality with this UUID
Return values
bool —True if the other object is equal to this UUID
fromBytes()
Creates a UUID from a byte string
public
static fromBytes(string $bytes) : UuidInterface
Parameters
- $bytes : string
-
A binary string
Tags
Return values
UuidInterface —A UuidInterface instance created from a binary string representation
fromDateTime()
Creates a UUID from a DateTimeInterface instance
public
static fromDateTime(DateTimeInterface $dateTime[, Hexadecimal|null $node = null ][, int|null $clockSeq = null ]) : UuidInterface
Parameters
- $dateTime : DateTimeInterface
-
The date and time
- $node : Hexadecimal|null = null
-
A 48-bit number representing the hardware address
- $clockSeq : int|null = null
-
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
Return values
UuidInterface —A UuidInterface instance that represents a version 1 UUID created from a DateTimeInterface instance
fromInteger()
Creates a UUID from a 128-bit integer string
public
static fromInteger(string $integer) : UuidInterface
Parameters
- $integer : string
-
String representation of 128-bit integer
Tags
Return values
UuidInterface —A UuidInterface instance created from the string representation of a 128-bit integer
fromString()
Creates a UUID from the string standard representation
public
static fromString(string $uuid) : UuidInterface
Parameters
- $uuid : string
-
A hexadecimal string
Tags
Return values
UuidInterface —A UuidInterface instance created from a hexadecimal string representation
getBytes()
Returns the binary string representation of the UUID
public
getBytes() : string
Tags
Return values
string —getClockSeqHiAndReserved()
public
getClockSeqHiAndReserved() : string
Tags
Return values
string —getClockSeqHiAndReservedHex()
public
getClockSeqHiAndReservedHex() : string
Tags
Return values
string —getClockSeqLow()
public
getClockSeqLow() : string
Tags
Return values
string —getClockSeqLowHex()
public
getClockSeqLowHex() : string
Tags
Return values
string —getClockSequence()
public
getClockSequence() : string
Tags
Return values
string —getClockSequenceHex()
public
getClockSequenceHex() : string
Tags
Return values
string —getDateTime()
public
getDateTime() : DateTimeImmutable
Tags
Return values
DateTimeImmutable —An immutable instance of DateTimeInterface
getFactory()
Returns the factory used to create UUIDs
public
static getFactory() : UuidFactoryInterface
Return values
UuidFactoryInterface —getFields()
Returns the fields that comprise this UUID
public
getFields() : FieldsInterface
Return values
FieldsInterface —getFieldsHex()
public
getFieldsHex() : array<string|int, string>
Tags
Return values
array<string|int, string> —getHex()
Returns the hexadecimal representation of the UUID
public
getHex() : Hexadecimal
Return values
Hexadecimal —getInteger()
Returns the integer representation of the UUID
public
getInteger() : Integer
Return values
Integer —getLeastSignificantBits()
public
getLeastSignificantBits() : string
Tags
Return values
string —getLeastSignificantBitsHex()
public
getLeastSignificantBitsHex() : string
Tags
Return values
string —getMostSignificantBits()
public
getMostSignificantBits() : string
Tags
Return values
string —getMostSignificantBitsHex()
public
getMostSignificantBitsHex() : string
Tags
Return values
string —getNode()
public
getNode() : string
Tags
Return values
string —getNodeHex()
public
getNodeHex() : string
Tags
Return values
string —getNumberConverter()
public
getNumberConverter() : NumberConverterInterface
Tags
Return values
NumberConverterInterface —getTimeHiAndVersion()
public
getTimeHiAndVersion() : string
Tags
Return values
string —getTimeHiAndVersionHex()
public
getTimeHiAndVersionHex() : string
Tags
Return values
string —getTimeLow()
public
getTimeLow() : string
Tags
Return values
string —getTimeLowHex()
public
getTimeLowHex() : string
Tags
Return values
string —getTimeMid()
public
getTimeMid() : string
Tags
Return values
string —getTimeMidHex()
public
getTimeMidHex() : string
Tags
Return values
string —getTimestamp()
public
getTimestamp() : string
Tags
Return values
string —getTimestampHex()
public
getTimestampHex() : string
Tags
Return values
string —getUrn()
public
getUrn() : string
Tags
Return values
string —getVariant()
public
getVariant() : int|null
Tags
Return values
int|null —getVersion()
public
getVersion() : int|null
Tags
Return values
int|null —isValid()
Returns true if the provided string is a valid UUID
public
static isValid(string $uuid) : bool
Parameters
- $uuid : string
-
A string to validate as a UUID
Tags
Return values
bool —True if the string is a valid UUID, false otherwise
jsonSerialize()
Converts the UUID to a string for JSON serialization
public
jsonSerialize() : string
Return values
string —serialize()
Converts the UUID to a string for PHP serialization
public
serialize() : string
Return values
string —setFactory()
Sets the factory used to create UUIDs
public
static setFactory(UuidFactoryInterface $factory) : void
Parameters
- $factory : UuidFactoryInterface
-
A factory that will be used by this class to create UUIDs
Return values
void —toString()
Returns the string standard representation of the UUID
public
toString() : string
Tags
Return values
string —unserialize()
Re-constructs the object from its serialized form
public
unserialize(string $serialized) : void
Parameters
- $serialized : string
-
The serialized PHP string to unserialize into a UuidInterface instance
Tags
Return values
void —uuid1()
Returns a version 1 (time-based) UUID from a host ID, sequence number, and the current time
public
static uuid1([Hexadecimal|int|string|null $node = null ][, int $clockSeq = null ]) : UuidInterface
Parameters
- $node : Hexadecimal|int|string|null = null
-
A 48-bit number representing the hardware address; this number may be represented as an integer or a hexadecimal string
- $clockSeq : int = null
-
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
Return values
UuidInterface —A UuidInterface instance that represents a version 1 UUID
uuid2()
Returns a version 2 (DCE Security) UUID from a local domain, local identifier, host ID, clock sequence, and the current time
public
static uuid2(int $localDomain[, Integer|null $localIdentifier = null ][, Hexadecimal|null $node = null ][, int|null $clockSeq = null ]) : UuidInterface
Parameters
- $localDomain : int
-
The local domain to use when generating bytes, according to DCE Security
- $localIdentifier : Integer|null = null
-
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
- $node : Hexadecimal|null = null
-
A 48-bit number representing the hardware address
- $clockSeq : int|null = null
-
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 (in a version 2 UUID, the lower 8 bits of this number are replaced with the domain).
Return values
UuidInterface —A UuidInterface instance that represents a version 2 UUID
uuid3()
Returns a version 3 (name-based) UUID based on the MD5 hash of a namespace ID and a name
public
static uuid3(string|UuidInterface $ns, string $name) : UuidInterface
Parameters
- $ns : string|UuidInterface
-
The namespace (must be a valid UUID)
- $name : string
-
The name to use for creating a UUID
Tags
Return values
UuidInterface —A UuidInterface instance that represents a version 3 UUID
uuid4()
Returns a version 4 (random) UUID
public
static uuid4() : UuidInterface
Return values
UuidInterface —A UuidInterface instance that represents a version 4 UUID
uuid5()
Returns a version 5 (name-based) UUID based on the SHA-1 hash of a namespace ID and a name
public
static uuid5(string|UuidInterface $ns, string $name) : UuidInterface
Parameters
- $ns : string|UuidInterface
-
The namespace (must be a valid UUID)
- $name : string
-
The name to use for creating a UUID
Tags
Return values
UuidInterface —A UuidInterface instance that represents a version 5 UUID
uuid6()
Returns a version 6 (ordered-time) UUID from a host ID, sequence number, and the current time
public
static uuid6([Hexadecimal|null $node = null ][, int $clockSeq = null ]) : UuidInterface
Parameters
- $node : Hexadecimal|null = null
-
A 48-bit number representing the hardware address
- $clockSeq : int = null
-
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
Return values
UuidInterface —A UuidInterface instance that represents a version 6 UUID