1. class
  2. Ramsey
  3. \
  4. Uuid
  5. \
  6. UuidFactory

UuidFactory

class UuidFactory implements UuidFactoryInterface (View source)

Methods

__construct(FeatureSet $features = null)

Constructs a UuidFactory for creating Ramsey\Uuid\UuidInterface instances

CodecInterface
getCodec()

Returns the UUID coder-decoder used by this factory

setCodec(CodecInterface $codec)

Sets the UUID coder-decoder used by this factory

NodeProviderInterface
getNodeProvider()

Returns the system node ID provider used by this factory

RandomGeneratorInterface
getRandomGenerator()

Returns the random UUID generator used by this factory

TimeGeneratorInterface
getTimeGenerator()

Returns the time-based UUID generator used by this factory

setTimeGenerator(TimeGeneratorInterface $generator)

Sets the time-based UUID generator this factory will use to generate version 1 UUIDs

NumberConverterInterface
getNumberConverter()

Returns the number converter used by this factory

setRandomGenerator(RandomGeneratorInterface $generator)

Sets the random UUID generator this factory will use to generate version 4 UUIDs

setNumberConverter(NumberConverterInterface $converter)

Sets the number converter this factory will use

UuidBuilderInterface
getUuidBuilder()

Returns the UUID builder this factory uses when creating Uuid instances

setUuidBuilder(UuidBuilderInterface $builder)

Sets the UUID builder this factory will use when creating Uuid instances

UuidInterface
fromBytes(string $bytes)

Creates a UUID from a byte string.

UuidInterface
fromString(string $uuid)

Creates a UUID from the string standard representation

UuidInterface
fromInteger(mixed $integer)

Creates a Uuid from an integer representation

UuidInterface
uuid1(int|string $node = null, int $clockSeq = null)

Generate a version 1 UUID from a host ID, sequence number, and the current time.

UuidInterface
uuid3(string $ns, string $name)

Generate a version 3 UUID based on the MD5 hash of a namespace identifier (which is a UUID) and a name (which is a string).

UuidInterface
uuid4()

Generate a version 4 (random) UUID.

UuidInterface
uuid5(string $ns, string $name)

Generate a version 5 UUID based on the SHA-1 hash of a namespace identifier (which is a UUID) and a name (which is a string).

UuidInterface
uuid(array $fields)

Returns a Uuid

UuidInterface
uuidFromNsAndName(string|UuidInterface $ns, string $name, int $version, string $hashFunction)

Returns a version 3 or 5 namespaced Uuid

UuidInterface
uuidFromHashedName(string $hash, int $version)

Returns a Uuid created from $hash with the version field set to $version and the variant field set for RFC 4122

Details

at line 61
__construct(FeatureSet $features = null)

Constructs a UuidFactory for creating Ramsey\Uuid\UuidInterface instances

Parameters

FeatureSet $features A set of features for use when creating UUIDs

at line 78
CodecInterface getCodec()

Returns the UUID coder-decoder used by this factory

Return Value

CodecInterface

at line 88
setCodec(CodecInterface $codec)

Sets the UUID coder-decoder used by this factory

Parameters

CodecInterface $codec

at line 98
NodeProviderInterface getNodeProvider()

Returns the system node ID provider used by this factory

Return Value

NodeProviderInterface

at line 108
RandomGeneratorInterface getRandomGenerator()

Returns the random UUID generator used by this factory

Return Value

RandomGeneratorInterface

at line 118
TimeGeneratorInterface getTimeGenerator()

Returns the time-based UUID generator used by this factory

Return Value

TimeGeneratorInterface

at line 128
setTimeGenerator(TimeGeneratorInterface $generator)

Sets the time-based UUID generator this factory will use to generate version 1 UUIDs

Parameters

TimeGeneratorInterface $generator

at line 138
NumberConverterInterface getNumberConverter()

Returns the number converter used by this factory

Return Value

NumberConverterInterface

at line 148
setRandomGenerator(RandomGeneratorInterface $generator)

Sets the random UUID generator this factory will use to generate version 4 UUIDs

Parameters

RandomGeneratorInterface $generator

at line 158
setNumberConverter(NumberConverterInterface $converter)

Sets the number converter this factory will use

Parameters

NumberConverterInterface $converter

at line 168
UuidBuilderInterface getUuidBuilder()

Returns the UUID builder this factory uses when creating Uuid instances

Return Value

UuidBuilderInterface $builder

at line 178
setUuidBuilder(UuidBuilderInterface $builder)

Sets the UUID builder this factory will use when creating Uuid instances

Parameters

UuidBuilderInterface $builder

at line 183
UuidInterface fromBytes(string $bytes)

Creates a UUID from a byte string.

Parameters

string $bytes A 16-byte string representation of a UUID

Return Value

UuidInterface

at line 188
UuidInterface fromString(string $uuid)

Creates a UUID from the string standard representation

Parameters

string $uuid A string representation of a UUID

Return Value

UuidInterface

at line 194
UuidInterface fromInteger(mixed $integer)

Creates a Uuid from an integer representation

The integer representation may be a real integer, a string integer, or an integer representation supported by a configured number converter.

Parameters

mixed $integer The integer to use when creating a Uuid from an integer; may be of any type understood by the configured number converter

Return Value

UuidInterface

at line 202
UuidInterface uuid1(int|string $node = null, int $clockSeq = null)

Generate a version 1 UUID from a host ID, sequence number, and the current time.

Parameters

int|string $node A 48-bit number representing the hardware address This number may be represented as an integer or a hexadecimal string.
int $clockSeq 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

UuidInterface

at line 210
UuidInterface uuid3(string $ns, string $name)

Generate a version 3 UUID based on the MD5 hash of a namespace identifier (which is a UUID) and a name (which is a string).

Parameters

string $ns The UUID namespace in which to create the named UUID
string $name The name to create a UUID for

Return Value

UuidInterface

at line 215
UuidInterface uuid4()

Generate a version 4 (random) UUID.

Return Value

UuidInterface

at line 227
UuidInterface uuid5(string $ns, string $name)

Generate a version 5 UUID based on the SHA-1 hash of a namespace identifier (which is a UUID) and a name (which is a string).

Parameters

string $ns The UUID namespace in which to create the named UUID
string $name The name to create a UUID for

Return Value

UuidInterface

at line 242
UuidInterface uuid(array $fields)

Returns a Uuid

Uses the configured builder and codec and the provided array of hexadecimal value UUID fields to construct a Uuid object.

Parameters

array $fields An array of fields from which to construct a UUID; see {see \Ramsey\Uuid\UuidInterface::getFieldsHex()} for array structure.

Return Value

UuidInterface

at line 257
protected UuidInterface uuidFromNsAndName(string|UuidInterface $ns, string $name, int $version, string $hashFunction)

Returns a version 3 or 5 namespaced Uuid

Parameters

string|UuidInterface $ns The UUID namespace to use
string $name The string to hash together with the namespace
int $version The version of UUID to create (3 or 5)
string $hashFunction The hash function to use when hashing together the namespace and name

Return Value

UuidInterface

at line 276
protected UuidInterface uuidFromHashedName(string $hash, int $version)

Returns a Uuid created from $hash with the version field set to $version and the variant field set for RFC 4122

Parameters

string $hash The hash to use when creating the UUID
int $version The UUID version to set for this hash (1, 3, 4, or 5)

Return Value

UuidInterface