Weave Code
Uid Laravel Package
symfony/uid
Symfony UID component offers an object-oriented API to generate and work with unique identifiers. Includes ULIDs and UUIDs (v1 and v3–v8), with implementations compatible with both 32-bit and 64-bit systems for consistent, portable IDs.
Provides an object-oriented API to generate and represent UIDs
Frequently asked questions about Uid
- How do I replace Laravel’s auto-increment IDs with Symfony UID in Eloquent models?
- Use the `$casts` property in your model to specify the UID type. For example, `protected $casts = ['id' => Uuid::class];` for UUIDs or `protected $casts = ['id' => Ulid::class];` for ULIDs. Ensure your database column matches the storage format (e.g., `BINARY(16)` for UUIDs or `CHAR(26)` for ULIDs).
- Does Symfony UID work with Laravel’s API Resources (JsonResource) for JSON responses?
- Yes, Symfony UID integrates natively with Laravel’s API Resources. UUIDs and ULIDs serialize to RFC 4122 or BASE_58 formats by default, which work seamlessly in JSON responses. No additional configuration is needed for standard use cases.
- Can I use ULIDs with older databases like MySQL 5.7 or SQLite?
- ULIDs require PostgreSQL 13+ for optimal performance due to their timestamp-based sorting. For MySQL 5.7 or SQLite, store ULIDs as `CHAR(26)` strings instead of binary, but lose some indexing benefits. UUIDv7 is a better alternative for older databases if you need time-ordered IDs.
- How do I generate deterministic UUIDs for testing in Laravel?
- Use `MockUuidFactory` from Symfony UID to generate predictable UUIDs in tests. Initialize it with a fixed timestamp and randomness seed, then bind it to Laravel’s service container. Example: `$container->bind(MockUuidFactory::class, fn() => new MockUuidFactory('2023-01-01', 'test-randomness'));`
- What’s the performance impact of using BASE_58 or BASE_32 encoded UIDs in Laravel APIs?
- Encoding UIDs (e.g., BASE_58) adds minimal CPU overhead but reduces storage size and improves readability in URLs. Benchmark with `symfony/uid:perf` tools to compare against binary storage. For most Laravel APIs, the trade-off is negligible unless processing millions of IDs per second.
- Does Symfony UID support UUIDv7 for time-sorted IDs in Laravel event sourcing?
- Yes, UUIDv7 provides microsecond precision and sortable timestamps, making it ideal for event sourcing in Laravel. It avoids clock skew issues better than UUIDv1 and integrates with Laravel’s queue systems (e.g., Spatie’s Event Sourcing) without manual indexing.
- How do I migrate from auto-increment IDs to Symfony UID in a production Laravel app?
- Use a dual-write strategy: temporarily store both auto-increment and UID columns, then sync data via Laravel migrations or observers. For APIs, implement a transition layer (e.g., `id` for legacy clients, `uuid` for new ones) before fully switching. Test thoroughly with `RefreshDatabase` in CI.
- Are there alternatives to Symfony UID for Laravel that offer similar functionality?
- Alternatives include `ramsey/uuid` (lightweight, UUID-only) or `spatie/laravel-activitylog` (for event-sourced IDs). However, Symfony UID is the most feature-complete, with built-in ULID support, multi-format storage, and seamless Laravel integration. It’s also first-party with Symfony, ensuring long-term maintenance.
- How do I validate UID inputs in Laravel forms or API requests?
- Use Symfony’s `UidValidator` via Laravel’s validation rules. Example: `'id' => 'required|uuid'` for UUIDs or `'id' => 'required|ulid'` for ULIDs. The validator supports binary, string, and encoded formats out of the box, replacing Laravel’s basic UUID validation.
- Will Symfony UID work with Laravel Sanctum or Passport for tokenized authentication?
- Yes, Symfony UID integrates with Sanctum/Passport by serializing to standard formats (RFC 4122 for UUIDs, BASE_58 for ULIDs). Ensure your `User` model’s `getAuthIdentifier()` returns the UID in the expected format. No additional configuration is required for most use cases.
Weaver
How can I help you explore Laravel packages today?