TimestampFirstCombCodec

TimestampFirstCombCodec encodes and decodes COMBs, with the timestamp as the first 48 bits

In contrast with the TimestampLastCombCodec, the TimestampFirstCombCodec adds the timestamp to the first 48 bits of the COMB. To generate a timestamp-first COMB, set the TimestampFirstCombCodec as the codec, along with the CombGenerator as the random generator.

$factory = new UuidFactory();

$factory->setCodec(new TimestampFirstCombCodec($factory->getUuidBuilder()));

$factory->setRandomGenerator(new CombGenerator(
    $factory->getRandomGenerator(),
    $factory->getNumberConverter()
));

$timestampFirstComb = $factory->uuid4();

• Full name: \Ramsey\Uuid\Codec\TimestampFirstCombCodec
• Parent class: \Ramsey\Uuid\Codec\StringCodec

See Also:

• https://www.informit.com/articles/printerfriendly/25862 - The Cost of GUIDs as Primary Keys

Methods

encode

Returns a hexadecimal string representation of a UuidInterface

public encode(\Ramsey\Uuid\UuidInterface $uuid): string

Parameters:

Parameter	Type	Description
$uuid	\Ramsey\Uuid\UuidInterface	The UUID for which to create a hexadecimal string representation

Return Value:

Hexadecimal string representation of a UUID

---

encodeBinary

Returns a binary string representation of a UuidInterface

public encodeBinary(\Ramsey\Uuid\UuidInterface $uuid): string

Parameters:

Parameter	Type	Description
$uuid	\Ramsey\Uuid\UuidInterface	The UUID for which to create a binary string representation

Return Value:

Binary string representation of a UUID

---

decode

Returns a UuidInterface derived from a hexadecimal string representation

public decode(string $encodedUuid): \Ramsey\Uuid\UuidInterface

Parameters:

Parameter	Type	Description
$encodedUuid	string	The hexadecimal string representation to convert into a UuidInterface instance

Return Value:

An instance of a UUID decoded from a hexadecimal string representation

Throws:

• InvalidUuidStringException

---

decodeBytes

Returns a UuidInterface derived from a binary string representation

public decodeBytes(string $bytes): \Ramsey\Uuid\UuidInterface

Parameters:

Parameter	Type	Description
$bytes	string	The binary string representation to convert into a UuidInterface instance

Return Value:

An instance of a UUID decoded from a binary string representation

---

swapBytes

Swaps bytes according to the timestamp-first COMB rules

private swapBytes(string $bytes): string

Parameters:

Parameter	Type	Description
$bytes	string

---

Inherited methods

__construct

Constructs a StringCodec

public __construct(\Ramsey\Uuid\Builder\UuidBuilderInterface $builder): mixed

Parameters:

Parameter	Type	Description
$builder	\Ramsey\Uuid\Builder\UuidBuilderInterface	The builder to use when encoding UUIDs

---

encode

Returns a hexadecimal string representation of a UuidInterface

public encode(\Ramsey\Uuid\UuidInterface $uuid): string

Parameters:

Parameter	Type	Description
$uuid	\Ramsey\Uuid\UuidInterface	The UUID for which to create a hexadecimal string representation

Return Value:

Hexadecimal string representation of a UUID

---

encodeBinary

Returns a binary string representation of a UuidInterface

public encodeBinary(\Ramsey\Uuid\UuidInterface $uuid): string

Parameters:

Parameter	Type	Description
$uuid	\Ramsey\Uuid\UuidInterface	The UUID for which to create a binary string representation

Return Value:

Binary string representation of a UUID

---

decode

Returns a UuidInterface derived from a hexadecimal string representation

public decode(string $encodedUuid): \Ramsey\Uuid\UuidInterface

Parameters:

Parameter	Type	Description
$encodedUuid	string	The hexadecimal string representation to convert into a UuidInterface instance

Return Value:

An instance of a UUID decoded from a hexadecimal string representation

Throws:

• InvalidUuidStringException

---

decodeBytes

Returns a UuidInterface derived from a binary string representation

public decodeBytes(string $bytes): \Ramsey\Uuid\UuidInterface

Parameters:

Parameter	Type	Description
$bytes	string	The binary string representation to convert into a UuidInterface instance

Return Value:

An instance of a UUID decoded from a binary string representation

---

getBuilder

Returns the UUID builder

protected getBuilder(): \Ramsey\Uuid\Builder\UuidBuilderInterface

---

getBytes

Returns a byte string of the UUID

protected getBytes(string $encodedUuid): string

Parameters:

Parameter	Type	Description
$encodedUuid	string

---

---

Automatically generated on 2025-03-18