Skip to content

Upgrading ramsey/uuid 3 to 4

Breaking3.9.7 → 4.9.4Breaking4Platform1Deprecated28New40Changed58Fixed34Other1

Full comparisonBack to ramsey/uuid
BreakingUpgrade verdict

4 breaking changes and a platform requirement change.

In plain terms
  • Remove the following bytes generators and recommend Generator\RandomBytesGenerator as a suitable replacement.
  • Remove Exception\UnsatisfiedDependencyException.
  • Remove the method Provider\TimeProviderInterface::currentTime().
  • Remove currentTime() method from Provider\Time\FixedTimeProvider and Provider\Time\SystemTimeProvider; it had previously been removed from Provider\TimeProviderInterface.
Must act Top 5 of 27 that need code or config changes

ramsey/uuid publishes an official migration guide for version 4. It covers more than the release notes do.

Upgrade guide ↗

PHP requirement changed in 4.3.0: ^5.4 | ^7.0 | ^8.0 → ^8.0.

What you must change

Breaking4
Remove the following bytes generators and recommend Generator\RandomBytesGenerator as a suitable replacement.
Generator\RandomBytesGeneratorGenerator\MtRandGeneratorGenerator\OpenSslGeneratorGenerator\SodiumRandomGenerator
4.0.0GitHub ReleaseOriginalView source
Remove Exception\UnsatisfiedDependencyException.
Exception\UnsatisfiedDependencyException
4.0.0GitHub ReleaseOriginalView source
Remove the method Provider\TimeProviderInterface::currentTime().
Provider\TimeProviderInterface::currentTime()Provider\TimeProviderInterface::getTime()
4.0.0GitHub ReleaseOriginalView source
Remove currentTime() method from Provider\Time\FixedTimeProvider and Provider\Time\SystemTimeProvider; it had previously been removed from Provider\TimeProviderInterface.
currentTime()Provider\Time\FixedTimeProviderProvider\Time\SystemTimeProviderProvider\TimeProviderInterface
4.0.0-beta1GitHub ReleaseOriginalView source
Platform1
Remove support for PHP 7.2, 7.3, and 7.4.
4.3.0GitHub ReleaseOriginalView source

Deprecations to plan for

