README

Create short string IDs from numbers

Description

This library enables you to create a very short string from integer numbers.

The basic usage is:

<?php
$shortid = \ByJG\ShortId\ShortId::fromNumber(81717788171667188198);

// Will write: Qi0yuM2uKwJb

Documentation

• Getting Started
• Methods
• Custom Maps

Installation

composer require "byjg/shortid"

Quick Start

<?php
use ByJG\ShortId\ShortId;

// Create short ID from number
$shortid = ShortId::fromNumber(1234567890);

// Get the number back
$number = ShortId::get($shortid);

// Create from UUID
$shortid = ShortId::fromUuid('092395A6-BC87-11ED-8CA9-0242AC120002');

// Create from hex
$shortid = ShortId::fromHex('3e');

// Generate random short ID
$shortid = ShortId::fromRandom();

Running Tests

composer test

Dependencies

flowchart TD
    byjg/shortid

Open source ByJG