visus/cuid2

A PHP library for generating collision-resistant ids (CUIDs).

5.0.0 2024-12-09 11:41 UTC

Requires

• php: ^8.1
• ext-gmp: *

Requires (Dev)

• ext-ctype: *
• captainhook/captainhook-phar: ^5.23
• captainhook/hook-installer: ^1.0
• ergebnis/composer-normalize: ^2.29
• phpstan/phpstan: ^1.9
• phpunit/phpunit: ^10.5
• ramsey/conventional-commits: ^1.5
• squizlabs/php_codesniffer: ^3.7
• vimeo/psalm: ^5.4

MIT

• Alan Brault

• identifier
• cuid

README

A PHP implementation of collision-resistant ids. You can read more about CUIDs from the official project website.

Getting Started

You can install visus/cuid2 as a composer package:

Important

The PHP extension GMP is required in order to use this library.

composer require visus/cuid2

Quick Example

<?php
require_once 'vendor/autoload.php';

// new (default length of 24)
$cuid = new Visus\Cuid2\Cuid2();

// implicit casting
echo $cuid; // apr5hhh4ox45krsg9gycbs9k

// explicit casting
echo $cuid->toString(); // apr5hhh4ox45krsg9gycbs9k

// new (with custom length)
$cuid = new Visus\Cuid2\Cuid2(10);
echo $cuid; // pekw02xwsd