Deprecated22
Deprecates Ramsey\Uuid\Codec\OrderedTimeCodec, to be removed in 5.0.0; migrate to version 6 UUIDs.
Ramsey\Uuid\Codec\OrderedTimeCodec
4.8.0GitHub ReleaseSummarizedView source
Deprecates Ramsey\Uuid\Codec\TimestampFirstCombCodec, to be removed in 5.0.0; migrate to version 7 UUIDs.
Ramsey\Uuid\Codec\TimestampFirstCombCodec
4.8.0GitHub ReleaseSummarizedView source
Deprecates Ramsey\Uuid\Codec\TimestampLastCombCodec, to be removed in 5.0.0; use Ramsey\Uuid\Codec\StringCodec instead.
Ramsey\Uuid\Codec\TimestampLastCombCodecRamsey\Uuid\Codec\StringCodec
4.8.0GitHub ReleaseSummarizedView source
Deprecates Ramsey\Uuid\Generator\CombGenerator, to be removed in 5.0.0; migrate to version 7 UUIDs.
Ramsey\Uuid\Generator\CombGenerator
4.8.0GitHub ReleaseSummarizedView source
Ramsey\Uuid\Nonstandard\UuidV6 is deprecated in favor of Ramsey\Uuid\Rfc4122\UuidV6.
Ramsey\Uuid\Nonstandard\UuidV6Ramsey\Uuid\Rfc4122\UuidV6
4.5.0GitHub ReleaseOriginalView source
Ramsey\Uuid\Uuid::UUID_TYPE_PEABODY; use Ramsey\Uuid\Uuid::UUID_TYPE_REORDERED_TIME instead.
Ramsey\Uuid\Uuid::UUID_TYPE_PEABODYRamsey\Uuid\Uuid::UUID_TYPE_REORDERED_TIME
4.5.0GitHub ReleaseOriginalView source
Ramsey\Uuid\Generator\RandomLibAdapter.
Ramsey\Uuid\Generator\RandomLibAdapter
4.3.1GitHub ReleaseOriginalView source
Ramsey\Uuid\Builder\BuilderCollection.
Ramsey\Uuid\Builder\BuilderCollection
4.3.0GitHub ReleaseOriginalView source
Ramsey\Uuid\Provider\Node\NodeProviderCollection.
Ramsey\Uuid\Provider\Node\NodeProviderCollection
4.3.0GitHub ReleaseOriginalView source
Dependency on ramsey/collection.
4.3.0GitHub ReleaseOriginalView source
The Uuid::UUID_TYPE_IDENTIFIER constant is deprecated.
Uuid::UUID_TYPE_IDENTIFIERUuid::UUID_TYPE_DCE_SECURITY
4.0.0GitHub ReleaseOriginalView source
The Uuid::VALID_PATTERN constant is deprecated.
Uuid::VALID_PATTERNValidator\GenericValidator::getPattern()Rfc4122\Validator::getPattern()Validator\GenericValidator::VALID_PATTERN
4.0.0GitHub ReleaseOriginalView source
The following methods from UuidInterface and Uuid are deprecated.
UuidInterfaceUuidRfc4122\FieldsInterfaceUuid::getFields()getClockSeqHiAndReservedHex()getClockSeqLowHex()Type\HexadecimalMath\CalculatorInterface::toIntegerValue()Type\IntegergetClockSeqHiAndReserved()getClockSeqLow()
4.0.0GitHub ReleaseOriginalView source
getDateTime() on UuidInterface and Uuid is deprecated.
getDateTime()UuidInterfaceUuidRfc4122\UuidV1Nonstandard\UuidV6
4.0.0GitHub ReleaseOriginalView source
getUrn() on UuidInterface and Uuid is deprecated.
getUrn()UuidInterfaceUuidRfc4122\UuidInterface
4.0.0GitHub ReleaseOriginalView source
The following methods are deprecated and have no direct replacements.
UuidInterface::getHex()UuidInterface::getLeastSignificantBitsHex()UuidInterface::getMostSignificantBitsHex()Uuid::getLeastSignificantBitsHex()Uuid::getMostSignificantBitsHex()Uuid::getLeastSignificantBits()
4.0.0GitHub ReleaseOriginalView source
The classes for representing and generating degraded UUIDs are deprecated.
Builder\DegradedUuidBuilderConverter\Number\DegradedNumberConverterConverter\Time\DegradedTimeConverterDegradedUuid
4.0.0GitHub ReleaseOriginalView source
UuidInterface::getNumberConverter() and Uuid::getNumberConverter() are deprecated.
UuidInterface::getNumberConverter()Uuid::getNumberConverter()
4.0.0GitHub ReleaseOriginalView source
Builder\DefaultUuidBuilder is deprecated; transition to Rfc4122\UuidBuilder.
Builder\DefaultUuidBuilderRfc4122\UuidBuilder
4.0.0GitHub ReleaseOriginalView source
Converter\Number\BigNumberConverter is deprecated; transition to Converter\Number\GenericNumberConverter.
Converter\Number\BigNumberConverterConverter\Number\GenericNumberConverter
4.0.0GitHub ReleaseOriginalView source
Converter\Time\BigNumberTimeConverter is deprecated; transition to Converter\Time\GenericTimeConverter.
Converter\Time\BigNumberTimeConverterConverter\Time\GenericTimeConverter
4.0.0GitHub ReleaseOriginalView source
Provider\TimeProviderInterface::currentTime() is deprecated; transition to the getTimestamp() method on the same interface.
Provider\TimeProviderInterface::currentTime()getTimestamp()
4.0.0-alpha1GitHub ReleaseOriginalView source