StringCodec

StringCodec encodes and decodes RFC 4122 UUIDs

• Full name: \Ramsey\Uuid\Codec\StringCodec
• This class implements: \Ramsey\Uuid\Codec\CodecInterface

See Also:

• http://tools.ietf.org/html/rfc4122 -

Properties

builder

private \Ramsey\Uuid\Builder\UuidBuilderInterface $builder

---

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