UuidInterface
interface UuidInterface implements JsonSerializable, Serializable (View source)
UuidInterface defines common functionality for all universally unique identifiers (UUIDs)
Methods
Compares this object to the specified object.
Returns the UUID as a 16-byte string (containing the six integer fields in big-endian byte order).
Returns the number converter to use for converting hex values to/from integers.
Returns the hexadecimal value of the UUID.
Returns an array of the fields of this UUID, with keys named according to the RFC 4122 names for the fields.
Returns the high field of the clock sequence multiplexed with the variant (bits 65-72 of the UUID).
Returns the low field of the clock sequence (bits 73-80 of the UUID).
Returns the clock sequence value associated with this UUID.
Returns a PHP DateTime
object representing the timestamp associated
with this UUID.
Returns the integer value of the UUID, converted to an appropriate number representation.
Returns the least significant 64 bits of this UUID's 128 bit value.
Returns the most significant 64 bits of this UUID's 128 bit value.
Returns the node value associated with this UUID
Returns the high field of the timestamp multiplexed with the version number (bits 49-64 of the UUID).
Returns the low field of the timestamp (the first 32 bits of the UUID).
Returns the middle field of the timestamp (bits 33-48 of the UUID).
Returns the timestamp value associated with this UUID.
Returns the string representation of the UUID as a URN.
Returns the variant number associated with this UUID.
Returns the version number associated with this UUID.
Converts this UUID into a string representation.
Details
at line 39
int
compareTo(UuidInterface $other)
Compares this UUID to the specified UUID.
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.
at line 51
bool
equals(object $other)
Compares this object to the specified object.
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 this UUID.
at line 59
string
getBytes()
Returns the UUID as a 16-byte string (containing the six integer fields in big-endian byte order).
at line 66
NumberConverterInterface
getNumberConverter()
Returns the number converter to use for converting hex values to/from integers.
at line 73
string
getHex()
Returns the hexadecimal value of the UUID.
at line 92
array
getFieldsHex()
Returns an array of the fields of this UUID, with keys named according to the RFC 4122 names for the fields.
- time_low: The low field of the timestamp, an unsigned 32-bit integer
- time_mid: The middle field of the timestamp, an unsigned 16-bit integer
- time_hi_and_version: The high field of the timestamp multiplexed with the version number, an unsigned 16-bit integer
- clock_seq_hi_and_reserved: The high field of the clock sequence multiplexed with the variant, an unsigned 8-bit integer
- clock_seq_low: The low field of the clock sequence, an unsigned 8-bit integer
- node: The spatially unique node identifier, an unsigned 48-bit integer
at line 100
string
getClockSeqHiAndReservedHex()
Returns the high field of the clock sequence multiplexed with the variant (bits 65-72 of the UUID).
at line 107
string
getClockSeqLowHex()
Returns the low field of the clock sequence (bits 73-80 of the UUID).
at line 114
string
getClockSequenceHex()
Returns the clock sequence value associated with this UUID.
at line 127
DateTime
getDateTime()
Returns a PHP DateTime
object representing the timestamp associated
with this UUID.
The timestamp value is only meaningful in a time-based UUID, which
has version type 1. If this UUID is not a time-based UUID then
this method throws UnsupportedOperationException
.
at line 135
mixed
getInteger()
Returns the integer value of the UUID, converted to an appropriate number representation.
at line 142
string
getLeastSignificantBitsHex()
Returns the least significant 64 bits of this UUID's 128 bit value.
at line 149
string
getMostSignificantBitsHex()
Returns the most significant 64 bits of this UUID's 128 bit value.
at line 175
string
getNodeHex()
Returns the node value associated with this UUID
For UUID version 1, the node field consists of an IEEE 802 MAC address, usually the host address. For systems with multiple IEEE 802 addresses, any available one can be used. The lowest addressed octet (octet number 10) contains the global/local bit and the unicast/multicast bit, and is the first octet of the address transmitted on an 802.3 LAN.
For systems with no IEEE address, a randomly or pseudo-randomly generated value may be used; see RFC 4122, Section 4.5. The multicast bit must be set in such addresses, in order that they will never conflict with addresses obtained from network cards.
For UUID version 3 or 5, the node field is a 48-bit value constructed from a name as described in RFC 4122, Section 4.3.
For UUID version 4, the node field is a randomly or pseudo-randomly generated 48-bit value as described in RFC 4122, Section 4.4.
at line 183
string
getTimeHiAndVersionHex()
Returns the high field of the timestamp multiplexed with the version number (bits 49-64 of the UUID).
at line 190
string
getTimeLowHex()
Returns the low field of the timestamp (the first 32 bits of the UUID).
at line 197
string
getTimeMidHex()
Returns the middle field of the timestamp (bits 33-48 of the UUID).
at line 215
string
getTimestampHex()
Returns the timestamp value associated with this UUID.
The 60 bit timestamp value is constructed from the time_low, time_mid, and time_hi fields of this UUID. The resulting timestamp is measured in 100-nanosecond units since midnight, October 15, 1582 UTC.
The timestamp value is only meaningful in a time-based UUID, which has version type 1. If this UUID is not a time-based UUID then this method throws UnsupportedOperationException.
at line 223
string
getUrn()
Returns the string representation of the UUID as a URN.
at line 239
int
getVariant()
Returns the variant number associated with this UUID.
The variant number describes the layout of the UUID. The variant number has the following meaning:
- 0 - Reserved for NCS backward compatibility
- 2 - The RFC 4122 variant (used by this class)
- 6 - Reserved, Microsoft Corporation backward compatibility
- 7 - Reserved for future definition
at line 259
int|null
getVersion()
Returns the version number associated with this UUID.
The version number describes how this UUID was generated and has the following meaning:
- 1 - Time-based UUID
- 2 - DCE security UUID
- 3 - Name-based UUID hashed with MD5
- 4 - Randomly generated UUID
- 5 - Name-based UUID hashed with SHA-1
Returns null if this UUID is not an RFC 4122 variant, since version is only meaningful for this variant.
at line 266
string
toString()
Converts this UUID into a string representation.