UuidFactoryInterface

UuidFactoryInterface defines common functionality all UuidFactory instances must implement

• Full name: \Ramsey\Uuid\UuidFactoryInterface

Methods

fromBytes

Creates a UUID from a byte string

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

Parameters:

Parameter	Type	Description
$bytes	string	A binary string

Return Value:

A UuidInterface instance created from a binary string representation

---

fromDateTime

Creates a UUID from a DateTimeInterface instance

public fromDateTime(\DateTimeInterface $dateTime, \Ramsey\Uuid\Type\Hexadecimal|null $node = null, int|null $clockSeq = null): \Ramsey\Uuid\UuidInterface

Parameters:

Parameter	Type	Description
$dateTime	\DateTimeInterface	The date and time
$node	\Ramsey\Uuid\Type\Hexadecimal|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 Value:

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 fromInteger(string $integer): \Ramsey\Uuid\UuidInterface

Parameters:

Parameter	Type	Description
$integer	string	String representation of 128-bit integer

Return Value:

A UuidInterface instance created from the string representation of a 128-bit integer

---

fromString

Creates a UUID from the string standard representation

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

Parameters:

Parameter	Type	Description
$uuid	string	A hexadecimal string

Return Value:

A UuidInterface instance created from a hexadecimal string representation

---

getValidator

Returns the validator to use for the factory

public getValidator(): \Ramsey\Uuid\Validator\ValidatorInterface

---

uuid1

Returns a version 1 (Gregorian time) UUID from a host ID, sequence number, and the current time

public uuid1(\Ramsey\Uuid\Type\Hexadecimal|int|string|null $node = null, int|null $clockSeq = null): \Ramsey\Uuid\UuidInterface

Parameters:

Parameter	Type	Description
$node	\Ramsey\Uuid\Type\Hexadecimal|int|string|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 Value:

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 uuid2(int $localDomain, \Ramsey\Uuid\Type\Integer|null $localIdentifier = null, \Ramsey\Uuid\Type\Hexadecimal|null $node = null, int|null $clockSeq = null): \Ramsey\Uuid\UuidInterface

Parameters:

Parameter	Type	Description
$localDomain	int	The local domain to use when generating bytes, according to DCE Security
$localIdentifier	\Ramsey\Uuid\Type\Integer|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	\Ramsey\Uuid\Type\Hexadecimal|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 Value:

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 uuid3(string|\Ramsey\Uuid\UuidInterface $ns, string $name): \Ramsey\Uuid\UuidInterface

Parameters:

Parameter	Type	Description
$ns	string|\Ramsey\Uuid\UuidInterface	The namespace (must be a valid UUID)
$name	string	The name to use for creating a UUID

Return Value:

A UuidInterface instance that represents a version 3 UUID

---

uuid4

Returns a version 4 (random) UUID

public uuid4(): \Ramsey\Uuid\UuidInterface

Return Value:

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 uuid5(string|\Ramsey\Uuid\UuidInterface $ns, string $name): \Ramsey\Uuid\UuidInterface

Parameters:

Parameter	Type	Description
$ns	string|\Ramsey\Uuid\UuidInterface	The namespace (must be a valid UUID)
$name	string	The name to use for creating a UUID

Return Value:

A UuidInterface instance that represents a version 5 UUID

---

uuid6

Returns a version 6 (reordered time) UUID from a host ID, sequence number, and the current time

public uuid6(\Ramsey\Uuid\Type\Hexadecimal|null $node = null, int|null $clockSeq = null): \Ramsey\Uuid\UuidInterface

Parameters:

Parameter	Type	Description
$node	\Ramsey\Uuid\Type\Hexadecimal|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 Value:

A UuidInterface instance that represents a version 6 UUID

---

---

Automatically generated on 2025-03-18