New in Symfony 5.3: UID Improvements

The UID Component was introduced in Symfony 5.1 as an experimental feature to
help you generate and work with UIDs (universally unique identifiers) such as
UUIDs and ULIDs. In Symfony 5.3 this component is no longer considered
experimental and we added some new features to it.

New Ways to Generate UIDs

Contributed by
Thomas Calvet
in #39507
and #39850.

Creating UID values is easy thanks to methods like Uuid::v1(), Uuid::v4(),
new Ulid(), etc. In Symfony 5.3 we’ve added new methods so you can create
UID objects from several string representations of UIDs:

1
2
3
4
5
6
7
8
9
$uuid = Uuid::fromBinary(xd9xe7xa1x84x5dx5bx11xeaxa6x2ax34x99x71x00x62xd0);
$uuid = Uuid::fromBase32(‚6SWYGR8QAV27NACAHMK5RG0RPG‘);
$uuid = Uuid::fromBase58(‚TuetYWNHhmuSQ3xPoVLv9M‘);
$uuid = Uuid::fromRfc4122(‚d9e7a184-5d5b-11ea-a62a-3499710062d0‘);

$ulid = Ulid::fromBinary(x01x71x06x9dx59x3dx97xd3x8bx3ex23xd0x6dxe5xb3x08);
$ulid = Ulid::fromBase32(’01E439TP9XJZ9RPFH3T1PYBCR8′);
$ulid = Ulid::fromBase58(‚1BKocMc5BnrVcuq2ti4Eqm‘);
$ulid = Ulid::fromRfc4122(‚0171069d-593d-97d3-8b3e-23d06de5b308‘);

In addition, we’ve added several services such as ulid.factory and uuid.factory
(and their corresponding autowiring aliases UlidFactory, UuidFactory, etc.)
so you can customize the creation of UIDs. The defaults of the generated UIDs
are now configured semantically:

1
2
3
4
# config/packages/framework.yaml
framework:
uid:
default_uuid_version: 4

Finally, we added UlidGenerator and UuidGenerator classes so you can
use them as Doctrine ID generators, to use UIDs as the value of your primary
keys in Doctrine entities.

UID Form Types

Contributed by
Gemorroj
in #39863.

The integration with the Form component was one of the last missing features
of the UIDs. That’s why in Symfony 5.3 we’ve added the UuidType and
UlidType form types so you can work with UID values in your forms.

These form types render a <input type=“text“> field with the string
representation of the given UID object and transform it back to a UID object
when submitting the form.

Serializing UIDs

Contributed by
Thomas Calvet
in #39675.

The Serializer component includes a UidNormalizer to transform objects
of type SymfonyComponentUidAbstractUid into strings. In Symfony 5.3 we’ve
improved it to support different string formats.

You can now pass the UidNormalizer::NORMALIZATION_FORMAT_KEY context option
to the serializer and set it to the desired format (e.g.
UidNormalizer::NORMALIZATION_FORMAT_RFC_4122, etc.)

Generate and Inspect UIDs in the Console

Contributed by
Thomas Calvet
in #39883.

The UID component now includes some console commands to help you generate and
inspect the details of UUID/ULID values.

Read the UID command docs to learn how to enable these commands in your
application before using them:

1
2
3
4
5
6
$ php bin/console uuid:generate –random-based
$ php bin/console ulid:generate –count=2 –format=rfc4122

# run them with the `–help` option to check all their options:
$ php bin/console uuid:generate –help
$ php bin/console ulid:generate –help

1
2
3
4
5
6
7
8
9
10
$ php bin/console ulid:inspect 01F2TTCSYK1PDRH73Z41BN1C4X
——————— ————————————–
Label Value
——————— ————————————–
Canonical (Base 32) 01F2TTCSYK1PDRH73Z41BN1C4X
Base 58 1BYGm16jS4kX3VYCysKKq6
RFC 4122 0178b5a6-67d3-0d9b-889c-7f205750b09d
——————— ————————————–
Timestamp 2021-04-09 08:01:24.947
——————— ————————————–
Sponsor the Symfony project.

Symfony Blog
Read More