guifelix/ulid

A PHP package to generate Universally Unique Lexicographically Sortable Identifiers

v0.1.0 2022-04-04 00:17 UTC

Requires

• php: ^8.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• infection/infection: ^0.26.6
• pestphp/pest: ^1.20
• pestphp/pest-plugin-parallel: ^1.0
• pestphp/pest-plugin-watch: 1.x-dev
• phpbench/phpbench: ^1.0.0-alpha3
• spatie/pest-plugin-test-time: ^1.0
• spatie/ray: ^1.28

MIT

• Guilherme Maciel

• php
• id
• ulid
• guifelix
• php-ulid

README

PHP Library to use ULID on your application.

• 128-bit compatibility with UUID
• 1.21e+24 unique ULIDs per millisecond
• Lexicographically sortable!
• Canonically encoded as a 26 character string, as opposed to the 36 character UUID
• Uses Crockford's base32 for better efficiency and readability (5 bits per character)
• Case insensitive
• No special characters (URL safe)
• Monotonic sort order (correctly detects and handles the same millisecond)

Installation

You can install the package via composer:

composer require guifelix/php-ulid

Usage

Generate

use Guifelix\Ulid;

$ulid = Ulid::generate(); // Accept boolean as a parameter for lowercase;

echo (string) $ulid; //0001EH8YAEP8CXP4AMWCHHDBHJ
echo $ulid->getTime(); //0001EH8YAE
echo $ulid->getRandomness(); //P8CXP4AMWCHHDBHJ
echo $ulid->isLowercase(); //false
echo $ulid->toTimestamp(); //1561622862

Generate from timestamp

use Guifelix\Ulid;

$ulid = Ulid::fromTimestamp(1561622862); // Accept boolean as a second parameter for lowercase;

echo (string) $ulid; //0001EH8YAEP8CXP4AMWCHHDBHJ

Generate from string (doesn't increment randomness)

use Guifelix\Ulid;

$ulid = Ulid::fromString('0001EH8YAEP8CXP4AMWCHHDBHJ'); // Accept boolean as a second parameter for lowercase;

echo (string) $ulid; //0001EH8YAEP8CXP4AMWCHHDBHJ

Validate

use Guifelix\Ulid;

Ulid::validate('8ZZZZZZZZZP8CXP4AMWCHHDBHI'); // Case insensitve
/**
 * validate Length, Crockford Characters and Time
 * Throws
 *  - InvalidUlidLengthException
 *  - InvalidUlidCharException
 *  - InvalidUlidTimestampException <- Max timestamp is 7ZZZZZZZZZ (281474976710655) or until the year 10889 AD :)
 *  - InvalidUlidException
 * /

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Robin van der Vleuten - I have used most of his code for this package
• Guilherme Maciel
• All Contributors

License

The MIT License (MIT). Please see License File for more information.